pyroscope icon indicating copy to clipboard operation
pyroscope copied to clipboard

Provide better example configuration in repo

Open simonswine opened this issue 11 months ago • 1 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.

simonswine avatar Jan 13 '25 11:01 simonswine

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

marcsanmi avatar Jan 13 '25 12:01 marcsanmi