inst_statsd 3.3.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97f7ba19c16e12f36248b86629b16fb1bc2216ba0da3c3ff1da012c08582ee2
-  data.tar.gz: d7f43c64a477c5e6bf733ede3185b54a692e26440e1ba340886ac6c524f9da5d
+  metadata.gz: a043204eb3317894fc4af36b78cff6b0880ac5e1338d9c0959c6628841c87185
+  data.tar.gz: f8d212ea7b2a3b70a96fd72e6c280a3d1a8b309148ce0517efee208f65e10276
 SHA512:
-  metadata.gz: 825783ba4ef42ff8abc7b97d3a8a387be9c93c30e9b746482c119a905c74de57341ab38d32723bb37e2d28d5b5cbc33bde84e531eaa04067138d96b7b8f1b492
-  data.tar.gz: 45a3cfbc0e101a1dfdc758155290dbfca30f1c89832b73a6e376010ba8aaecdea55ebca764c023adfbdd4150bf120ca0f2e82eda6ba631d245cead49a25b9850
+  metadata.gz: 4c9cbb244b6c2c4d26132a4099b91de59986c66897f832a8ed0c4bcddca1566cc0f842527d0126f4f36bf35cb23408a77f4b4da60e61f6f3f702a35c3a94ced7
+  data.tar.gz: afcd0952fa43d151e8ee38a5452aaa588fd07b45d5ff5dd3cdd92ae3c6d027c2501623875f7f3cef168ddcbab9ecac510f00c3df0dbb99033e0bbc53a97d3848

data/lib/inst_statsd/distribution.rb

@@ -18,12 +18,8 @@ module InstStatsd
     def distribution(metric, value, tags: {})
       return unless instance && data_dog?
 
-      metric = if append_hostname?
-                 "#{metric}.#{hostname}"
-               else
-                 metric.to_s
-               end
-      tags = tags.merge(dog_tags) if tags.is_a?(Hash)
+      metric = stat_name_for(metric)
+      tags = prepare_datadog_tags(tags) if data_dog?
 
       instance.distribution(metric, value, { tags: tags })
     end
@@ -37,6 +33,9 @@ module InstStatsd
     # @example Increment the error count:
     #  InstStatsd::Statsd.distributed_increment('client.request.failed', tags: { status: '500' })
     def distributed_increment(metric, tags: {}, short_stat: nil)
+      metric = stat_name_for(metric)
+      tags = prepare_datadog_tags(tags) if data_dog?
+
       # Non-Datadog clients don't support distribution metrics, so we use fall back to increment
       return increment(metric, tags: tags, short_stat: short_stat) if instance && !data_dog?
 

data/lib/inst_statsd/statsd.rb

@@ -55,17 +55,10 @@ module InstStatsd
               return                                                    #       return
             end                                                         #     end
                                                                         #
-            if self.append_hostname?                                    #     if self.append_hostname?
-              stat_name = "\#{stat}.\#{hostname}"                       #       stat_name = "\#{stat}.\#{hostname}"
-            else                                                        #     else
-              stat_name = stat.to_s                                     #       stat_name = stat.to_s
-            end                                                         #     end
+            stat_name = stat_name_for(stat)                             #     stat_name = stat_name_for(stat)
                                                                         #
             if data_dog?                                                #     if data_dog?
-              tags = tags ? tags.dup : {}                               #       tags ||= {}
-              tags.merge!(dog_tags) if tags.is_a? Hash                  #       tags.merge!(dog_tags) if tags.is_a? Hash
-              tags = convert_tags(tags)                                 #       tags = convert_tags(tags)
-              tags << 'host:' unless self.append_hostname?              #       tags << 'host:' unless self.append_hostname?
+              tags = prepare_datadog_tags(tags)                         #       tags = prepare_datadog_tags(tags)
               short_stat ||= stat_name                                  #       short_stat ||= stat_name
               opts = { tags: tags }                                     #       opts = { tags: tags }
               opts[:sample_rate] = args.pop if args.length == 2         #       opts[:sample_rate] = args.pop if args.length == 2
