grafana/loki

Docs: Operations > Loki in Grafana has very limited information

Open

#8.908 aberto em 27 de mar. de 2023

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Go (3.997 forks)batch import
help wantedtype/docs

Métricas do repositório

Stars
 (28.187 stars)
Métricas de merge de PR
 (Mesclagem média 7d 10h) (312 fundiu PRs em 30d)

Description

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.

Guia do colaborador