dogstatsd-ruby 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d780ad7a840c021ee3cb31a9e8b512ef7ccff4b82b14be9e300206d3a07cc61e
-  data.tar.gz: 2da798fe3a84f313c5c84655136597c562e3dc1bfaa24f8ba6441ef722c7cc45
+  metadata.gz: 92868c3d0ccb9a7847eaec3dd2da46413ab8acd2ce2df0008ee66c3e6500f3f6
+  data.tar.gz: 26064f00534e7df4a132d722041eea6b85a22849ca5c3c7caed05722320bcd9e
 SHA512:
-  metadata.gz: 8f92d7dab8099d571c291e26497020e53087ccdbeecfd84d955778f484112f9b94fb0f4ec7d043b9efabd5d249333168fa44e4fe6e54ba4c9541447b92983ceb
-  data.tar.gz: 8dadc086c84a821d4a1b1824a25ea4861bdf0b6a36cfcf8c50a8d06e19d6853c35974dbefb03fedc9ccd7a3f57ff13a19d206c5eef152c1aa5ffbc1f789da1bc
+  metadata.gz: e9f076b5aa76f4102f66698d5d19a3fbcd84e2b8b3a5fa944dcac07ddf8ee25f48a65d90e5296cbd7327f04dc90a8aba0234606bc50ab7c335120e9e17c3a6d2
+  data.tar.gz: e07f4469b7737fe7d67d32623194c90e09adf3d78ef0c26226bfed103db4067fa01e582f0627d426695dd9a0ff93c4e1e7d79d227bd5ce806d9ca28b2a440382

data/README.md

@@ -81,8 +81,6 @@ Version v5.x of `dogstatsd-ruby` is using a sender thread for flushing. This pro
 
 If you are using [Sidekiq](https://github.com/mperham/sidekiq), please make sure to close the client instances that are instantiated. [See this example on using DogStatsD-ruby v5.x with Sidekiq](https://github.com/DataDog/dogstatsd-ruby/blob/master/examples/sidekiq_example.rb).
 
-If you are using [Puma](https://github.com/puma/puma) or [Unicorn](https://yhbt.net/unicorn.git), please make sure to create the instance of DogStatsD in the workers, not in the main process before it forks to create its workers. See [this comment for more details](https://github.com/DataDog/dogstatsd-ruby/issues/179#issuecomment-845570345).
-
 Applications that run into issues but can't apply these recommendations should use the `single_thread` mode which disables the use of the sender thread.
 Here is how to instantiate a client in this mode:
 

data/lib/datadog/statsd/forwarder.rb

@@ -25,11 +25,13 @@ module Datadog
       )
         @transport_type = connection_cfg.transport_type
 
-        if telemetry_flush_interval
-          @telemetry = Telemetry.new(telemetry_flush_interval,
+        @telemetry = if telemetry_flush_interval
+          Telemetry.new(telemetry_flush_interval,
             global_tags: global_tags,
             transport_type: @transport_type
           )
+        else
+          nil
         end
 
         @connection = connection_cfg.make_connection(logger: logger, telemetry: telemetry)

data/lib/datadog/statsd/sender.rb

@@ -20,8 +20,10 @@ module Datadog
         @mx = Mutex.new
         @queue_class = queue_class
         @thread_class = thread_class
-        if flush_interval
-          @flush_timer = Datadog::Statsd::Timer.new(flush_interval) { flush(sync: true) }
+        @flush_timer = if flush_interval
+          Datadog::Statsd::Timer.new(flush_interval) { flush(sync: true) }
+        else
+          nil
         end
       end
 
@@ -102,10 +104,11 @@ module Datadog
         # to close the sender nor trying to continue to `#add` more message
         # into the sender.
         def stop(join_worker: true)
+          @flush_timer.stop if @flush_timer
+
           message_queue = @message_queue
           message_queue.close if message_queue
 
-          @flush_timer.stop if @flush_timer
           sender_thread = @sender_thread
           sender_thread.join if sender_thread && join_worker
         end
@@ -114,10 +117,11 @@ module Datadog
         # to close the sender nor trying to continue to `#add` more message
         # into the sender.
         def stop(join_worker: true)
+          @flush_timer.stop if @flush_timer
+
           message_queue = @message_queue
           message_queue << :close if message_queue
 
-          @flush_timer.stop if @flush_timer
           sender_thread = @sender_thread
           sender_thread.join if sender_thread && join_worker
         end

data/lib/datadog/statsd/single_thread_sender.rb

@@ -11,8 +11,10 @@ module Datadog
         @message_buffer = message_buffer
         @logger = logger
         @mx = Mutex.new
-        if flush_interval
-          @flush_timer = Datadog::Statsd::Timer.new(flush_interval) { flush }
+        @flush_timer = if flush_interval
+          Datadog::Statsd::Timer.new(flush_interval) { flush }
+        else
+          nil
         end
         # store the pid for which this sender has been created
         update_fork_pid

data/lib/datadog/statsd/timer.rb

@@ -9,6 +9,7 @@ module Datadog
         @interval = interval
         @callback = callback
         @stop = true
+        @thread = nil
       end
 
       def start

data/lib/datadog/statsd/version.rb

@@ -4,6 +4,6 @@ require_relative 'connection'
 
 module Datadog
   class Statsd
-    VERSION = '5.4.0'
+    VERSION = '5.5.0'
   end
 end

data/lib/datadog/statsd.rb

@@ -237,6 +237,26 @@ module Datadog
       send_stats(stat, value, DISTRIBUTION_TYPE, opts)
     end
 
+    # Reports execution time of the provided block as a distribution.
+    #
+    # If the block fails, the stat is still reported, then the error
+    # is reraised
+    #
+    # @param [String] stat stat name.
+    # @param [Numeric] value distribution value.
+    # @param [Hash] opts the options to create the metric with
+    # @option opts [Numeric] :sample_rate sample rate, 1 for always
+    # @option opts [Array<String>] :tags An array of tags
+    # @example Report the time (in ms) taken to activate an account
+    #   $statsd.distribution_time('account.activate') { @account.activate! }
+    def distribution_time(stat, opts = EMPTY_OPTIONS)
+      opts = { sample_rate: opts } if opts.is_a?(Numeric)
+      start = now
+      yield
+    ensure
+      distribution(stat, ((now - start) * 1000).round, opts)
+    end
+
     # Sends a timing (in ms) for the given stat to the statsd server. The
     # sample_rate determines what percentage of the time this report is sent. The
     # statsd server then uses the sample_rate to correctly track the average

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Rein Henrichs
 - Karim Bogtob
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby DogStatsd client
 email: code@datadoghq.com
@@ -44,9 +44,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/DataDog/dogstatsd-ruby/issues
-  changelog_uri: https://github.com/DataDog/dogstatsd-ruby/blob/v5.4.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/dogstatsd-ruby/5.4.0
-  source_code_uri: https://github.com/DataDog/dogstatsd-ruby/tree/v5.4.0
+  changelog_uri: https://github.com/DataDog/dogstatsd-ruby/blob/v5.5.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/dogstatsd-ruby/5.5.0
+  source_code_uri: https://github.com/DataDog/dogstatsd-ruby/tree/v5.5.0
 post_install_message: |2+
 
   If you are upgrading from v4.x of the dogstatsd-ruby library, note the major change to the threading model:
@@ -66,8 +66,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.10
+signing_key:
 specification_version: 4
 summary: A Ruby DogStatsd client
 test_files: []
+...