puma-plugin-statsd 1.2.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb512a32b788a2df3fc7f9f222e7dcb510fdbda09bb1bb278466978d2f5b511d
-  data.tar.gz: 6274f07b78d32a6bddbc5d6d823114f6171df7fb3131186e35fbdd9416244ce1
+  metadata.gz: 359b3281a2ce1173373bba01c4ca0981772d63af2719daead709efb87b0f19bd
+  data.tar.gz: 2b11561ad00b73a80c8cea674fad5bce390a9e384169f68bb77f0445b006d8b0
 SHA512:
-  metadata.gz: c568951db0c140e934d4cd40103c8b98160da02aeeda6b2549dd59a415ee2ee59ea171f6d818150fdbb66c99b88a912690c31f9bc3bc0715dc7478440136e76a
-  data.tar.gz: 2af0724eb7a83bae47caed6c3009a5fa5ed2d0ab98b2c98be250c03636750bdf48788f69fe8bd04fb83a7656fb15174ab356edd0581eed072e780b4fa0855aa8
+  metadata.gz: 8c5da2367dfa0d796258d9d8ecda4a70d4225946669e4ad30aefd4196c86f3b03f3fd99894dc5cbc55afede49b2559bbaac5217f4b9b97622ab0c4105dd0d5f5
+  data.tar.gz: be824e394c2b04ad4f6e80a32db242e2a3e74db512b8ec3720a41a1e3ba1ca45dd2e0221a951b71f8c6e2c8a90e2fc03b63dd865e0f63978c5f1b4eb9ff816b1

data/CHANGELOG.md

@@ -1,12 +1,26 @@
 # CHANGELOG
 
+## 2.2.0 2022-07-31
+
+* Support communicating with the Datadog agent via a UNIX socket (set STATSD_SOCKET_PATH env var) (PR #[38](https://github.com/yob/puma-plugin-statsd/pull/38))
+
+## 2.1.0 2021-12-04
+
+* Adds support for Datadog unified service tagging (env, service, version) (PR #[37](https://github.com/yob/puma-plugin-statsd/pull/37))
+
+## 2.0.0 2021-07-27
+
+* Require puma 5 or better
+* Split DD_TAGS environment variable by commas or spaces (PR #[31](https://github.com/yob/puma-plugin-statsd/pull/31))
+* Gracefully handle unexpected errors when submitting to statsd (like DNS resolution failures) (PR #[35](https://github.com/yob/puma-plugin-statsd/pull/35))
+
 ## 1.2.1 2021-01-11
 
 * Remove json from the gemspec
 
 ## 1.2.0 2021-01-07
 
-* New metrics: old_workers (PR #[21](https://github.com/yob/puma-plugin-statsd/pull/21)) and requsts_count (PR #[28](https://github.com/yob/puma-plugin-statsd/pull/28))
+* New metrics: old_workers (PR #[21](https://github.com/yob/puma-plugin-statsd/pull/21)) and requests_count (PR #[28](https://github.com/yob/puma-plugin-statsd/pull/28))
 * Require json at runtime to be extra sure we don't load the wrong version before bundler has initialised the LOAD_PATH
 
 ## 1.1.0 2021-01-03

data/README.md

@@ -1,6 +1,6 @@
 # Puma Statsd Plugin
 
-[Puma][puma] integration with [statsd](statsd) for easy tracking of key metrics
+[Puma][puma] integration with [statsd][statsd] for easy tracking of key metrics
 that puma can provide:
 
 * puma.workers
@@ -9,6 +9,8 @@ that puma can provide:
 * puma.backlog
 * puma.pool_capacity
 * puma.max_threads
+* puma.old_workers
+* puma.requests_count
 
   [puma]: https://github.com/puma/puma
   [statsd]: https://github.com/etsy/statsd
@@ -108,9 +110,17 @@ https://github.com/yob/puma-plugin-statsd.
 
 ## Testing the data being sent to statsd
 
-Start a pretend statsd server that listens for UDP packets on port 8125:
+Start a pretend statsd server that listens for UDP packets on port 8125.
 
-    ruby devtools/statsd-to-stdout.rb
+If you've installed the gem in your app:
+
+    # only need to install the binstub once
+    bundle binstubs puma-plugin-statsd
+    ./bin/statsd-to-stdout
+
+If you are developing/testing this gem locally:
+
+    ./bin/statsd-to-stdout
 
 Start puma:
 

data/bin/statsd-to-stdout

@@ -0,0 +1,15 @@
+#! /usr/bin/env ruby
+# encoding: utf-8
+
+RECV_BUFFER = 64*1024
+
+require 'socket'
+server = UDPSocket.new
+host, port = "127.0.0.1", 8125
+server.bind(host, port)
+
+while true
+  text, sender = server.recvfrom(RECV_BUFFER)
+  remote_host = sender[3]
+  STDOUT.puts "#{remote_host}:" + text
+end

data/lib/puma/plugin/statsd.rb

@@ -13,14 +13,21 @@ class StatsdConnector
   def initialize
     @host = ENV.fetch(ENV_NAME, "127.0.0.1")
     @port = ENV.fetch("STATSD_PORT", 8125)
+    @socket_path = ENV.fetch("STATSD_SOCKET_PATH", nil)
   end
 
   def send(metric_name:, value:, type:, tags: nil)
     data = "#{metric_name}:#{value}|#{STATSD_TYPES.fetch(type)}"
     data = "#{data}|##{tags}" unless tags.nil?
 
-    socket = UDPSocket.new
-    socket.send(data, 0, host, port)
+    if @socket_path
+      socket = Socket.new(Socket::AF_UNIX, Socket::SOCK_DGRAM)
+      socket.connect(Socket.pack_sockaddr_un(@socket_path))
+      socket.sendmsg_nonblock(data)
+    else
+      socket = UDPSocket.new
+      socket.send(data, 0, host, port)
+    end
   ensure
     socket.close
   end
@@ -112,18 +119,6 @@ Puma::Plugin.create do
     in_background(&method(:stats_loop))
   end
 
-  if Puma.respond_to?(:stats_hash)
-    def fetch_stats
-      Puma.stats_hash
-    end
-  else
-    def fetch_stats
-      require "json"
-      stats = Puma.stats
-      JSON.parse(stats, symbolize_names: true)
-    end
-  end
-
   def environment_variable_tags
     # Tags are separated by spaces, and while they are normally a tag and
     # value separated by a ':', they can also just be tagged without any
@@ -147,11 +142,27 @@ Puma::Plugin.create do
     # https://docs.datadoghq.com/agent/docker/?tab=standard#global-options
     #
     if ENV.has_key?("DD_TAGS")
-      ENV["DD_TAGS"].split(/\s+/).each do |t|
+      ENV["DD_TAGS"].split(/\s+|,/).each do |t|
         tags << t
       end
     end
 
+    # Support the Unified Service Tagging from Datadog, so that we can share
+    # the metric tags with the application running
+    #
+    # https://docs.datadoghq.com/getting_started/tagging/unified_service_tagging
+    if ENV.has_key?("DD_ENV")
+      tags << "env:#{ENV["DD_ENV"]}"
+    end
+
+    if ENV.has_key?("DD_SERVICE")
+      tags << "service:#{ENV["DD_SERVICE"]}"
+    end
+
+    if ENV.has_key?("DD_VERSION")
+      tags << "version:#{ENV["DD_VERSION"]}"
+    end
+
     # Return nil if we have no environment variable tags. This way we don't
     # send an unnecessary '|' on the end of each stat
     return nil if tags.empty?
@@ -171,7 +182,7 @@ Puma::Plugin.create do
     loop do
       @launcher.events.debug "statsd: notify statsd"
       begin
-        stats = ::PumaStats.new(fetch_stats)
+        stats = ::PumaStats.new(Puma.stats_hash)
         @statsd.send(metric_name: prefixed_metric_name("puma.workers"), value: stats.workers, type: :gauge, tags: tags)
         @statsd.send(metric_name: prefixed_metric_name("puma.booted_workers"), value: stats.booted_workers, type: :gauge, tags: tags)
         @statsd.send(metric_name: prefixed_metric_name("puma.old_workers"), value: stats.old_workers, type: :gauge, tags: tags)
@@ -181,7 +192,7 @@ Puma::Plugin.create do
         @statsd.send(metric_name: prefixed_metric_name("puma.max_threads"), value: stats.max_threads, type: :gauge, tags: tags)
         @statsd.send(metric_name: prefixed_metric_name("puma.requests_count"), value: stats.requests_count, type: :gauge, tags: tags)
       rescue StandardError => e
-        @launcher.events.error "! statsd: notify stats failed:\n  #{e.to_s}\n  #{e.backtrace.join("\n    ")}"
+        @launcher.events.unknown_error e, nil, "! statsd: notify stats failed"
       ensure
         sleep 2
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-plugin-statsd
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.2.0
 platform: ruby
 authors:
 - James Healy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -100,21 +100,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: james@yob.id.au
-executables: []
+executables:
+- statsd-to-stdout
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
+- bin/statsd-to-stdout
 - lib/puma/plugin/statsd.rb
 homepage: https://github.com/yob/puma-plugin-statsd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Send puma metrics to statsd via a background thread
 test_files: []