grafana/pyroscope

Provide better example configuration in repo

Open

#3 835 ouverte le 13 janv. 2025

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)C (9 041 stars) (528 forks)batch import
good first issuehelp wantedtype/docs

Description

I think we should provide a better example config file in ./cmd/pyroscope/pyroscope.yaml.

The configuration page in our docs seem to be tricky to understand, as they use a "reference name" for certain sections, which often is confused by users. (example 1, example 2)

All the options should be commented out, ideally generated from the existing structs.

Guide contributeur

Stack technique
go
Domaine
documentationbackend
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-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Go knowledgefamiliarity with YAML config
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
Look at the existing example config in ./cmd/pyroscope/pyroscope.yaml and the struct definitions in Go source code that generate the configuration reference. Determine how to auto generate commented out options from the structs, ensuring all options are present with clear comments. Check related issues (e.g., #3790) and Slack discussion for user confusion. Review maintainer comments in this issue for expected output format.