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.