Fix NoMethodError in sinatra integration when Tracer middleware is missing #1644
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
…ssing This fixes a regression introduced in version 0.52.0 by #1628. When a Sinatra modular application being traced is missing the `Datadog::Contrib::Sinatra::Tracer` middleware (as documented in <https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#sinatra>), no Sinatra request span is ever created (only a route span). Because we didn't properly account for this in `#datadog_span`, the following `NoMethodError` was triggered: ``` NoMethodError: undefined method `[]' for nil:NilClass dd-trace-rb/lib/ddtrace/contrib/sinatra/env.rb:13:in `datadog_span' dd-trace-rb/lib/ddtrace/contrib/sinatra/tracer.rb:122:in `block in route_eval' dd-trace-rb/lib/ddtrace/tracer.rb:283:in `trace' dd-trace-rb/lib/ddtrace/contrib/sinatra/tracer.rb:105:in `route_eval' ruby-2.7.4/gems/sinatra-2.1.0/lib/sinatra/base.rb:1013:in `block (2 levels) in route!' ``` I suspect this is the same issue as was reported in #1643. Because this configuration is actually not desirable -- spans reported will be missing crucial request information, as discussed in #1643 -- I've also added a warning to hopefully steer users in the right direction.
marcotc
approved these changes
Aug 11, 2021
ivoanjo
deleted the
ivoanjo/fix-nomethoderror-on-sinatra-without-middleware
branch
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 fixes a regression introduced in version 0.52.0 by #1628.
When a Sinatra modular application being traced is missing the
Datadog::Contrib::Sinatra::Tracermiddleware (as documented in https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#sinatra), no Sinatra request span is ever created (only a route span).Because we didn't properly account for this in
#datadog_span, the followingNoMethodErrorwas triggered:I suspect this is the same issue as was reported in #1643.
Because this configuration is actually not desirable -- spans reported will be missing crucial request information, as discussed in #1643 -- I've also added a warning to hopefully steer users in the right direction.