Skip to content

Commit

Permalink
Fix confusion in the SpanFilter docstring (#3851)
Browse files Browse the repository at this point in the history
The docstring was claiming that a truthy value from the filter block
keeps the span, but in fact it's the other way around, a truthy value
drops the span.
  • Loading branch information
sulami authored Aug 21, 2024
1 parent 7b22f21 commit 3da4cfd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/datadog/tracing/pipeline/span_filter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ module Pipeline
# This processor executes the configured `operation` for each {Datadog::Tracing::Span}
# in a {Datadog::Tracing::TraceSegment}.
#
# If `operation` returns a truthy value for a span, that span is kept,
# otherwise the span is removed from the trace.
# If `operation` returns a truthy value for a span, that span is dropped,
# otherwise the span is kept.
#
# @public_api
class SpanFilter < SpanProcessor
Expand Down

0 comments on commit 3da4cfd

Please sign in to comment.