Add explanation of double colons to Collector config page #4524
Conversation
This file contains 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
tiffany76
requested review from
a team and
jpkrohling
and removed request for
a team
mx-psi
reviewed
May 23, 2024
Comment on lines
+43
to
+46
| When referring to nested keys in YAML paths, make sure to use double colons (::) | ||
| to avoid confusion with namespaces that contain dots. For example: | ||
| `receivers::docker_stats::metrics::container.cpu.utilization::enabled: false`. | ||
|
|
There was a problem hiding this comment.
Do we want this as advice to the user or as an explanation of what we are doing? (Genuine question)
There was a problem hiding this comment.
I like the "tip" approach but I would also be OK with making it more of an explanation. I have no strong preference to be honest.
mx-psi
approved these changes
May 23, 2024
svrnm
approved these changes
May 23, 2024
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.
Fixes #4484.
This PR adds an explanation for the use of double colons to refer to nested keys in YAML config paths.
Preview: https://deploy-preview-4524--opentelemetry.netlify.app/docs/collector/configuration/#location