grafana/pyroscope

Provide better example configuration in repo

Open

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

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

仓库指标

Star
 (9,041 star)
PR 合并指标
 (平均合并 5天 7小时) (30 天内合并 62 个 PR)

描述

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.

贡献者指南

研究方向
查看 ./cmd/pyroscope/pyroscope.yaml 中的现有示例配置以及生成配置参考的 Go 源代码中的结构体定义。确定如何从结构体自动生成带注释的选项，确保所有选项都清晰注释。检查相关议题（例如 #3790）和 Slack 讨论中用户的困惑。查看此议题中维护者对预期输出格式的评论。
技术栈
go
领域
backend
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Go
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75