@@ -81,6 +74,21 @@ module InstStatsd
       RUBY
     end
 
+    def self.stat_name_for(metric)
+      return "#{metric}.#{hostname}" if append_hostname?
+
+      metric.to_s
+    end
+
+    def self.prepare_datadog_tags(tags)
+      tags = tags ? tags.dup : {}
+      tags.merge!(dog_tags) if tags.is_a? Hash
+      tags = convert_tags(tags)
+      tags << "host:" unless append_hostname?
+
+      tags
+    end
+
     def self.convert_tags(tags)
       new_tags = []
       return tags unless tags.is_a? Hash

data/lib/inst_statsd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InstStatsd
-  VERSION = "3.3.2"
+  VERSION = "3.4.0"
 end

data/spec/inst_statsd/distribution_spec.rb

@@ -5,9 +5,15 @@ require "datadog/statsd"
 
 RSpec.describe InstStatsd::Distribution do
   let(:instance) { instance_double(Datadog::Statsd) }
+  let(:append_hostname) { false }
 
   before do
-    allow(InstStatsd::Statsd).to receive_messages(data_dog?: is_datadog, dog_tags: dog_tags, instance: instance)
+    allow(InstStatsd::Statsd).to receive_messages(
+      data_dog?: is_datadog,
+      dog_tags: dog_tags,
+      instance: instance,
+      append_hostname?: append_hostname
+    )
   end
 
   describe ".distribution" do
@@ -25,7 +31,7 @@ RSpec.describe InstStatsd::Distribution do
         expect(instance).to receive(:distribution).with(
           metric,
           value,
-          { tags: { status: "500", environment: "production" } }
+          { tags: ["status:500", "environment:production", "host:"] }
         )
 
         subject
@@ -35,10 +41,38 @@ RSpec.describe InstStatsd::Distribution do
         expect(instance).to receive(:distribution).with(
           metric,
           value,
-          { tags: ["status:500"] }
+          { tags: ["status:500", "host:"] }
         )
         InstStatsd::Statsd.distribution(metric, value, tags: ["status:500"])
       end
+
+      context "when the tags are nil" do
+        let(:tags) { nil }
+
+        it "handles nil tags" do
+          expect(instance).to receive(:distribution).with(
+            metric,
+            value,
+            { tags: ["environment:production", "host:"] }
+          )
+
+          subject
+        end
+      end
+
+      context "when append_hostname? is true" do
+        let(:append_hostname) { true }
+
+        it "appends the hostname to the metric and excludes a host tag" do
+          expect(instance).to receive(:distribution).with(
+            "#{metric}.#{Socket.gethostname}",
+            value,
+            { tags: ["status:500", "environment:production"] }
+          )
+
+          subject
+        end
+      end
     end
 
     context "when instance and data_dog? are not configured" do
@@ -66,11 +100,25 @@ RSpec.describe InstStatsd::Distribution do
     end
 
     it 'invokes "distribution" on InstStatsd::Statsd with metric, 1, and tags' do
-      expect(InstStatsd::Statsd).to receive(:distribution).with(metric, 1, tags: tags)
+      expect(InstStatsd::Statsd).to receive(:distribution).with(metric, 1, tags: ["status:401", "host:"])
 
       subject
     end
 
+    context "when append_hostname? is true" do
+      let(:append_hostname) { true }
+
+      it "appends the hostname to the metric and excludes a host tag" do
+        expect(InstStatsd::Statsd).to receive(:distribution).with(
+          "#{metric}.#{Socket.gethostname}",
+          1,
+          { tags: ["status:401"] }
+        )
+
+        subject
+      end
+    end
+
     context "when the configured instance is not a DataDog instance" do
       let(:dog_tags) { {} }
       let(:is_datadog) { false }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inst_statsd
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.4.0
 platform: ruby
 authors:
 - Nick Cloward
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aroi