Warn when transaction entered without calling start_transaction
#3003
Conversation
This file contains 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
antonpirker
approved these changes
Apr 23, 2024
Comment on lines
+417
to
+422
| The transaction will not be sent to Sentry. To fix, start the transaction by | ||
| passing it to sentry_sdk.start_transaction, like so: | ||
|
|
||
| with sentry_sdk.start_transaction(transaction): | ||
| # code here | ||
| """ |
There was a problem hiding this comment.
Suggested change
| The transaction will not be sent to Sentry. To fix, start the transaction by | |
| passing it to sentry_sdk.start_transaction, like so: | |
| with sentry_sdk.start_transaction(transaction): | |
| # code here | |
| """ | |
| The transaction will not be sent to Sentry. To fix, start the transaction by | |
| passing it to sentry_sdk.start_transaction, like so: | |
| with sentry_sdk.start_transaction(transaction): | |
| # code here | |
| """ |
There was a problem hiding this comment.
This spacing is intentional; it makes the message appear nicely in the logs, like so:
[sentry] WARNING: Transaction was entered without being started with sentry_sdk.start_transaction.
The transaction will not be sent to Sentry. To fix, start the transaction by
passing it to sentry_sdk.start_transaction, like so:
with sentry_sdk.start_transaction(transaction):
# code here
szokeasaurusrex
force-pushed
the
szokeasaurusrex/transaction-not-started-warning
branch
from
00c2bc7
to
5cd3884
Compare
szokeasaurusrex
force-pushed
the
szokeasaurusrex/transaction-sampled-debug-message
branch
from
a090a5c
to
f8586eb
Compare
szokeasaurusrex
force-pushed
the
szokeasaurusrex/transaction-not-started-warning
branch
from
5cd3884
to
f1346b0
Compare
`sampled` being set to `False` is not the only reason why the `_span_recorder` might be `None`. Another explanation is that the transaction was not started via `start_transaction`.
Transactions that are discarded because `_span_recorder` is `None` can also be discarded because they were not started with `sentry_sdk.start_transaction`. This change updates the debug message accordingly. Fixes GH-3000
szokeasaurusrex
force-pushed
the
szokeasaurusrex/transaction-sampled-debug-message
branch
from
f8586eb
to
d0fc544
Compare
…ransaction` Users who enter a transaction without calling `start_transaction` likely intended to start the transaction, since without a call to `start_transaction`, their transaction will not get sent to Sentry. This warning message clarifies this behavior, and could help avoid the confusion that led to issue #2990.
The previous name, `_possibly_stated`, contains a typo, which this change fixes. Co-authored-by: Anton Pirker <anton.pirker@sentry.io>
szokeasaurusrex
force-pushed
the
szokeasaurusrex/transaction-not-started-warning
branch
from
f1346b0
to
84ab96a
Compare
szokeasaurusrex
force-pushed
the
szokeasaurusrex/transaction-sampled-debug-message
branch
from
d0fc544
to
534a301
Compare
Base automatically changed from
szokeasaurusrex/transaction-sampled-debug-message
to
master
April 25, 2024 13:40
antonpirker
requested changes
Apr 30, 2024
Comment on lines
+713
to
+721
| logger.warning( | ||
| """Transaction was entered without being started with sentry_sdk.start_transaction. | ||
| The transaction will not be sent to Sentry. To fix, start the transaction by | ||
| passing it to sentry_sdk.start_transaction, like so: | ||
|
|
||
| with sentry_sdk.start_transaction(transaction): | ||
| # code here | ||
| """ | ||
| ) |
There was a problem hiding this comment.
Log messages should not be multi-line because it makes it hard or impossible to grep through the logs (or do some other line based processing)
Please change the log message to be one line.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This change should prevent confusion like what led to #2990 being opened.