grafana / pyroscope

Continuous Profiling Platform. Debug performance issues down to a single line of code

Home Page:https://grafana.com/oss/pyroscope/

Repository from Github https://github.comgrafana/pyroscopeRepository from Github https://github.comgrafana/pyroscope

Provide better example configuration in repo

simonswine opened this issue · comments

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.

We should check other products when updating the documentation, as they use a similar structure (e.g. Loki's configuration)