[chore][headerssetter] Update docs to clarify how to use "from_context" #31283
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
ptodev
referenced
this pull request
Feb 15, 2024
The docs for the `headers_setter` extension state that the `from_context` config option does not work if the batch processor is used. I believe this comment is out of date, because it seems that the [PR](open-telemetry/opentelemetry-collector#7578) linked to the [issue](open-telemetry/opentelemetry-collector#4544) has been merged. Note that I haven't tested that this actually works with the header setter extension. Please let me know if you think testing is necessary. Co-authored-by: Juraci Paixão Kröhling <[email protected]>
jpkrohling
approved these changes
Feb 19, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #31283 +/- ##
==========================================
+ Coverage 82.04% 82.08% +0.04%
==========================================
Files 1855 1862 +7
Lines 171689 172236 +547
==========================================
+ Hits 140856 141380 +524
- Misses 26665 26677 +12
- Partials 4168 4179 +11 ☔ View full report in Codecov by Sentry. |
andrzej-stencel
approved these changes
Feb 19, 2024
XinRanZhAWS
pushed a commit
to XinRanZhAWS/opentelemetry-collector-contrib
that referenced
this pull request
Mar 13, 2024
…n-telemetry#31283) This clarifies potential confusion about how to access metadata using the `from_context` configuration argument. A few months ago I submitted open-telemetry#27465 to remove an obsolete warning, but then a user [asked](open-telemetry@d50e094#commitcomment-131957576) about why their `from_context` isn't working properly with a batch processor. I agree that it's not obvious, so I hope this PR clarifies it enough. I did not try running the update example, so I hope it works :) cc @jpkrohling
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.
This clarifies potential confusion about how to access metadata using the
from_contextconfiguration argument.A few months ago I submitted #27465 to remove an obsolete warning, but then a user asked about why their
from_contextisn't working properly with a batch processor. I agree that it's not obvious, so I hope this PR clarifies it enough.I did not try running the update example, so I hope it works :)
cc @jpkrohling