fix(tracing): Fix unsampled/deferred trace propagation in span streaming #6757
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -501,16 +501,16 @@ def _dynamic_sampling_context(self) -> "dict[str, str]": | |
| return self._segment._get_baggage().dynamic_sampling_context() | ||
|
|
||
| def _to_traceparent(self) -> str: | ||
| if self._segment.sampled is True: | ||
| sampled = "1" | ||
| elif self._segment.sampled is False: | ||
| sampled = "0" | ||
| else: | ||
| sampled = None | ||
|
|
||
| traceparent = f"{self.trace_id}-{self.span_id}" | ||
| if sampled is not None: | ||
| traceparent += f"-{sampled}" | ||
|
|
||
| return traceparent | ||
|
|
||
|
|
@@ -610,15 +610,39 @@ def _to_json(self) -> "SpanJSON": | |
|
|
||
| class NoOpStreamedSpan(StreamedSpan): | ||
| __slots__ = ( | ||
| "_trace_id", | ||
| "_span_id", | ||
| "_sampled", | ||
| "_segment", | ||
|
Comment on lines
+613
to
+616
Member
There was a problem hiding this comment. Of these, only As an example: >>> class Foo():
... __slots__ = ("x")
...
>>> class Bar(Foo):
... __slots__ = ("y")
...
>>> b = Bar()
>>> b.x = "hi"
>>> b.y = "world"
>>> print(b.x)
hi
>>> b.z
Traceback (most recent call last):
File "<python-input-7>", line 1, in <module>
b.z
AttributeError: 'Bar' object has no attribute 'z'One thing to be wary of that I found when looking into the slots docs - duplicating the variable name in |
||
| "_finished", | ||
| "_unsampled_reason", | ||
| ) | ||
|
|
||
| def __init__( | ||
| self, | ||
| segment: "Optional[StreamedSpan]" = None, | ||
| trace_id: "Optional[str]" = None, | ||
| parent_span_id: "Optional[str]" = None, | ||
| parent_sampled: "Optional[bool]" = None, | ||
| baggage: "Optional[Baggage]" = None, | ||
| sampled: "Optional[bool]" = False, | ||
|
sentry-warden[bot] marked this conversation as resolved.
|
||
| unsampled_reason: "Optional[str]" = None, | ||
| scope: "Optional[sentry_sdk.Scope]" = None, | ||
| sample_rand: "Optional[float]" = None, | ||
| sample_rate: "Optional[float]" = None, | ||
| ) -> None: | ||
| self._span_id: "Optional[str]" = None | ||
|
|
||
| self._sampled = sampled | ||
| self._segment = segment or self | ||
|
|
||
| self._trace_id: "Optional[str]" = trace_id | ||
| self._parent_span_id = parent_span_id | ||
| self._parent_sampled = parent_sampled | ||
| self._baggage = baggage | ||
| self._sample_rand = sample_rand | ||
| self._sample_rate = sample_rate | ||
|
|
||
| self._scope = scope # type: ignore[assignment] | ||
| self._unsampled_reason = unsampled_reason | ||
|
|
||
|
|
@@ -693,9 +717,6 @@ def set_attributes(self, attributes: "Attributes") -> None: | |
| def remove_attribute(self, key: str) -> None: | ||
| pass | ||
|
|
||
| @property | ||
| def status(self) -> "str": | ||
| return SpanStatus.OK.value | ||
|
|
@@ -716,17 +737,9 @@ def name(self, value: str) -> None: | |
| def active(self) -> bool: | ||
| return True | ||
|
|
||
| @property | ||
| def sampled(self) -> "Optional[bool]": | ||
| return self._sampled | ||
|
|
||
| @property | ||
| def start_timestamp(self) -> "Optional[datetime]": | ||
|
|
@@ -736,6 +749,14 @@ def start_timestamp(self) -> "Optional[datetime]": | |
| def end_timestamp(self) -> "Optional[datetime]": | ||
| return None | ||
|
|
||
| def _get_trace_context(self) -> "dict[str, Any]": | ||
| return { | ||
| "trace_id": self.trace_id, | ||
| "span_id": self.span_id, | ||
| "parent_span_id": self._parent_span_id, | ||
| "dynamic_sampling_context": self._dynamic_sampling_context(), | ||
| } | ||
|
sentrivana marked this conversation as resolved.
|
||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
|
|
||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -664,7 +664,7 @@ def _fill_sample_rand(self) -> None: | |
|
|
||
| # Get the sample rate and compute the transformation that will map the random value | ||
| # to the desired range: [0, 1), [0, sample_rate), or [sample_rate, 1). | ||
| sample_rate = self._sample_rate() | ||
| lower, upper = _sample_rand_range(self.parent_sampled, sample_rate) | ||
|
|
||
| try: | ||
|
|
@@ -689,6 +689,13 @@ def _sample_rand(self) -> "Optional[str]": | |
|
|
||
| return self.baggage.sentry_items.get("sample_rand") | ||
|
|
||
| def _sample_rate(self) -> "Optional[float]": | ||
| """Convenience method to get the sample_rate value from the baggage.""" | ||
| if self.baggage is None: | ||
| return None | ||
|
|
||
| return try_convert(float, self.baggage.sentry_items.get("sample_rate")) | ||
|
|
||
|
|
||
| class Baggage: | ||
| """ | ||
|
|
@@ -857,7 +864,8 @@ def populate_from_segment(cls, segment: "StreamedSpan") -> "Baggage": | |
| options = client.options or {} | ||
|
|
||
| sentry_items["trace_id"] = segment.trace_id | ||
| if segment._sample_rand is not None: | ||
| sentry_items["sample_rand"] = f"{segment._sample_rand:.6f}" | ||
|
|
||
| if options.get("environment"): | ||
| sentry_items["environment"] = options["environment"] | ||
|
|
@@ -873,8 +881,8 @@ def populate_from_segment(cls, segment: "StreamedSpan") -> "Baggage": | |
| if ( | ||
| segment.get_attributes().get("sentry.span.source") | ||
| not in LOW_QUALITY_SEGMENT_SOURCES | ||
| ) and segment.name: | ||
| sentry_items["transaction"] = segment.name | ||
|
|
||
| if segment._sample_rate is not None: | ||
| sentry_items["sample_rate"] = str(segment._sample_rate) | ||
|
|
@@ -1530,23 +1538,23 @@ def _make_sampling_decision( | |
| name: str, | ||
| attributes: "Optional[Attributes]", | ||
| scope: "sentry_sdk.Scope", | ||
| ) -> "tuple[Optional[bool], Optional[float], Optional[float], Optional[str]]": | ||
| """ | ||
| Decide whether a span should be sampled. | ||
|
|
||
| Returns a tuple with: | ||
| 1. the sampling decision (sampled, unsampled, deferred) | ||
| 2. the effective sample rate | ||
| 3. the sample rand | ||
| 4. the reason for not sampling the span, if unsampled | ||
| """ | ||
| client = sentry_sdk.get_client() | ||
|
|
||
| propagation_context = scope.get_active_propagation_context() | ||
|
|
||
| if not has_tracing_enabled(client.options): | ||
| return propagation_context.parent_sampled, None, None, None | ||
|
sentry-warden[bot] marked this conversation as resolved.
|
||
|
|
||
| sample_rand = None | ||
| if propagation_context.baggage is not None: | ||
| sample_rand = propagation_context.baggage._sample_rand() | ||
|
|
@@ -1572,7 +1580,10 @@ def _make_sampling_decision( | |
| sample_rate = client.options["traces_sampler"](sampling_context) | ||
| else: | ||
| if propagation_context.parent_sampled is not None: | ||
| if propagation_context._sample_rate() is not None: | ||
| sample_rate = propagation_context._sample_rate() | ||
| else: | ||
| sample_rate = propagation_context.parent_sampled | ||
| else: | ||
| sample_rate = client.options["traces_sample_rate"] | ||
|
|
||
|
|
@@ -1582,15 +1593,15 @@ def _make_sampling_decision( | |
| logger.warning(f"[Tracing] Discarding {name} because of invalid sample rate.") | ||
| return False, None, None, "sample_rate" | ||
|
|
||
| sample_rate = float(sample_rate) # type: ignore[arg-type] | ||
| if not sample_rate: | ||
| if traces_sampler_defined: | ||
| reason = "traces_sampler returned 0 or False" | ||
| else: | ||
| reason = "traces_sample_rate is set to 0" | ||
|
|
||
| logger.debug(f"[Tracing] Discarding {name} because {reason}") | ||
| return False, 0.0, sample_rand, "sample_rate" | ||
|
|
||
| # Adjust sample rate if we're under backpressure | ||
| sample_rate_before_backpressure = sample_rate | ||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -282,9 +282,14 @@ def getresponse(self, *args, **kwargs): | |
| headers = { | ||
| "sentry-trace": "771a43a4192642f0b136d5159a501700-1234567890abcdef-1", | ||
| "baggage": ( | ||
| "other-vendor-value-1=foo;bar;baz," | ||
| "sentry-trace_id=771a43a4192642f0b136d5159a501700," | ||
| "sentry-public_key=49d0f7386ad645858ae85020e393bef3," | ||
| "sentry-sample_rate=0.01337," | ||
| "sentry-user_id=Am%C3%A9lie," | ||
| "sentry-sample_rand=0.000005," | ||
| "sentry-sampled=true," | ||
| "other-vendor-value-2=foo;bar;" | ||
| ), | ||
| } | ||
|
|
||
|
|
@@ -309,6 +314,15 @@ def getresponse(self, *args, **kwargs): | |
| parent_span_id=request_span["span_id"], | ||
| sampled=1, | ||
| ) | ||
|
|
||
| expected_outgoing_baggage = ( | ||
| "sentry-trace_id=771a43a4192642f0b136d5159a501700," | ||
| "sentry-public_key=49d0f7386ad645858ae85020e393bef3," | ||
| "sentry-sample_rate=0.01337," | ||
| "sentry-user_id=Am%C3%A9lie," | ||
| "sentry-sample_rand=0.000005," | ||
| "sentry-sampled=true" | ||
| ) | ||
| else: | ||
| events = capture_events() | ||
| transaction = continue_trace(headers) | ||
|
|
@@ -331,16 +345,18 @@ def getresponse(self, *args, **kwargs): | |
| sampled=1, | ||
| ) | ||
|
|
||
| # Note: the sample rate here is actually wrong. It's fixed in the | ||
| # streaming path | ||
| expected_outgoing_baggage = ( | ||
| "sentry-trace_id=771a43a4192642f0b136d5159a501700," | ||
| "sentry-public_key=49d0f7386ad645858ae85020e393bef3," | ||
| "sentry-sample_rate=1.0," | ||
| "sentry-user_id=Am%C3%A9lie," | ||
| "sentry-sample_rand=0.000005," | ||
| "sentry-sampled=true" | ||
| ) | ||
|
|
||
| assert request_headers["sentry-trace"] == expected_sentry_trace | ||
| assert request_headers["baggage"] == expected_outgoing_baggage | ||
|
|
||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.