grafana/pyroscope

Provide better example configuration in repo

Open

#3,835 opened on 2025年1月13日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)C (9,041 stars) (528 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.