Skip to content

[DO NOT MERGE] feat(tracing): Warn when traces_sample_rate is 0 #8269

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.

Sign up for GitHub

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

Closed
wedamija wants to merge 1 commit into from
Closed

[DO NOT MERGE] feat(tracing): Warn when traces_sample_rate is 0 #8269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions sentry_sdk/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,18 @@ def _get_options(*args: "Optional[str]", **kwargs: "Any") -> "Dict[str, Any]":
stacklevel=2,
)

# The SDK logger only writes when debug is on, and this has to reach people who
# never turn it on.
if rv["traces_sample_rate"] == 0 and rv["traces_sampler"] is None:
warnings.warn(
"traces_sample_rate is 0, so this service starts no traces and Sentry "
"gets no performance data from it. To send traces, set traces_sample_rate "
"above 0, for example 1.0 in development and 0.1 in production. If 0 is "
"what you want (for example, to only continue traces sampled upstream), "
"you can hide this warning with warnings.filterwarnings.",
stacklevel=2,
)

if rv["trace_ignore_status_codes"] and has_span_streaming_enabled(rv):
warnings.warn(
"The `trace_ignore_status_codes` parameter is ignored in span streaming mode.",
Expand Down
23 changes: 23 additions & 0 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1507,6 +1507,29 @@ def test_continuous_profiling_does_not_warn(sentry_init):
assert profiling_warnings == []


@pytest.mark.parametrize("traces_sample_rate", [0, 0.0])
def test_zero_traces_sample_rate_warns(sentry_init, traces_sample_rate):
with pytest.warns(UserWarning, match="traces_sample_rate is 0"):
sentry_init(traces_sample_rate=traces_sample_rate)


@pytest.mark.parametrize(
"options",
[
{"traces_sample_rate": 0, "traces_sampler": lambda _: 1.0},
{"traces_sample_rate": 0.1},
{"traces_sample_rate": None},
{},
],
)
def test_zero_traces_sample_rate_does_not_warn(sentry_init, options):
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
sentry_init(**options)

assert [w for w in caught if "traces_sample_rate is 0" in str(w.message)] == []


def test_ignore_spans_warns_without_streaming(sentry_init):
with pytest.warns(UserWarning, match=r"`ignore_spans` parameter only works"):
sentry_init(ignore_spans=["/health"], trace_lifecycle="static")
Expand Down
Loading