puma-plugin-statsd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e2328d05d42da5a0259a1db34e06d577b80640c055601c4689581a9ffdc3d66
-  data.tar.gz: e69455947064fb8fd3ce30af4d5a97853e0511f0998d11f424924b0fcfe2452f
+  metadata.gz: c327637905c572e3ed22e9936b440597f77d032abe2b155e73776bd845c9588c
+  data.tar.gz: 5e57068f3dfaa9a5f9334825ff5bf7493a8286a2b46feb6da5b9fca36e605a92
 SHA512:
-  metadata.gz: 885de8a9ccc13c7f1bb95fe160b18c27e204fe71d68fc13e75024cba27ff83f235b1a7876e4b37bb3482987583962eccf7d2cef3d051fba3b48a7c452145bfce
-  data.tar.gz: 7560d10e03f50ad938408e735026ecec85b8542c79a3e394d1cc8c5250521875c16b5e56e6401776262a6e2ea9aeaafb3b589792b49562c92b0744044a3f8392
+  metadata.gz: 7b5cd14ef13b733fe0488cb61dd63a74811566a467d45ec7f9a661515a61cd7b7a0cde4e4ff1e4f71f64d5f52e7c76a5a52e4addbc7085ec7159c90e88e62231
+  data.tar.gz: 91c439d68efdf850d777bc380ee9ef3ca3c1233d04bb8891c1a204bbd038ff75f436c7bf3fb09caf8fa4576fed37385979aa94cd39f9288125c7d2eeccd7f1c2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.0 2020-02-29
+
+* Added option to prefix stats metric (via STATSD_METRIC_PREFIX env var)
+
 ## 0.1.0 2019-07-06
 
 * The statsd port is now configurable

data/lib/puma/plugin/statsd.rb

@@ -7,6 +7,7 @@ require 'socket'
 class StatsdConnector
   ENV_NAME = "STATSD_HOST"
   STATSD_TYPES = { count: 'c', gauge: 'g' }
+  METRIC_DELIMETER = ".".freeze
 
   attr_reader :host, :port
 
@@ -40,46 +41,46 @@ class PumaStats
   end
 
   def clustered?
-    @stats.has_key? "workers"
+    @stats.has_key?(:workers)
   end
 
   def workers
-    @stats.fetch("workers", 1)
+    @stats.fetch(:workers, 1)
   end
 
   def booted_workers
-    @stats.fetch("booted_workers", 1)
+    @stats.fetch(:booted_workers, 1)
   end
 
   def running
     if clustered?
-      @stats["worker_status"].map { |s| s["last_status"].fetch("running", 0) }.inject(0, &:+)
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:running, 0) }.inject(0, &:+)
     else
-      @stats.fetch("running", 0)
+      @stats.fetch(:running, 0)
     end
   end
 
   def backlog
     if clustered?
-      @stats["worker_status"].map { |s| s["last_status"].fetch("backlog", 0) }.inject(0, &:+)
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:backlog, 0) }.inject(0, &:+)
     else
-      @stats.fetch("backlog", 0)
+      @stats.fetch(:backlog, 0)
     end
   end
 
   def pool_capacity
     if clustered?
-      @stats["worker_status"].map { |s| s["last_status"].fetch("pool_capacity", 0) }.inject(0, &:+)
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:pool_capacity, 0) }.inject(0, &:+)
     else
-      @stats.fetch("pool_capacity", 0)
+      @stats.fetch(:pool_capacity, 0)
     end
   end
 
   def max_threads
     if clustered?
-      @stats["worker_status"].map { |s| s["last_status"].fetch("max_threads", 0) }.inject(0, &:+)
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:max_threads, 0) }.inject(0, &:+)
     else
-      @stats.fetch("max_threads", 0)
+      @stats.fetch(:max_threads, 0)
     end
   end
 end
@@ -97,6 +98,13 @@ Puma::Plugin.create do
     @statsd = ::StatsdConnector.new
     if @statsd.enabled?
       @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)"
@@ -110,7 +118,7 @@ Puma::Plugin.create do
   end
 
   def fetch_stats
-    JSON.parse(Puma.stats)
+    JSON.parse(Puma.stats, symbolize_names: true)
   end
 
   def tags
@@ -124,6 +132,10 @@ Puma::Plugin.create do
     tags
   end
 
+  def prefixed_metric_name(puma_metric)
+    "#{@metric_prefix}#{puma_metric}"
+  end
+
   # Send data to statsd every few seconds
   def stats_loop
     sleep 5
@@ -131,12 +143,12 @@ Puma::Plugin.create do
       @launcher.events.debug "statsd: notify statsd"
       begin
         stats = ::PumaStats.new(fetch_stats)
-        @statsd.send(metric_name: "puma.workers", value: stats.workers, type: :gauge, tags: tags)
-        @statsd.send(metric_name: "puma.booted_workers", value: stats.booted_workers, type: :gauge, tags: tags)
-        @statsd.send(metric_name: "puma.running", value: stats.running, type: :gauge, tags: tags)
-        @statsd.send(metric_name: "puma.backlog", value: stats.backlog, type: :gauge, tags: tags)
-        @statsd.send(metric_name: "puma.pool_capacity", value: stats.pool_capacity, type: :gauge, tags: tags)
-        @statsd.send(metric_name: "puma.max_threads", value: stats.max_threads, type: :gauge, tags: tags)
+        @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.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)
       rescue StandardError => e
         @launcher.events.error "! statsd: notify stats failed:\n  #{e.to_s}\n  #{e.backtrace.join("\n    ")}"
       ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-plugin-statsd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-06 00:00:00.000000000 Z
+date: 2020-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Send puma metrics to statsd via a background thread