Skip to content

Commit

Permalink
Clarified use cases in readme
Browse files Browse the repository at this point in the history
Signed-off-by: Juraci Paixão Kröhling <juraci@kroehling.de>
  • Loading branch information
jpkrohling committed Jul 22, 2020
1 parent 9fb3c8c commit 18f6be3
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions processor/groupbytraceprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ This processor collects all the spans from the same trace, waiting a
pre-determined amount of time before releasing the trace to the next processor.
The expectation is that, generally, traces will be complete after the given time.

This processor should be used whenever a processor requires grouped traces to make decisions,
such as a tail-based sampler or a per-trace metrics processor.

The batch processor shouldn't be used before this processor, as this one will
probably undo part (or much) of the work that the batch processor performs. It's
fine to have the batch processor to run right after this one, and every entry in the
Expand Down

0 comments on commit 18f6be3

Please sign in to comment.