grafana/pyroscope

Provide better example configuration in repo

Open

#3,835 创建于 2025年1月13日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)C (9,041 star) (528 fork)batch import
good first issuehelp wantedtype/docs

描述

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.

贡献者指南

技术栈
go
领域
documentationbackend
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Go knowledgefamiliarity with YAML config
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.
Provide better example configuration in repo · grafana/pyroscope#3835 | Good First Issue