statsd-instrument 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e3cda783c5f0c7de2c30175ab001cef492c3ad0e0923af3d3a4840df7d6005
-  data.tar.gz: b31685696c6e1ad8e5cd36a8115eca2363ed9a732a483534004b2163453b323a
+  metadata.gz: c2e01a49d8bb83318bef84628164ab1dec1047a72c1f717969a609f783d3b8be
+  data.tar.gz: bf308ae3bb23958705efcc39c03fa95f99b58bb33df47b7588fe4a7b22d742e9
 SHA512:
-  metadata.gz: 658663a99a273170ad72436eae0142d707e35a8cc2bbf5befd89a7cd225db5673c5ec676e8f96a168411f443fa7d3e6b73f60c6f081067082b2003920cef264b
-  data.tar.gz: bc8930e083ec158ca6a945186c2156a0890ebe74edb63080dc6ced9ca691498edc9d81ae746ec80477471c3b2f09d3abb95042002c0c8e7d72afeb9ab360526c
+  metadata.gz: 57f0022a72e600871df9f054ad4a003ed2c361287949bfa4af94789460ffa1a9257ffba1f552ac77b786d5c9dc295efb7ccd82edf632f7151d1dda365b282a61
+  data.tar.gz: c458ec4b7177cd746f3fd173641db3127ac97a7683f0f55ff00f84ebe5a81b827d53340566b79ea39adb7327ac967298657d23fcc5f51bd9edced6ea05314beb

data/CHANGELOG.md

@@ -6,6 +6,10 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.7.0
+
+- Add public `.flush` method to sink classes.
+
 ## Version 3.6.1
 
 - Fix `ArgumentError` when passing an empty Hash as tags.

data/lib/statsd/instrument/batched_udp_sink.rb

@@ -55,6 +55,10 @@ module StatsD
         @dispatcher.shutdown(*args)
       end
 
+      def flush(blocking:)
+        @dispatcher.flush(blocking: blocking)
+      end
+
       class Buffer < SizedQueue
         def push_nonblock(item)
           push(item, true)
@@ -104,10 +108,6 @@ module StatsD
           flush(blocking: false)
         end
 
-        private
-
-        NEWLINE = "\n".b.freeze
-
         def flush(blocking:)
           packet = "".b
           next_datagram = nil
@@ -137,6 +137,10 @@ module StatsD
           end
         end
 
+        private
+
+        NEWLINE = "\n".b.freeze
+
         def thread_healthcheck
           # TODO: We have a race condition on JRuby / Truffle here. It could cause multiple
           # dispatcher threads to be spawned, which would cause problems.

data/lib/statsd/instrument/capture_sink.rb

@@ -26,6 +26,10 @@ module StatsD
       def clear
         @datagrams.clear
       end
+
+      def flush(blocking:)
+        @parent.flush(blocking: blocking)
+      end
     end
   end
 end

data/lib/statsd/instrument/dogstatsd_datagram_builder.rb

@@ -16,7 +16,7 @@ module StatsD
         :d
       end
 
-      # Constricts an event datagram.
+      # Constructs an event datagram.
       #
       # @param [String] title Event title.
       # @param [String] text Event description. Newlines are allowed.
@@ -57,7 +57,7 @@ module StatsD
         datagram
       end
 
-      # Constricts a service check datagram.
+      # Constructs a service check datagram.
       #
       # @param [String] name Name of the service
       # @param [Symbol] status Either `:ok`, `:warning`, `:critical` or `:unknown`

data/lib/statsd/instrument/log_sink.rb

@@ -23,6 +23,10 @@ module StatsD
         logger.add(severity, "[StatsD] #{datagram.chomp}")
         self
       end
+
+      def flush(blocking:)
+        # noop
+      end
     end
   end
 end

data/lib/statsd/instrument/null_sink.rb

@@ -12,6 +12,10 @@ module StatsD
       def <<(_datagram)
         self # noop
       end
+
+      def flush(blocking:)
+        # noop
+      end
     end
   end
 end

data/lib/statsd/instrument/udp_sink.rb

@@ -53,6 +53,10 @@ module StatsD
         self
       end
 
+      def flush(blocking:)
+        # noop
+      end
+
       private
 
       def invalidate_socket

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.6.1"
+    VERSION = "3.7.0"
   end
 end

data/test/environment_test.rb

@@ -57,6 +57,9 @@ class EnvironmentTest < Minitest::Test
   end
 
   def test_client_from_env_uses_regular_udp_sink_when_flush_interval_is_0
