Fix sentry-rails' controller span nesting #1973
Conversation
Codecov ReportBase: 98.61% // Head: 98.61% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #1973 +/- ##
=======================================
Coverage 98.61% 98.61%
=======================================
Files 157 157
Lines 9880 9902 +22
=======================================
+ Hits 9743 9765 +22
Misses 137 137
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Yep let's make this a separate change. |
st0012
force-pushed
the
fix-#1899
branch
2 times, most recently
from
ced34ad
to
4c4cdb9
Compare
This makes sure all spans generated inside the controller call will be attached under the controller span instead of the request span.
Now we wrap controller action inside `Sentry.with_child_span`, we don't need to register the `ActionControllerSubscriber` anymore. However, we still can't remove it because users may reference the constant directly when customizing the tracing subscribers config.
| begin | ||
| result = yield | ||
| ensure | ||
| child_span.set_http_status(response.status) |
There was a problem hiding this comment.
should we guard for response being nil?
There was a problem hiding this comment.
In Rails, the controller's request and response object are all generated at the beginning of the request. So in this case, we don't need to worry about it being nil 🙂
As described in #1899, the controller span's nesting is not correct because we record it through ActiveSupport instrumentation.
So this PR I did a few things:
Span#with_child_spanfinishes the span properly when exceptions occurred, so users don't have to add boilerplate code in every call.Sentry.with_child_spanaround Rails' controller action so spans generated during actions can be attached to the controller span.ActionControllerSubscriber. This is because tracing subscribers are public classes and removing them should be considered a breaking change.Fixes #1899