Skip to content

docs(config): expand example pyroscope.yaml with documented defaults#5106

Closed
alliasgher wants to merge 1 commit into
grafana:mainfrom
alliasgher:feat-better-example-config
Closed

docs(config): expand example pyroscope.yaml with documented defaults#5106
alliasgher wants to merge 1 commit into
grafana:mainfrom
alliasgher:feat-better-example-config

Conversation

@alliasgher
Copy link
Copy Markdown

@alliasgher alliasgher commented May 2, 2026

The cmd/pyroscope/pyroscope.yaml file contained only a single uncommented line. This expands it with the most commonly configured sections (server, storage, target, log level, multi-tenancy, memberlist, limits, self-profiling), with inline comments explaining each option and a link to the full reference documentation.

Fixes #3835


Note

Medium Risk
Although primarily documentation, this file is copied into the Docker image as the default config, so newly explicit settings (notably storage.path and listen addresses/ports) could alter out-of-the-box runtime behavior if they differ from compiled defaults.

Overview
Updates cmd/pyroscope/pyroscope.yaml from a single setting to a fully commented example configuration, linking to the reference docs and describing common knobs.

It now explicitly sets defaults for server (HTTP bind/port and gRPC port) and storage.path, and includes commented-out templates for target, log_level, multitenancy_enabled, memberlist, limits, and self_profiling to guide typical deployments.

Reviewed by Cursor Bugbot for commit 91b775a. Bugbot is set up for automated code reviews on this repo. Configure here.

The existing cmd/pyroscope/pyroscope.yaml contained only a single
uncommented line. Expand it with the most commonly configured options
(server ports, storage path, target, log level, multi-tenancy,
memberlist, limits, self-profiling) with brief inline comments and a
link to the full reference docs.

Fixes grafana#3835

Signed-off-by: alliasgher <alliasgher123@gmail.com>
@alliasgher alliasgher requested a review from a team as a code owner May 2, 2026 10:25
@cla-assistant
Copy link
Copy Markdown

cla-assistant Bot commented May 2, 2026

CLA assistant check
All committers have signed the CLA.

@cla-assistant
Copy link
Copy Markdown

cla-assistant Bot commented May 2, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@simonswine
Copy link
Copy Markdown
Contributor

Thanks @alliasgher I like this idea ❤️

My thinking was this needs to be a bit more automated, wdyt about #5151

@simonswine
Copy link
Copy Markdown
Contributor

I am closing this as #5151 has merged now let me know, if there is anything missing you would like to see

@simonswine simonswine closed this May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide better example configuration in repo

2 participants