Skip to content

Fix spans for streaming responses in WSGI based frameworks#3798

Merged
antonpirker merged 54 commits intomasterfrom
antonpirker/fix-streaming-response
Nov 25, 2024
Merged

Fix spans for streaming responses in WSGI based frameworks#3798
antonpirker merged 54 commits intomasterfrom
antonpirker/fix-streaming-response

Conversation

@antonpirker
Copy link
Contributor

@antonpirker antonpirker commented Nov 18, 2024 •
edited
Loading

Fixes spans in streaming responses when using WSGI based frameworks. Only close the transaction once the response was consumed. This way all the spans created during creation of the response will be recorded with the transaction:

  • The transaction stays open until all the streaming blocks are sent to the client. (because of this I had to update the tests, to make sure the tests, consume the response, because the Werkzeug test client (used by Flask and Django and our Strawberry tests) will not close the WSGI response)
  • A maximum runtime of 5 minutes for transactions is enforced. (like Javascript does it)
  • When using a generator to generate the streaming response, it uses the correct scopes to have correct parent-child relationship of spans created in the generator.

People having Sentry in a streaming application will:

  • See an increase in their transaction duration to up to 5 minutes
  • Get the correct span tree for streaming responses generated by a generator

Fixes #3736

@codecov
Copy link

codecov bot commented Nov 18, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 90.62500% with 6 lines in your changes missing coverage. Please review.

Project coverage is 79.94%. Comparing base (a7c2d70) to head (8574c06).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
sentry_sdk/integrations/wsgi.py 92.59% 4 Missing ⚠️
sentry_sdk/tracing_utils.py 80.00% 2 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #3798      +/-   ##
==========================================
+ Coverage   79.89%   79.94%   +0.05%     
==========================================
  Files         137      137              
  Lines       15385    15421      +36     
  Branches     2611     2614       +3     
==========================================
+ Hits        12292    12329      +37     
- Misses       2222     2223       +1     
+ Partials      871      869       -2
Files with missing lines Coverage Δ
sentry_sdk/tracing_utils.py 83.92% <80.00%> (-0.11%) ⬇️
sentry_sdk/integrations/wsgi.py 85.96% <92.59%> (+1.13%) ⬆️

... and 5 files with indirect coverage changes

@antonpirker
Fix current scope in wsgi integration
ef90c73
@antonpirker
Merge branch 'master' into antonpirker/fix-streaming-response
b00723f
@antonpirker
Revert "Keep transaction open until all streaming responses are finis…
8f2463b 
…hed."

This reverts commit 1fe8679.
@antonpirker
Merge branch 'antonpirker/fix-streaming-response' of github.com:getse…
f15d596 
…ntry/sentry-python into antonpirker/fix-streaming-response
@antonpirker
fix merge screw up
61a5c5d
@antonpirker
use the right import
17df886
@antonpirker
Keep transaction open until all streaming responses are finished.
0c82ddb
@antonpirker
fix
5bab9ec
@antonpirker
Bottle never calls response.close()
beeee5f
@antonpirker
Manually close transaction in flask
c32c202
@antonpirker
Make sure we do not close already closed transactions
660be15
@antonpirker
Make code a bit nicer
93e9219
@antonpirker
preserve behavior
54cda52
@antonpirker
Fix
d904f38
@antonpirker
Closing the transaction always.
a614fc6
@antonpirker
.
24be3d3
@antonpirker
.
e762ef9
@antonpirker
Remove manual closing in bottle, not needed anymore
198a621
@antonpirker
cleanup
26ec3d7
@antonpirker
Adding exception info when closing transaction
b8c7c1b
@antonpirker
Cleanup
9523882
@antonpirker antonpirker changed the title Fix spans for streaming responses Fix spans for streaming responses in WSGI based frameworks Nov 20, 2024
@antonpirker antonpirker self-assigned this Nov 21, 2024
@antonpirker antonpirker force-pushed the antonpirker/fix-streaming-response branch from 32c40ed to c612326 Compare November 21, 2024 14:09
@antonpirker antonpirker force-pushed the antonpirker/fix-streaming-response branch from 15eb914 to 30d18fa Compare November 22, 2024 11:41
@antonpirker antonpirker marked this pull request as ready for review November 22, 2024 12:19
sentrivana
sentrivana approved these changes Nov 22, 2024
View reviewed changes
Copy link
Contributor

@sentrivana sentrivana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of comments. As long as the tests for the various integrations that use the WSGI middleware are happy, I think this looks good.

@antonpirker antonpirker merged commit da20623 into master Nov 25, 2024
@antonpirker antonpirker deleted the antonpirker/fix-streaming-response branch November 25, 2024 09:04
@antonpirker antonpirker mentioned this pull request Nov 25, 2024
Open
antonpirker added a commit that referenced this pull request Dec 2, 2024
@antonpirker
Revert "Fix spans for streaming responses in WSGI based frameworks (#…
0ac5be6 
…3798)"

This reverts commit da20623.
@antonpirker antonpirker mentioned this pull request Dec 2, 2024
Merged
antonpirker added a commit that referenced this pull request Dec 2, 2024
@antonpirker
Revert "Fix spans for streaming responses in WSGI based frameworks (#…
3d8445c 
…3798)" (#3836)

This reverts commit da20623. (PR #3798)

Having a timer thread on each request is too much overhead on high volume servers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sentrivana sentrivana sentrivana approved these changes

Assignees

@antonpirker antonpirker

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Django StreamingHttpResponse View not working as expected

2 participants

@antonpirker @sentrivana