grafana/pyroscope

Provide better example configuration in repo

Open

#3,835 opened on Jan 13, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C (528 forks)batch import
good first issuehelp wantedtype/docs

Repository metrics

Stars
 (9,041 stars)
PR merge metrics
 (Avg merge 3d 5h) (84 merged PRs in 30d)

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.

Contributor guide

Research direction
Generate a commented example configuration from the existing structs in the codebase to replace the current pyroscope.yaml.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75