telemetrygen: Fix cmd docs examples #31254
Merged
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
1. Update example to use --otlp-header instead of -otlp-header 2. Align examples to be more consistent with quoting
mx-psi
reviewed
Feb 14, 2024
| "Flag may be repeated to set multiple headers (e.g -otlp-header key1=value1 -otlp-header key2=value2)") | ||
| fs.Var(&c.Headers, "otlp-header", "Custom header to be passed along with each OTLP request. The value is expected in the format key=\"value\". "+ | ||
| "Note you may need to escape the quotes when using the tool from a cli. "+ | ||
| "Flag may be repeated to set multiple headers (e.g --otlp-header \"key1=\\\"value1\\\"\" --otlp-header \"key2=\\\"value2\\\"\")") |
There was a problem hiding this comment.
Maybe we can use backtick strings here? That way we can avoid the double escaping
There was a problem hiding this comment.
Updated the PR
- Further simplified the example by removing starting and trailing quotes, from
--otlp-header \"key1=\\\"value1\\\"\"to--otlp-header key1=\\\"value1\\\" - Use backtick strings so that it becomes
--otlp-header key1=\"value1\"
mx-psi
approved these changes
Feb 14, 2024
|
I don't have the permissions to change labels, but a skip changelog label seems appropriate. |
codeboten
approved these changes
Feb 14, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
XinRanZhAWS
pushed a commit
to XinRanZhAWS/opentelemetry-collector-contrib
that referenced
this pull request
Mar 13, 2024
**Description:** <Describe what has changed.> <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> No functional change. Update cmd docs. 1. Update example to use --otlp-header instead of -otlp-header 2. Align examples to be more consistent with quoting **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> **Documentation:** <Describe the documentation added.>
6 tasks
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.
Description:
No functional change. Update cmd docs.
Link to tracking Issue:
Testing:
Documentation: