grafana/loki

Docs feedback: /docs/sources/configuration/_index.md - Loki docs need a new page about runtime config file(s)

Open

#10 391 ouverte le 29 août 2023

Voir sur GitHub
 (0 commentaires) (1 réaction) (1 assigné)Go (28 187 stars) (3 997 forks)batch import
help wantedtype/docs

Description

The Loki docs lack a page to explain the concept of a "runtime config file", similar to this doc page for Mimir: https://grafana.com/docs/mimir/latest/configure/about-runtime-configuration

I believe the same concept exists for Loki, because I see this: https://grafana.com/docs/loki/latest/configuration/#runtime_config

But we need much more detail in the docs, like:

  • explain the concept of a runtime config file
  • how to use it
  • and importantly: what can (and can't) be configured in the runtime config file(s)

It probably needs its own separate doc page, as in the Mimir docs.

I expect we would need to get someone from Loki Engineering to write the bulk of this doc page, in order to get all the correct details.

Thanks!!

Guide contributeur

Stack technique
go
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
needs maintainer response
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic understanding of Lokifamiliarity with configuration files
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
Review the existing Mimir runtime configuration documentation at https://grafana.com/docs/mimir/latest/configure/about runtime configuration for structure and content. Also examine the current Loki configuration page at https://grafana.com/docs/loki/latest/configuration/#runtime config to understand the existing references. Consult with Loki engineering team members to gather accurate details about what can and cannot be configured in runtime config files, as the bulk of the technical content will come from them.