inst_statsd 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57fa28e5cb8fa8bc63d35ca8233d41b3f79f58107c266b708f7d9c60e38d7f81
-  data.tar.gz: 45e23f3284b62308099fb6ab7167ef7036d4bbc4a87fb32dcf70a1bd246674b6
+  metadata.gz: 705acd8e1a6b843e6f4e54ec0e1525f1165022547c22649d4b0c60c2c1fc83fa
+  data.tar.gz: 1d0daad7330f761a6ea4642bd52c85a0a4bf5a6856e7bd967750670a7f08832e
 SHA512:
-  metadata.gz: 79d3b39e1de95726c07a623f2d317fa512f9d3fee346afbc26b1ec8435919783a46887292e54777a9e7ee19ca51314aa8e703729fa5bc5fc45bef121eebffe56
-  data.tar.gz: 3de309abbcc308546567c280c98c910b34cece7dd27dad1cea4911e3b5f7fb263a997f26128bfa1541ae5d23e87c93f36da98b8c13790c42734980444446f42a
+  metadata.gz: 1a23712f36838b2fd9afd2fe15430c9239e14b212aa6a05ed3358c81ff9799a2d11345dc1170915de903d6a73eed0a0dce05c183c75661693296ab5511b2cdb8
+  data.tar.gz: d5a2406ba15f33196527a9d24cb7d52d6eb5d0aea387f7a80d9382e389777e0c375473d50282af0841f9832adc8f27d8c89b3f07c249764de3170aa8b033303e

data/lib/inst_statsd/distribution.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module InstStatsd
+  # Mix-in methods for supporting DataDog events
+  # See https://docs.datadoghq.com/metrics/types/?tab=distribution#metric-types
+  module Distribution
+    # Sends a distribution metric to DataDog if the instance and DataDog are configured.
+    #
+    # Distributions are aggregated globally and are appropriate when a metric sourced from
+    # multiple hosts need to be considered in a global statistical distribution.
+    #
+    # @param metric [String] The name of the metric to send.
+    # @param value [Numeric] The value of the metric.
+    # @param tags [Hash] Optional tags to associate with the metric. Defaults to an empty hash.
+    #
+    # @example Record an error occurrence:
+    #   InstStatsd::Statsd.distribution('client.request.failed', 1, tags: { status: '500' })
+    def distribution(metric, value, tags: {})
+      return unless instance && data_dog?
+
+      instance.distribution(metric, value, { tags: tags.merge(dog_tags) }.compact)
+    end
+
+    # Increments the specified distribution metric by 1.
+    #
+    # @param metric [String] The name of the metric to increment.
+    # @param tags [Hash] Optional tags to associate with the metric.
+    #
+    # @example Increment the error count:
+    #  InstStatsd::Statsd.distributed_increment('client.request.failed', tags: { status: '500' })
+    def distributed_increment(metric, tags: {})
+      distribution(metric, 1, tags: tags)
+    end
+  end
+end

data/lib/inst_statsd/statsd.rb

@@ -29,6 +29,7 @@
 module InstStatsd
   module Statsd
     extend InstStatsd::Event
+    extend InstStatsd::Distribution
 
     # replace "." in key names with another character to avoid creating spurious sub-folders in graphite
     def self.escape(str, replacement = "_")

data/lib/inst_statsd/version.rb

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

data/lib/inst_statsd.rb

@@ -16,6 +16,7 @@ module InstStatsd
 
   class ConfigurationError < StandardError; end
 
+  require "inst_statsd/distribution"
   require "inst_statsd/event"
   require "inst_statsd/statsd"
   require "inst_statsd/block_stat"

data/spec/inst_statsd/distribution_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "datadog/statsd"
+
+RSpec.describe InstStatsd::Distribution do
+  describe ".distribution" do
+    subject { InstStatsd::Statsd.distribution(metric, value, tags: tags) }
+
+    let(:instance) { instance_double(Datadog::Statsd) }
+
+    let(:metric) { "client.request.failed" }
+    let(:value) { 23 }
+    let(:tags) { { status: "500" } }
+
+    before do
+      allow(InstStatsd::Statsd).to receive_messages(data_dog?: is_datadog, dog_tags: dog_tags, instance: instance)
+    end
+
+    context "when instance and data_dog? are configured" do
+      let(:dog_tags) { { environment: "production" } }
+      let(:is_datadog) { true }
+
+      it 'invokes "distribution" on the instance with metric, value, and tags' do
+        expect(instance).to receive(:distribution).with(
+          metric,
+          value,
+          { tags: { status: "500", environment: "production" } }
+        )
+
+        subject
+      end
+    end
+
+    context "when instance and data_dog? are not configured" do
+      let(:dog_tags) { {} }
+      let(:is_datadog) { false }
+
+      it "does nothing" do
+        expect(instance).not_to receive(:distribution)
+
+        subject
+      end
+    end
+  end
+
+  describe ".distributed_increment" do
+    subject { InstStatsd::Statsd.distributed_increment(metric, tags: tags) }
+
+    let(:metric) { "client.request.failed" }
+    let(:tags) { { status: "500" } }
+
+    before do
+      allow(InstStatsd::Statsd).to receive_messages(distribution: nil)
+    end
+
+    it 'invokes "distribution" on InstStatsd::Statsd with metric, 1, and tags' do
+      expect(InstStatsd::Statsd).to receive(:distribution).with(metric, 1, tags: tags)
+
+      subject
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inst_statsd
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Nick Cloward
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aroi
@@ -176,6 +176,7 @@ files:
 - lib/inst_statsd/block_tracking.rb
 - lib/inst_statsd/counter.rb
 - lib/inst_statsd/default_tracking.rb
+- lib/inst_statsd/distribution.rb
 - lib/inst_statsd/event.rb
 - lib/inst_statsd/null_logger.rb
 - lib/inst_statsd/request_logger.rb
@@ -187,6 +188,7 @@ files:
 - spec/inst_statsd/block_stat_spec.rb
 - spec/inst_statsd/block_tracking_spec.rb
 - spec/inst_statsd/counter_spec.rb
+- spec/inst_statsd/distribution_spec.rb
 - spec/inst_statsd/event_spec.rb
 - spec/inst_statsd/inst_statsd_spec.rb
 - spec/inst_statsd/null_logger_spec.rb