grafana/pyroscope

Provide better example configuration in repo

Open

Aperta il 13 gen 2025

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)C (9041 star) (528 fork)batch import
good first issuehelp wantedtype/docs

Descrizione

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.

Guida contributor

Tech stack
go
Dominio
backend
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75
Direzione di ricerca
Esamina la configurazione di esempio esistente in ./cmd/pyroscope/pyroscope.yaml e le definizioni delle struct nel codice sorgente Go che generano il riferimento di configurazione. Determina come generare automaticamente le opzioni commentate dalle struct, assicurandoti che tutte le opzioni siano presenti con commenti chiari. Controlla le issue correlate (ad es. #3790) e la discussione su Slack per la confusione degli utenti. Rivedi i commenti dei maintainer in questa issue per il formato di output previsto.