[chore] Add note to GroupbyTraceprocessor when working with tailsampling #26997
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
jmsnll
pushed a commit
to jmsnll/opentelemetry-collector-contrib
that referenced
this pull request
Nov 12, 2023
…ing (open-telemetry#26997) **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.--> I'm proposing a small note in both tailsamplingprocessor and groupbytrace processor. In order to perform a tail-based sampling, spans need to be grouped by `trace_id`. We have a groupbytrace processor with README describes: > This processor should be used whenever a processor requires grouped traces to make decisions, such as a tail-based sampler or ... The description is correct since it said "(a customized) tail-based sampler", not the `tailsamplingprocessor` in this repo. But some people are still misdirected and think it's necessary to setup groupby processor before tailsampling processor. **Link to tracking Issue:** <Issue number if applicable> N/A **Testing:** <Describe what testing was performed and which tests were added.> N/A **Documentation:** <Describe the documentation added.> The PR only change the README of both groupbytrace processor and tailsampling processor.
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:
I'm proposing a small note in both tailsamplingprocessor and groupbytrace processor.
In order to perform a tail-based sampling, spans need to be grouped by
trace_id.We have a groupbytrace processor with README describes:
The description is correct since it said "(a customized) tail-based sampler", not the
tailsamplingprocessorin this repo. But some people are still misdirected and think it's necessary to setup groupby processor before tailsampling processor.Link to tracking Issue:
N/A
Testing:
N/A
Documentation:
The PR only change the README of both groupbytrace processor and tailsampling processor.