Skip to content

Provide better example configuration in repo #3835

@simonswine

Description

@simonswine

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomershelp wantedtype/docsImprovements for doc docs. Used by Docs team for project management

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions