statsd-instrument 3.9.9 → 3.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60ed39eafdc0c0c60e8b39cc40a525990f7a51c8bf0621bf657558f29e6767c4
-  data.tar.gz: 6d27813cbc21f7f5327cdc261d1dfd7c874d9c4f0c1fdfb17aee1ee63944ea9c
+  metadata.gz: d6bb36fa3a5254a64999335275c5515579febf9c2d92d35522fee1d883d0f56d
+  data.tar.gz: 69c96c4f5abaa8cae674a85e562a41ab3bbcf05cde0ef523c934d86846103658
 SHA512:
-  metadata.gz: 6cafa0a80f7c5d7374d8607698b03fc8eb9fe94cfd7b8a4c6accd1bb9ac4c66a83fea40215df8bcc87c4f729e4379956d2614970539375d13c2cd6d65840a5b9
-  data.tar.gz: 7e254ea3318a5fc3d79bcb648c5cc939dbbb1552f942c67c38f06d698f44659e790489b5a720cca815ca6998a59b317399a3a54350dca61defafc27ed2da15f6
+  metadata.gz: 321874ee863b3f66e1eb7abbace4e734af55dc86fbd11aa8e009e398c54414f47d91447cdcbf08fb93bd4f7b1d88d58a16217093e9f8978b400187ed513dbd74
+  data.tar.gz: 9f34eed89dee5efc7d9a3d800c1d6824b0396054782694d708dab40180e0c3b423f6a0c2337b995bf6f58d72ae750bed564cf02bb5e13fc08518540e443be400

data/.ruby-version

@@ -1 +1 @@
-3.3.3
+3.4.4

data/CHANGELOG.md

