Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 657
feat: Option to not trace HTTP requests based on status codes#4869
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
bbfb6547cf3d7c7bc4d62ad4e2237eeab46799787082e25d3bcaa51f1423433d62b4383492eea537455274cde81e851dfaed0854784ef52a88c84f49395202ffb1d2d6285feb3f5a5bbFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -30,6 +30,7 @@ | ||
| from typing import Tuple | ||
| from typing import Union | ||
| from typing import TypeVar | ||
| from typing import Set | ||
| from typing_extensions import TypedDict, Unpack | ||
| @@ -970,6 +971,12 @@ def _get_scope_from_finish_args( | ||
| return scope_or_hub | ||
| def _get_log_representation(self): | ||
| # type: () -> str | ||
| return "{op}transaction <{name}>".format( | ||
| op=("<" + self.op + "> " if self.op else ""), name=self.name | ||
| ) | ||
| def finish( | ||
| self, | ||
| scope=None, # type: Optional[sentry_sdk.Scope] | ||
| @@ -1039,6 +1046,32 @@ def finish( | ||
| super().finish(scope, end_timestamp) | ||
| status_code = self._data.get(SPANDATA.HTTP_STATUS_CODE) | ||
| if ( | ||
| status_code is not None | ||
| and status_code in client.options["trace_ignore_status_codes"] | ||
| ): | ||
| logger.debug( | ||
| "[Tracing] Discarding {transaction_description} because the HTTP status code {status_code} is matched by trace_ignore_status_codes: {trace_ignore_status_codes}".format( | ||
| transaction_description=self._get_log_representation(), | ||
| status_code=self._data[SPANDATA.HTTP_STATUS_CODE], | ||
| trace_ignore_status_codes=client.options[ | ||
| "trace_ignore_status_codes" | ||
| ], | ||
| ) | ||
| ) | ||
| if client.transport: | ||
| client.transport.record_lost_event( | ||
| "event_processor", data_category="transaction" | ||
| ) | ||
| num_spans = len(self._span_recorder.spans) + 1 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bug: Span Recorder Limit Causes Inaccurate Lost Span CountWhen a transaction is discarded because its HTTP status code is ignored, the ContributorAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. They were not previously recorded by I believe the data in | ||
| client.transport.record_lost_event( | ||
| "event_processor", data_category="span", quantity=num_spans | ||
| ) | ||
| self.sampled = False | ||
alexander-alderman-webb marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
alexander-alderman-webb marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. alexander-alderman-webb marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| if not self.sampled: | ||
| # At this point a `sampled = None` should have already been resolved | ||
| # to a concrete decision. | ||
| @@ -1186,9 +1219,7 @@ def _set_initial_sampling_decision(self, sampling_context): | ||
| """ | ||
| client = sentry_sdk.get_client() | ||
| transaction_description = "{op}transaction <{name}>".format( | ||
| op=("<" + self.op + "> " if self.op else ""), name=self.name | ||
| ) | ||
| transaction_description = self._get_log_representation() | ||
| # nothing to do if tracing is disabled | ||
| if not has_tracing_enabled(client.options): | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| import sentry_sdk | ||
| from sentry_sdk import start_transaction, start_span | ||
| import pytest | ||
| from collections import Counter | ||
| def test_no_ignored_codes(sentry_init, capture_events): | ||
| sentry_init( | ||
| traces_sample_rate=1.0, | ||
| ) | ||
| events = capture_events() | ||
| with start_transaction(op="http", name="GET /"): | ||
| span_or_tx = sentry_sdk.get_current_span() | ||
| span_or_tx.set_data("http.response.status_code", 404) | ||
| assert len(events) == 1 | ||
| @pytest.mark.parametrize("status_code", [200, 404]) | ||
| def test_single_code_ignored(sentry_init, capture_events, status_code): | ||
| sentry_init( | ||
| traces_sample_rate=1.0, | ||
| trace_ignore_status_codes={ | ||
| 404, | ||
| }, | ||
| ) | ||
| events = capture_events() | ||
| with start_transaction(op="http", name="GET /"): | ||
| span_or_tx = sentry_sdk.get_current_span() | ||
| span_or_tx.set_data("http.response.status_code", status_code) | ||
| if status_code == 404: | ||
| assert not events | ||
| else: | ||
| assert len(events) == 1 | ||
| @pytest.mark.parametrize("status_code", [200, 305, 307, 399, 404]) | ||
| def test_range_ignored(sentry_init, capture_events, status_code): | ||
| sentry_init( | ||
| traces_sample_rate=1.0, | ||
| trace_ignore_status_codes=set( | ||
| range( | ||
| 305, | ||
| 400, | ||
| ), | ||
| ), | ||
| ) | ||
| events = capture_events() | ||
| with start_transaction(op="http", name="GET /"): | ||
| span_or_tx = sentry_sdk.get_current_span() | ||
| span_or_tx.set_data("http.response.status_code", status_code) | ||
| if 305 <= status_code <= 399: | ||
| assert not events | ||
| else: | ||
| assert len(events) == 1 | ||
| @pytest.mark.parametrize("status_code", [200, 301, 303, 355, 404]) | ||
| def test_variety_ignored(sentry_init, capture_events, status_code): | ||
| sentry_init( | ||
| traces_sample_rate=1.0, | ||
| trace_ignore_status_codes={ | ||
| 301, | ||
| 302, | ||
| 303, | ||
| *range( | ||
| 305, | ||
| 400, | ||
| ), | ||
| *range( | ||
| 401, | ||
| 405, | ||
| ), | ||
| }, | ||
| ) | ||
| events = capture_events() | ||
| with start_transaction(op="http", name="GET /"): | ||
| span_or_tx = sentry_sdk.get_current_span() | ||
| span_or_tx.set_data("http.response.status_code", status_code) | ||
| if ( | ||
| 301 <= status_code <= 303 | ||
| or 305 <= status_code <= 399 | ||
| or 401 <= status_code <= 404 | ||
| ): | ||
| assert not events | ||
| else: | ||
| assert len(events) == 1 | ||
| def test_transaction_not_ignored_when_status_code_has_invalid_type( | ||
| sentry_init, capture_events | ||
| ): | ||
| sentry_init( | ||
| traces_sample_rate=1.0, | ||
| trace_ignore_status_codes=set( | ||
| range(401, 404), | ||
| ), | ||
| ) | ||
| events = capture_events() | ||
| with start_transaction(op="http", name="GET /"): | ||
| span_or_tx = sentry_sdk.get_current_span() | ||
| span_or_tx.set_data("http.response.status_code", "404") | ||
| assert len(events) == 1 | ||
| def test_records_lost_events(sentry_init, capture_record_lost_event_calls): | ||
| sentry_init( | ||
| traces_sample_rate=1.0, | ||
| trace_ignore_status_codes={ | ||
| 404, | ||
| }, | ||
| ) | ||
| record_lost_event_calls = capture_record_lost_event_calls() | ||
| with start_transaction(op="http", name="GET /"): | ||
| span_or_tx = sentry_sdk.get_current_span() | ||
| span_or_tx.set_data("http.response.status_code", 404) | ||
| with start_span(op="child-span"): | ||
| with start_span(op="child-child-span"): | ||
| pass | ||
| assert Counter(record_lost_event_calls) == Counter( | ||
| [ | ||
| ("event_processor", "transaction", None, 1), | ||
| ("event_processor", "span", None, 3), | ||
| ] | ||
| ) |
Uh oh!
There was an error while loading. Please reload this page.