feat(overrides): Add separator line in WriteStatusRuntimeConfig method
#5371
Conversation
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
iamrajiv
requested review from
carles-grafana,
electron0zero,
ie-pham,
javiermolinar,
joe-elliott,
mapno,
mdisibio,
stoewer,
yvrhdn and
zalegrala
as code owners
There was a problem hiding this comment.
It looks good. Could you add a test or reuse an existing one to assert that the output YAML can be unmarshalled back? This is what tempo-cli does:
https://github.com/grafana/tempo/blob/main/cmd/tempo-cli/cmd-migrate-overrides-config.go#L52-L62
Please add a changelog entry too
Thank you!
|
sure thanks for review @javiermolinar i added it can u review again? |
javiermolinar
approved these changes
Jul 10, 2025
knylander-grafana
pushed a commit
to knylander-grafana/tempo-doc-work
that referenced
this pull request
Jul 18, 2025
…hod (grafana#5371) * add separator line in WriteStatusRuntimeConfig method * fix(tests): Ensure YAML output from runtime config can be unmarshalled correctly
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What this PR does:
Adds the missing YAML document separator
---\nto the/status/runtime_configendpoint output. This fixes invalid YAML that was causing validation failures with tools likeyq.Which issue(s) this PR fixes:
Fixes #5146
Checklist
CHANGELOG.mdupdated - the order of entries shouldbe
[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]:Notes:
verify the YAML output now includes the separator
doesn't change user-facing functionality
section if there is one, something like:
/status/runtime_config endpoint by adding document
separator. Yaml in api /runtime-config is not valid #5146