@@ -6,6 +6,14 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.9.10
+
+- [#398](https://github.com/Shopify/statsd-instrument/pull/398) - Fix metrics not being sent from signal trap contexts when aggregation is enabled.
+  When the aggregator is enabled and metrics are emitted from within a signal handler (e.g., SIGTERM, SIGINT), 
+  the thread health check would fail with `ThreadError: can't be called from trap context` due to mutex 
+  synchronization. The aggregator now gracefully falls back to direct writes when called from a trap context, 
+  ensuring metrics are not lost during signal handling such as graceful shutdowns.
+
 ## Version 3.9.9
 
 - [#392](https://github.com/Shopify/statsd-instrument/pull/392) - Prevent ENOBUFS errors when using UDP, by skipping setting socket buffer size.

data/lib/statsd/instrument/aggregator.rb

@@ -278,6 +278,16 @@ module StatsD
           end
           true
         end
+      rescue ThreadError => e
+        # If we're in a trap context, we can't use mutex synchronization
+        # Fall back to direct writes to avoid losing metrics
+        if e.message.include?("can't be called from trap context")
+          StatsD.logger.debug { "[#{self.class.name}] In trap context, falling back to direct writes" }
+          false
+        else
+          # Re-raise other ThreadErrors
+          raise
+        end
       end
     end
   end

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.9.9"
+    VERSION = "3.9.10"
   end
 end

data/lib/statsd/instrument.rb

@@ -362,7 +362,7 @@ module StatsD
     # @!method distribution(name, value = nil, sample_rate: nil, tags: nil, &block)
     #   (see StatsD::Instrument::Client#distribution)
     #
-    # @!method event(title, text, tags: nil, hostname: nil, timestamp: nil, aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil) # rubocop:disable Layout/LineLength
+    # @!method event(title, text, tags: nil, hostname: nil, timestamp: nil, aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil)
     #   (see StatsD::Instrument::Client#event)
     #
     # @!method service_check(name, status, tags: nil, hostname: nil, timestamp: nil, message: nil)

data/test/aggregator_test.rb

@@ -353,4 +353,50 @@ class AggregatorTest < Minitest::Test
     assert_equal(100.0, sampled_timing_datagram.value)
     assert_equal(0.01, sampled_timing_datagram.sample_rate)
   end
+
+  def test_signal_trap_context_fallback_to_direct_writes
+    skip("#{RUBY_ENGINE} not supported for this test. Reason: signal handling") if RUBY_ENGINE != "ruby"
+
+    signal_received = false
+    metrics_sent_in_trap = []
+
+    old_trap = Signal.trap("USR1") do
+      signal_received = true
+      # These operations should now fall back to direct writes
+      @subject.increment("trap_counter", 1)
+      @subject.gauge("trap_gauge", 42)
+      @subject.aggregate_timing("trap_timing", 100)
+
+      metrics_sent_in_trap = @sink.datagrams.map(&:name)
+    end
+
+    @sink.clear
+
+    Process.kill("USR1", Process.pid)
+
+    sleep(0.1)
+
+    assert(signal_received, "Signal should have been received")
+
+    assert_includes(metrics_sent_in_trap, "trap_counter")
+    assert_includes(metrics_sent_in_trap, "trap_gauge")
+    assert_includes(metrics_sent_in_trap, "trap_timing")
+
+    counter_datagram = @sink.datagrams.find { |d| d.name == "trap_counter" }
+    assert_equal(1, counter_datagram.value)
+
+    gauge_datagram = @sink.datagrams.find { |d| d.name == "trap_gauge" }
+    assert_equal(42, gauge_datagram.value)
+
+    timing_datagram = @sink.datagrams.find { |d| d.name == "trap_timing" }
+    assert_equal([100.0], [timing_datagram.value].flatten)
+
+    debug_messages = @logger.messages.select { |m| m[:severity] == :debug }
+    assert(
+      debug_messages.any? { |m| m[:message].include?("In trap context, falling back to direct writes") },
+      "Expected debug message about trap context fallback",
+    )
+  ensure
+    Signal.trap("USR1", old_trap || "DEFAULT")
+  end
 end

data/test/dispatcher_stats_test.rb

@@ -48,21 +48,21 @@ class DispatcherStatsTest < Minitest::Test
     end
     assert_equal(batches.length, stats.instance_variable_get(:@batched_sends))
     assert_equal(
-      batches.map { |b|
+      batches.map do |b|
         b[:buffer_len]
-      }.sum / batches.length,
+      end.sum / batches.length,
       stats.instance_variable_get(:@avg_buffer_length),
     )
     assert_equal(
-      batches.map { |b|
+      batches.map do |b|
         b[:packet_size]
-      }.sum / batches.length,
+      end.sum / batches.length,
       stats.instance_variable_get(:@avg_batched_packet_size),
     )
     assert_equal(
-      batches.map { |b|
+      batches.map do |b|
         b[:batch_len]
-      }.sum / batches.length,
+      end.sum / batches.length,
       stats.instance_variable_get(:@avg_batch_length),
     )
   end

data/test/integration_test.rb

@@ -103,4 +103,56 @@ class IntegrationTest < Minitest::Test
     assert_match(/counter:\d+|c/, packets.find { |packet| packet.start_with?("counter:") })
     assert_match(/test_distribution:\d+:3|d/, packets.find { |packet| packet.start_with?("test_distribution:") })
   end
+
+  def test_signal_trap_with_aggregation_fallback
+    skip("#{RUBY_ENGINE} not supported for this test. Reason: signal handling") if RUBY_ENGINE != "ruby"
+
+    client = StatsD::Instrument::Environment.new(
+      "STATSD_ADDR" => "#{@server.addr[2]}:#{@server.addr[1]}",
+      "STATSD_IMPLEMENTATION" => "dogstatsd",
+      "STATSD_ENV" => "production",
+      "STATSD_ENABLE_AGGREGATION" => "true",
+      "STATSD_AGGREGATION_INTERVAL" => "5.0",
+    ).client
+
+    signal_received = false
+
+    old_trap = Signal.trap("USR1") do
+      signal_received = true
+      # These should fall back to direct writes
+      client.increment("trap_metric", 5)
+      client.gauge("trap_gauge", 42)
+      client.distribution("trap_distribution", 100)
+    end
+
+    Process.kill("USR1", Process.pid)
+
+    sleep(0.1)
+
+    assert(signal_received, "Signal should have been received")
+
+    packets = []
+    while IO.select([@server], nil, nil, 0.1)
+      packet = @server.recvfrom(300).first
+      packets.concat(packet.split("\n"))
+    end
+
+    # When aggregation is disabled due to trap context, metrics might be batched
+    assert(packets.size >= 3, "Expected at least 3 metrics, got #{packets.size}: #{packets.inspect}")
+
+    assert(
+      packets.any? { |p| p == "trap_metric:5|c" },
+      "Expected counter metric, got: #{packets.inspect}",
+    )
+    assert(
+      packets.any? { |p| p == "trap_gauge:42|g" },
+      "Expected gauge metric, got: #{packets.inspect}",
+    )
+    assert(
+      packets.any? { |p| p == "trap_distribution:100|d" },
+      "Expected distribution metric, got: #{packets.inspect}",
+    )
+  ensure
+    Signal.trap("USR1", old_trap || "DEFAULT")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.9.9
+  version: 3.9.10
 platform: ruby
 authors:
 - Jesse Storimer
@@ -9,7 +9,7 @@ authors:
 - Willem van Bergen
 bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files: