grafana/loki

Docs: Operations > Loki in Grafana has very limited information

Open

#8,908 创建于 2023年3月27日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Go (3,997 fork)batch import
help wantedtype/docs

仓库指标

Star
 (28,187 star)
PR 合并指标
 (平均合并 7天 10小时) (30 天内合并 312 个 PR)

描述

Describe the bug When researching the getting started experience with Grafana and Loki, we found that it's not easy to find documentation or links pointing out to how to set up Loki as a data source in Grafana. Currently, the Loki docs have a Loki in Grafana section inside Operations, that compared with Loki data source offers very limited information.

It would be positive to point that section to Loki data source, or at least include a link to it in case the user needs more in-depth information about setting up the data source.

Other nice to haves:

  • Consider if Operations appropriately categorizes this documentation topic. During the research it was unexpected to find the data source configuration under this category.
  • Consider if it can be possible to arrive to this documentation page without being familiar with the "data source" concept, for example, by searching for "grafana loki setup".
  • The docs are missing details for error or success state, how does a successfully configured data source look like.
  • The “Loki in Grafana” page refers to the configuration icon as the “cog” icon, while “Loki data source” calls it “gear” icon.
  • The “Loki data source” page is missing a paragraph explaining the user, once they configured the data source, how to execute their first query.

To Reproduce See Get Started Overhaul: Loki.

贡献者指南