+    StatsD::Instrument::Environment.any_instance.expects(:warn).with(
+      "STATSD_FLUSH_INTERVAL=0.0 is deprecated, please set STATSD_BUFFER_CAPACITY=0 instead.",
+    ).once
     env = StatsD::Instrument::Environment.new(
       "STATSD_USE_NEW_CLIENT" => "1",
       "STATSD_ENV" => "staging",

data/test/udp_sink_test.rb

@@ -122,79 +122,91 @@ module UDPSinkTests
     end
     datagrams
   end
+end
 
-  class UDPSinkTest < Minitest::Test
-    include UDPSinkTests
+class UDPSinkTest < Minitest::Test
+  include UDPSinkTests
 
-    def setup
-      @receiver = UDPSocket.new
-      @receiver.bind("localhost", 0)
-      @host = @receiver.addr[2]
-      @port = @receiver.addr[1]
-      @sink_class = StatsD::Instrument::UDPSink
-    end
+  def setup
+    @receiver = UDPSocket.new
+    @receiver.bind("localhost", 0)
+    @host = @receiver.addr[2]
+    @port = @receiver.addr[1]
+    @sink_class = StatsD::Instrument::UDPSink
+  end
 
-    def teardown
-      @receiver.close
-    end
+  def teardown
+    @receiver.close
+  end
 
-    def test_socket_error_should_invalidate_socket
-      previous_logger = StatsD.logger
-      begin
-        logs = StringIO.new
-        StatsD.logger = Logger.new(logs)
-        StatsD.logger.formatter = SimpleFormatter.new
-        UDPSocket.stubs(:new).returns(socket = mock("socket"))
-
-        seq = sequence("connect_fail_connect_succeed")
-        socket.expects(:connect).with("localhost", 8125).in_sequence(seq)
-        socket.expects(:send).raises(Errno::EDESTADDRREQ).in_sequence(seq)
-        socket.expects(:close).in_sequence(seq)
-        socket.expects(:connect).with("localhost", 8125).in_sequence(seq)
-        socket.expects(:send).twice.returns(1).in_sequence(seq)
-
-        udp_sink = build_sink("localhost", 8125)
-        udp_sink << "foo:1|c"
-        udp_sink << "bar:1|c"
-
-        assert_equal(
-          "[#{@sink_class}] Resetting connection because of " \
-            "Errno::EDESTADDRREQ: Destination address required\n",
-          logs.string,
-        )
-      ensure
-        StatsD.logger = previous_logger
-      end
+  def test_socket_error_should_invalidate_socket
+    previous_logger = StatsD.logger
+    begin
+      logs = StringIO.new
+      StatsD.logger = Logger.new(logs)
+      StatsD.logger.formatter = SimpleFormatter.new
+      UDPSocket.stubs(:new).returns(socket = mock("socket"))
+
+      seq = sequence("connect_fail_connect_succeed")
+      socket.expects(:connect).with("localhost", 8125).in_sequence(seq)
+      socket.expects(:send).raises(Errno::EDESTADDRREQ).in_sequence(seq)
+      socket.expects(:close).in_sequence(seq)
+      socket.expects(:connect).with("localhost", 8125).in_sequence(seq)
+      socket.expects(:send).twice.returns(1).in_sequence(seq)
+      socket.expects(:close).in_sequence(seq)
+
+      udp_sink = build_sink("localhost", 8125)
+      udp_sink << "foo:1|c"
+      udp_sink << "bar:1|c"
+
+      assert_equal(
+        "[#{@sink_class}] Resetting connection because of " \
+          "Errno::EDESTADDRREQ: Destination address required\n",
+        logs.string,
+      )
+    ensure
+      StatsD.logger = previous_logger
+      # Make sure our fake socket is closed so that it doesn't interfere with other tests
+      udp_sink&.send(:invalidate_socket)
     end
   end
+end
 
-  module BatchedUDPSinkTests
-    include UDPSinkTests
+class BatchedUDPSinkTest < Minitest::Test
+  include UDPSinkTests
 
-    def setup
-      @receiver = UDPSocket.new
-      @receiver.bind("localhost", 0)
-      @host = @receiver.addr[2]
-      @port = @receiver.addr[1]
-      @sink_class = StatsD::Instrument::BatchedUDPSink
-      @sinks = []
-    end
-
-    def teardown
-      @receiver.close
-      @sinks.each(&:shutdown)
-    end
+  def setup
+    @receiver = UDPSocket.new
+    @receiver.bind("localhost", 0)
+    @host = @receiver.addr[2]
+    @port = @receiver.addr[1]
+    @sink_class = StatsD::Instrument::BatchedUDPSink
+    @sinks = []
+  end
 
-    private
+  def teardown
+    @receiver.close
+    @sinks.each(&:shutdown)
+  end
 
-    def build_sink(host = @host, port = @port)
-      sink = @sink_class.new(host, port, buffer_capacity: 50)
-      @sinks << sink
-      sink
-    end
+  def test_flush
+    buffer_size = 50
+
+    sink = build_sink(@host, @port, buffer_capacity: buffer_size)
+    dispatcher = sink.instance_variable_get(:@dispatcher)
+    buffer = dispatcher.instance_variable_get(:@buffer)
+    # Send a few datagrams to fill the buffer
+    (buffer_size * 2).times { |i| sink << "foo:#{i}|c" }
+    assert(!buffer.empty?)
+    sink.flush(blocking: false)
+    assert(buffer.empty?)
   end
 
-  class BatchedUDPSinkTest < Minitest::Test
-    include BatchedUDPSinkTests
+  private
+
+  def build_sink(host = @host, port = @port, buffer_capacity: 50)
+    sink = @sink_class.new(host, port, buffer_capacity: buffer_capacity)
+    @sinks << sink
+    sink
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies: []
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps