Do not use configured dogstatsd instance when it's an incompatible version #1560
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
…rsion A customer reported the following `NoMethodError`: ``` components.rb:245:in `each': private method `close' called for #<Datadog::Statsd:0x00007fa757896bc8> (NoMethodError) ``` Turns out that the customer had an incompatible dogstatsd-ruby version, but since they had their instance manually configured, rather than created by the `Metrics` class, our version check was being bypassed. This led the incompatible dogstatsd-ruby version to be used, and one of the incompatibilites is the fact that `#close` was private on that old version. A minimal test case for this issue is: ```ruby require 'bundler/inline' gemfile do source 'https://rubygems.org' gem 'dogstatsd-ruby', '< 3' gem 'ddtrace', '= 0.50.0' end require 'ddtrace' require 'datadog/statsd' Datadog.configure do |c| c.runtime_metrics.statsd = Datadog::Statsd.new end Datadog.shutdown! ``` To fix this issue, I've changed the `#initialize` method to always call `#supported?` before either accepting a pre-existing `statsd` instance, or trying to create one. To avoid silently breaking customer-expected behavior, I've also added a warning; hopefully customers with the wrong configuration will see the warning and know that they need to upgrade `dogstatsd-ruby`. NOTE: We should really look into adding a hard dependency from ddtrace to dogstatsd-ruby so that we could do away with our home-grown incompatible version checking code.
ivoanjo
force-pushed
the
fix/disallow-using-older-statsd-when-directly-configured
branch
from
ab0894d
to
1313907
Compare
ivoanjo
force-pushed
the
fix/disallow-using-older-statsd-when-directly-configured
branch
from
1313907
to
79e7da5
Compare
Codecov Report
@@ Coverage Diff @@
## master #1560 +/- ##
=======================================
Coverage 98.23% 98.24%
=======================================
Files 885 885
Lines 42554 42594 +40
=======================================
+ Hits 41804 41845 +41
+ Misses 750 749 -1
Continue to review full report at Codecov.
|
marcotc
approved these changes
Jun 18, 2021
marcotc
deleted the
fix/disallow-using-older-statsd-when-directly-configured
branch
ivoanjo
added a commit
that referenced
this pull request
Jun 21, 2021
Leftover from #1560, I noticed that I had left a confusing description for a test group.
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.
A customer reported the following
NoMethodError:Turns out that the customer had an incompatible dogstatsd-ruby version, but since they had their instance manually configured, rather than created by the
Metricsclass, our version check was being bypassed. This led the incompatible dogstatsd-ruby version to be used, and one of the incompatibilites is the fact that#closewas private on that old version.A minimal test case for this issue is:
To fix this issue, I've changed the
#initializemethod to always call#supported?before either accepting a pre-existingstatsdinstance, or trying to create one.To avoid silently breaking customer-expected behavior, I've also added a warning; hopefully customers with the wrong configuration will see the warning and know that they need to upgrade
dogstatsd-ruby.NOTE: We should really look into adding a hard dependency from ddtrace to dogstatsd-ruby so that we could do away with our home-grown incompatible version checking code.