puma-plugin-statsd 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b91a8a6e85cc308cb83a047ddbf958a2529363433689f3b7a407658982c9aa
-  data.tar.gz: d62ab03d1fe3c20dc13a395ba84fa5fe035183f17dec401a85217a20221a43b5
+  metadata.gz: 1ac5651e242dcf306ed0c5964de2c7178a142e9555333cfd203e043dada926a6
+  data.tar.gz: 9cc7a3b70cdcda54a824ca4d9b65714c16f7b20834bb348182eb787820b5e5e1
 SHA512:
-  metadata.gz: '09e931680b3c4280e1764fc9738ab69e7b0af6c0705eb02d52edc6ba9df69d227293075d77abbedb8e794337e99ae3d048abe8f76413ec9ed02a7c526494fe3c'
-  data.tar.gz: 6eb107be17c9b457dc0c7bb900867dab42dcd50fd49e27df919e6268e648a6a0c858a422f9545d9280e001f825db0ceb0eae4a333b705adc5ccb5b3c25f4b0e8
+  metadata.gz: 1222d6580444972583bec535348958301a8c5aa4860d08e87bb1e735fc09d9b2764a38b4c3b9aa355878b9080ca30ef80b413c55c0f8f4b97edf750515162a89
+  data.tar.gz: 07e8987c8ce8f8f3db573241f824c80224aec9ffa2f5b1e8bbd474105981d6529c0c1a4a870995622f62c9edad1181aaced6c3382b8746aebf9149f51d0842c9

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGELOG
 
+## 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 unexpecte 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 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
+
+* Assume localhost for statsd host (PR #[20](https://github.com/yob/puma-plugin-statsd/pull/20))
+
 ## 1.0.0 2020-11-03
 
 * Added option to specify arbitrary datadog tags (PR #[18](https://github.com/yob/puma-plugin-statsd/pull/18))

data/README.md

@@ -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
@@ -37,12 +39,14 @@ plugin :statsd
 
 ## Usage
 
-Ensure you have an environment variable set that points to a statsd host, then boot your puma app as usual.  Optionally you may specify a port (default is 8125).
+By default the plugin assumes statsd is available at 127.0.0.1. If that's true in your environment, just start puma like normal:
 
 ```
-STATSD_HOST=127.0.0.1 bundle exec puma
+bundle exec puma
 ```
 
+If statsd isn't on 127.0.0.1 or the port is non-standard, you can configure them using optional environment variables:
+
 ```
 STATSD_HOST=127.0.0.1 STATSD_PORT=9125 bundle exec puma
 ```
@@ -55,7 +59,6 @@ the datadog "dogstatsd" server.
 Should you be reporting the puma metrics to a dogstatsd server, you can set
 tags via the following three environment variables.
 
-
 #### DD_TAGS
 
 `DD_TAGS`: Set this to a space-separated list of tags, using the
@@ -107,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.
+
+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:
 
-    ruby devtools/statsd-to-stdout.rb
+    ./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

@@ -1,5 +1,4 @@
 # coding: utf-8, frozen_string_literal: true
-require "json"
 require "puma"
 require "puma/plugin"
 require 'socket'
@@ -12,14 +11,10 @@ class StatsdConnector
   attr_reader :host, :port
 
   def initialize
-    @host = ENV.fetch(ENV_NAME, nil)
+    @host = ENV.fetch(ENV_NAME, "127.0.0.1")
     @port = ENV.fetch("STATSD_PORT", 8125)
   end
 
-  def enabled?
-    !!host
-  end
-
   def send(metric_name:, value:, type:, tags: nil)
     data = "#{metric_name}:#{value}|#{STATSD_TYPES.fetch(type)}"
     data = "#{data}|##{tags}" unless tags.nil?
@@ -49,6 +44,10 @@ class PumaStats
     @stats.fetch(:booted_workers, 1)
   end
 
+  def old_workers
+    @stats.fetch(:old_workers, 0)
+  end
+
   def running
     if clustered?
       @stats[:worker_status].map { |s| s[:last_status].fetch(:running, 0) }.inject(0, &:+)
@@ -80,6 +79,14 @@ class PumaStats
       @stats.fetch(:max_threads, 0)
     end
   end
+
+  def requests_count
+    if clustered?
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:requests_count, 0) }.inject(0, &:+)
+    else
+      @stats.fetch(:requests_count, 0)
+    end
+  end
 end
 
 Puma::Plugin.create do
@@ -88,19 +95,15 @@ Puma::Plugin.create do
     @launcher = launcher
 
     @statsd = ::StatsdConnector.new
-    if @statsd.enabled?
-      @launcher.events.debug "statsd: enabled (host: #{@statsd.host})"
+    @launcher.events.debug "statsd: enabled (host: #{@statsd.host})"
 
-      # Fetch global metric prefix from env variable
-      @metric_prefix = ENV.fetch("STATSD_METRIC_PREFIX", nil)
-      if @metric_prefix && !@metric_prefix.end_with?(::StatsdConnector::METRIC_DELIMETER)
-        @metric_prefix += ::StatsdConnector::METRIC_DELIMETER
-      end
-
-      register_hooks
-    else
-      @launcher.events.debug "statsd: not enabled (no #{StatsdConnector::ENV_NAME} env var found)"
+    # Fetch global metric prefix from env variable
+    @metric_prefix = ENV.fetch("STATSD_METRIC_PREFIX", nil)
+    if @metric_prefix && !@metric_prefix.end_with?(::StatsdConnector::METRIC_DELIMETER)
+      @metric_prefix += ::StatsdConnector::METRIC_DELIMETER
     end
+
+    register_hooks
   end
 
   private
@@ -109,17 +112,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
-      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
@@ -143,7 +135,7 @@ 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
@@ -167,15 +159,17 @@ 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)
         @statsd.send(metric_name: prefixed_metric_name("puma.running"), value: stats.running, type: :gauge, tags: tags)
         @statsd.send(metric_name: prefixed_metric_name("puma.backlog"), value: stats.backlog, type: :gauge, tags: tags)
         @statsd.send(metric_name: prefixed_metric_name("puma.pool_capacity"), value: stats.pool_capacity, type: :gauge, tags: tags)
         @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.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-07-27 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,24 +26,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -116,13 +102,15 @@ dependencies:
         version: '0'
 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: