statsd-instrument 3.5.12 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41254f0057c645926c54b36ec4bf937352444740f0cae248b1feed1f35ce4044
-  data.tar.gz: 3d2131889385d2755a738d735ca9a20dba0342e645d58312c4007b7a1835b249
+  metadata.gz: a5e3cda783c5f0c7de2c30175ab001cef492c3ad0e0923af3d3a4840df7d6005
+  data.tar.gz: b31685696c6e1ad8e5cd36a8115eca2363ed9a732a483534004b2163453b323a
 SHA512:
-  metadata.gz: 46a4f427f2e298c242a84c7f90a715a7d4397c28ad5db8f89f8b669e3867c7b253a5858a61e35768fada113b56202dc43d91cffb68b9626ea79c26fd15d10a67
-  data.tar.gz: 99b1979f9b3b9a4e502c78a42bfa48348600eece64646ddfdd2470ae1d3b4cc52123e3edaef539886c667ff2e9eca98051c55c5fec7c6ccc76e1404e2f5f2800
+  metadata.gz: 658663a99a273170ad72436eae0142d707e35a8cc2bbf5befd89a7cd225db5673c5ec676e8f96a168411f443fa7d3e6b73f60c6f081067082b2003920cef264b
+  data.tar.gz: bc8930e083ec158ca6a945186c2156a0890ebe74edb63080dc6ced9ca691498edc9d81ae746ec80477471c3b2f09d3abb95042002c0c8e7d72afeb9ab360526c

data/CHANGELOG.md

@@ -6,6 +6,14 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.6.1
+
+- Fix `ArgumentError` when passing an empty Hash as tags.
+
+## Version 3.6.0
+
+- Optimized datagram building.
+
 ## Version 3.5.12
 
 - Update CONTRIBUTING docs about release process

data/lib/statsd/instrument/client.rb

@@ -140,13 +140,15 @@ module StatsD
       # on their frequency, rather than changing the default sample rate.
       #
       # @return [Float] (default: 1.0) A value between 0.0 and 1.0.
-      attr_reader :default_sample_rate
+      def default_sample_rate
+        @default_sample_rate || 1.0
+      end
 
       # Instantiates a new client.
       # @see .from_env to instantiate a client using environment variables.
       def initialize(
         prefix: nil,
-        default_sample_rate: 1.0,
+        default_sample_rate: nil,
         default_tags: nil,
         implementation: "datadog",
         sink: StatsD::Instrument::NullSink.new,
@@ -199,9 +201,10 @@ module StatsD
       # @return [void]
       def increment(name, value = 1, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
-        return StatsD::Instrument::VOID unless sample?(sample_rate)
-
-        emit(datagram_builder(no_prefix: no_prefix).c(name, value, sample_rate, tags))
+        if sample_rate.nil? || sample?(sample_rate)
+          emit(datagram_builder(no_prefix: no_prefix).c(name, value, sample_rate, tags))
+        end
+        StatsD::Instrument::VOID
       end
 
       # Emits a timing metric.
@@ -217,9 +220,10 @@ module StatsD
         end
 
         sample_rate ||= @default_sample_rate
-        return StatsD::Instrument::VOID unless sample?(sample_rate)
-
-        emit(datagram_builder(no_prefix: no_prefix).ms(name, value, sample_rate, tags))
+        if sample_rate.nil? || sample?(sample_rate)
+          emit(datagram_builder(no_prefix: no_prefix).ms(name, value, sample_rate, tags))
+        end
+        StatsD::Instrument::VOID
       end
 
       # Emits a gauge metric.
@@ -237,9 +241,10 @@ module StatsD
       # @return [void]
       def gauge(name, value, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
-        return StatsD::Instrument::VOID unless sample?(sample_rate)
-
-        emit(datagram_builder(no_prefix: no_prefix).g(name, value, sample_rate, tags))
+        if sample_rate.nil? || sample?(sample_rate)
+          emit(datagram_builder(no_prefix: no_prefix).g(name, value, sample_rate, tags))
+        end
+        StatsD::Instrument::VOID
       end
 
       # Emits a set metric, which counts distinct values.
@@ -251,9 +256,10 @@ module StatsD
       # @return [void]
       def set(name, value, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
-        return StatsD::Instrument::VOID unless sample?(sample_rate)
-
-        emit(datagram_builder(no_prefix: no_prefix).s(name, value, sample_rate, tags))
+        if sample_rate.nil? || sample?(sample_rate)
+          emit(datagram_builder(no_prefix: no_prefix).s(name, value, sample_rate, tags))
+        end
+        StatsD::Instrument::VOID
       end
 
       # Emits a distribution metric, which builds a histogram of the reported
@@ -274,9 +280,10 @@ module StatsD
         end
 
         sample_rate ||= @default_sample_rate
-        return StatsD::Instrument::VOID unless sample?(sample_rate)
-
-        emit(datagram_builder(no_prefix: no_prefix).d(name, value, sample_rate, tags))
+        if sample_rate.nil? || sample?(sample_rate)
+          emit(datagram_builder(no_prefix: no_prefix).d(name, value, sample_rate, tags))
+        end
+        StatsD::Instrument::VOID
       end
 
       # Emits a histogram metric, which builds a histogram of the reported values.
@@ -292,9 +299,10 @@ module StatsD
       # @return [void]
       def histogram(name, value, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
-        return StatsD::Instrument::VOID unless sample?(sample_rate)
-
-        emit(datagram_builder(no_prefix: no_prefix).h(name, value, sample_rate, tags))
+        if sample_rate.nil? || sample?(sample_rate)
+          emit(datagram_builder(no_prefix: no_prefix).h(name, value, sample_rate, tags))
+        end
+        StatsD::Instrument::VOID
       end
 
       # @!endgroup
@@ -317,7 +325,7 @@ module StatsD
           stop = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
 
           sample_rate ||= @default_sample_rate
-          if sample?(sample_rate)
+          if sample_rate.nil? || sample?(sample_rate)
             metric_type ||= datagram_builder(no_prefix: no_prefix).latency_metric_type
             latency_in_ms = stop - start
             emit(datagram_builder(no_prefix: no_prefix).send(metric_type, name, latency_in_ms, sample_rate, tags))

data/lib/statsd/instrument/datagram_builder.rb

@@ -20,8 +20,8 @@ module StatsD
       end
 
       def initialize(prefix: nil, default_tags: nil)
-        @prefix = prefix.nil? ? "" : "#{normalize_name(prefix)}."
-        @default_tags = normalize_tags(default_tags)
+        @prefix = prefix.nil? ? "" : "#{prefix}.".tr(":|@", "_")
+        @default_tags = default_tags.nil? || default_tags.empty? ? nil : compile_tags(default_tags, "|#".b)
       end
 
       def c(name, value, sample_rate, tags)
@@ -58,26 +58,6 @@ module StatsD
 
       protected
 
-      attr_reader :prefix, :default_tags
-
-      # Utility function to convert tags to the canonical form.
-      #
-      # - Tags specified as key value pairs will be converted into an array
-      # - Tags are normalized to remove unsupported characters
-      #
-      # @param tags [Array<String>, Hash<String, String>, nil] Tags specified in any form.
-      # @return [Array<String>, nil] the list of tags in canonical form.
-      def normalize_tags(tags)
-        return [] unless tags
-
-        tags = tags.map { |k, v| "#{k}:#{v}" } if tags.is_a?(Hash)
-
-        # Fast path when no string replacement is needed
-        return tags unless tags.any? { |tag| /[|,]/.match?(tag) }
-
-        tags.map { |tag| tag.tr("|,", "") }
-      end
-
       # Utility function to remove invalid characters from a StatsD metric name
       def normalize_name(name)
         # Fast path when no normalization is needed to avoid copying the string
@@ -87,12 +67,49 @@ module StatsD
       end
 
       def generate_generic_datagram(name, value, type, sample_rate, tags)
-        tags = normalize_tags(tags) + default_tags
-        datagram = +"#{@prefix}#{normalize_name(name)}:#{value}|#{type}"
-        datagram << "|@#{sample_rate}" if sample_rate && sample_rate < 1
-        datagram << "|##{tags.join(",")}" unless tags.empty?
+        datagram = "".b <<
+          @prefix <<
+          (/[:|@]/.match?(name) ? name.tr(":|@", "_") : name) <<
+          ":" << value.to_s <<
+          "|" << type
+
+        datagram << "|@" << sample_rate.to_s if sample_rate && sample_rate < 1
+
+        unless @default_tags.nil?
+          datagram << @default_tags
+        end
+
+        unless tags.nil? || tags.empty?
+          datagram << (@default_tags.nil? ? "|#" : ",")
+          compile_tags(tags, datagram)
+        end
+
         datagram
       end
+
+      def compile_tags(tags, buffer = "".b)
+        if tags.is_a?(Hash)
+          first = true
+          tags.each do |key, value|
+            if first
+              first = false
+            else
+              buffer << ","
+            end
+            key = key.to_s
+            key = key.tr("|,", "") if /[|,]/.match?(key)
+            value = value.to_s
+            value = value.tr("|,", "") if /[|,]/.match?(value)
+            buffer << key << ":" << value
+          end
+        else
+          if tags.any? { |tag| /[|,]/.match?(tag) }
+            tags = tags.map { |tag| tag.tr("|,", "") }
+          end
+          buffer << tags.join(",")
+        end
+        buffer
+      end
     end
   end
 end

data/lib/statsd/instrument/dogstatsd_datagram_builder.rb

@@ -36,7 +36,6 @@ module StatsD
 
         escaped_title = "#{@prefix}#{title}".gsub("\n", '\n')
         escaped_text = text.gsub("\n", '\n')
-        tags = normalize_tags(tags) + default_tags
 
         datagram = +"_e{#{escaped_title.length},#{escaped_text.length}}:#{escaped_title}|#{escaped_text}"
         datagram << "|h:#{hostname}" if hostname
@@ -45,7 +44,16 @@ module StatsD
         datagram << "|p:#{priority}" if priority
         datagram << "|s:#{source_type_name}" if source_type_name
         datagram << "|t:#{alert_type}" if alert_type
-        datagram << "|##{tags.join(",")}" unless tags.empty?
+
+        unless @default_tags.nil?
+          datagram << @default_tags
+        end
+
+        unless tags.nil? || tags.empty?
+          datagram << (@default_tags.nil? ? "|#" : ",")
+          compile_tags(tags, datagram)
+        end
+
         datagram
       end
 
@@ -63,12 +71,20 @@ module StatsD
       # @see https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/#service-checks
       def _sc(name, status, timestamp: nil, hostname: nil, tags: nil, message: nil)
         status_number = status.is_a?(Integer) ? status : SERVICE_CHECK_STATUS_VALUES.fetch(status.to_sym)
-        tags = normalize_tags(tags) + default_tags
 
         datagram = +"_sc|#{@prefix}#{normalize_name(name)}|#{status_number}"
         datagram << "|h:#{hostname}" if hostname
         datagram << "|d:#{timestamp.to_i}" if timestamp
-        datagram << "|##{tags.join(",")}" unless tags.empty?
+
+        unless @default_tags.nil?
+          datagram << @default_tags
+        end
+
+        unless tags.nil? || tags.empty?
+          datagram << (@default_tags.nil? ? "|#" : ",")
+          compile_tags(tags, datagram)
+        end
+
         datagram << "|m:#{normalize_name(message)}" if message
         datagram
       end

data/lib/statsd/instrument/statsd_datagram_builder.rb

@@ -9,10 +9,8 @@ module StatsD
 
       protected
 
-      def normalize_tags(tags)
-        raise NotImplementedError, "#{self.class.name} does not support tags" if tags
-
-        super
+      def compile_tags(*)
+        raise NotImplementedError, "#{self.class.name} does not support tags"
       end
     end
   end

data/lib/statsd/instrument/version.rb

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

data/test/client_test.rb

@@ -206,7 +206,7 @@ class ClientTest < Minitest::Test
     mock_sink.stubs(:sample?).returns(false, true, false, false, true)
     mock_sink.expects(:<<).twice
 
-    client = StatsD::Instrument::Client.new(sink: mock_sink)
+    client = StatsD::Instrument::Client.new(sink: mock_sink, default_sample_rate: 0.5)
     5.times { client.increment("metric") }
   end
 

data/test/datagram_builder_test.rb

@@ -14,17 +14,17 @@ class DatagramBuilderTest < Minitest::Test
     assert_equal("fo_o", @datagram_builder.send(:normalize_name, "fo:o"))
   end
 
-  def test_normalize_unsupported_tag_names
-    assert_equal(["ign#ored"], @datagram_builder.send(:normalize_tags, ["ign#o|re,d"]))
+  def test_compile_unsupported_tag_names
+    assert_equal("ign#ored", @datagram_builder.send(:compile_tags, ["ign#o|re,d"]))
     # NOTE: how this is interpreted by the backend is undefined.
     # We rely on the user to not do stuff like this if they don't want to be surprised.
     # We do not want to take the performance hit of normalizing this.
-    assert_equal(["lol::class:omg::lol"], @datagram_builder.send(:normalize_tags, "lol::class" => "omg::lol"))
+    assert_equal("lol::class:omg::lol", @datagram_builder.send(:compile_tags, { "lol::class" => "omg::lol" }))
   end
 
-  def test_normalize_tags_converts_hash_to_array
-    assert_equal(["tag:value"], @datagram_builder.send(:normalize_tags, tag: "value"))
-    assert_equal(["tag1:v1", "tag2:v2"], @datagram_builder.send(:normalize_tags, tag1: "v1", tag2: "v2"))
+  def test_compile_tags_converts_hash_to_array
+    assert_equal("tag:value", @datagram_builder.send(:compile_tags, { tag: "value" }))
+    assert_equal("tag1:v1,tag2:v2", @datagram_builder.send(:compile_tags, { tag1: "v1", tag2: "v2" }))
   end
 
   def test_c
@@ -76,6 +76,12 @@ class DatagramBuilderTest < Minitest::Test
   end
 
   def test_tags
+    datagram = @datagram_builder.d("foo", 10, nil, {})
+    assert_equal("foo:10|d", datagram)
+
+    datagram = @datagram_builder.d("foo", 10, nil, [])
+    assert_equal("foo:10|d", datagram)
+
     datagram = @datagram_builder.d("foo", 10, nil, ["foo", "bar"])
     assert_equal("foo:10|d|#foo,bar", datagram)
 
@@ -103,7 +109,7 @@ class DatagramBuilderTest < Minitest::Test
     assert_equal("bar:1|c|#foo", datagram)
 
     datagram = datagram_builder.c("bar", 1, nil, a: "b")
-    assert_equal("bar:1|c|#a:b,foo", datagram)
+    assert_equal("bar:1|c|#foo,a:b", datagram)
 
     # We do not filter out duplicates, because detecting dupes is too time consuming.
     # We let the server deal with the situation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.5.12
+  version: 3.6.1
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2023-11-06 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.18
+rubygems_version: 3.4.21
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps