grafana/pyroscope

Provide better example configuration in repo

Open

#3.835 geöffnet am 13. Jan. 2025

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C (9.041 Stars) (528 Forks)batch import
good first issuehelp wantedtype/docs

Beschreibung

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.

Contributor Guide

Tech Stack
go
Domain
documentationbackend
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Go knowledgefamiliarity with YAML config
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.