docs(config): expand example pyroscope.yaml with documented defaults#5106
Closed
alliasgher wants to merge 1 commit into
Closed
docs(config): expand example pyroscope.yaml with documented defaults#5106alliasgher wants to merge 1 commit into
alliasgher wants to merge 1 commit into
Conversation
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>
|
|
3 tasks
Contributor
|
Thanks @alliasgher I like this idea ❤️ My thinking was this needs to be a bit more automated, wdyt about #5151 |
Contributor
|
I am closing this as #5151 has merged now let me know, if there is anything missing you would like to see |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
cmd/pyroscope/pyroscope.yamlfile 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.pathand listen addresses/ports) could alter out-of-the-box runtime behavior if they differ from compiled defaults.Overview
Updates
cmd/pyroscope/pyroscope.yamlfrom 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) andstorage.path, and includes commented-out templates fortarget,log_level,multitenancy_enabled,memberlist,limits, andself_profilingto guide typical deployments.Reviewed by Cursor Bugbot for commit 91b775a. Bugbot is set up for automated code reviews on this repo. Configure here.