puma-plugin-statsd 0.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e2328d05d42da5a0259a1db34e06d577b80640c055601c4689581a9ffdc3d66
-  data.tar.gz: e69455947064fb8fd3ce30af4d5a97853e0511f0998d11f424924b0fcfe2452f
+  metadata.gz: d0b1cd40cd7e6d081b35483c8319f4b1eb3463ded57a1f015e5f78db3771f5a8
+  data.tar.gz: 8df635d04448770b411364182f7d6466f736065ce2b4f396b6daec14c2abf364
 SHA512:
-  metadata.gz: 885de8a9ccc13c7f1bb95fe160b18c27e204fe71d68fc13e75024cba27ff83f235b1a7876e4b37bb3482987583962eccf7d2cef3d051fba3b48a7c452145bfce
-  data.tar.gz: 7560d10e03f50ad938408e735026ecec85b8542c79a3e394d1cc8c5250521875c16b5e56e6401776262a6e2ea9aeaafb3b589792b49562c92b0744044a3f8392
+  metadata.gz: 892042e3683ca475e062e2439189dd9a17c3fd595eae0e86bb1f687111e6d8f158ff9d8fba034f5fabc8dd066f55289bf0dc0013e2330be59f9bcb764eacfeaa
+  data.tar.gz: e2a05da7f70a78c584f34b1b45ca3a8655f20437828be9462d0e83b87c73cb7389ad72081136929c989a34e572601d1bf0208208aa571e29794a7a4f503aab88

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## 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))
+* 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))
+
+## 0.3.0 2020-09-24
+
+* Support puma 5.x
+
+## 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/README.md

@@ -37,12 +37,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
 ```
@@ -53,9 +55,24 @@ metric tags are a non-standard addition to the statsd protocol, supported by
 the datadog "dogstatsd" server.
 
 Should you be reporting the puma metrics to a dogstatsd server, you can set
-tags via the following two environment variables.
+tags via the following three environment variables.
+
+#### DD_TAGS
+
+`DD_TAGS`: Set this to a space-separated list of tags, using the
+[datadog agent standard format](https://docs.datadoghq.com/agent/docker/?tab=standard#global-options).
+
+For example, you could set this environment variable to set three datadog tags,
+and then you can filter by in the datadog interface:
 
-`MY_POD_NAME` adds a `pod_name` tag to the metrics. The `MY_POD_NAME`
+```bash
+export DD_TAGS="env:test simple-tag-0 tag-key-1:tag-value-1"
+bundle exec rails server
+```
+
+#### MY_POD_NAME
+
+`MY_POD_NAME`: Set a `pod_name` tag to the metrics. The `MY_POD_NAME`
 environment variable is recommended in the datadog kubernetes setup
 documentation, and for puma apps deployed to kubernetes it's very helpful to
 have the option to report on specific pods.
@@ -70,7 +87,9 @@ env:
         fieldPath: metadata.name
 ```
 
-`STATSD_GROUPING` adds a `grouping` tag to the metrics, with a value equal to
+#### STATSD_GROUPING
+
+`STATSD_GROUPING`: add a `grouping` tag to the metrics, with a value equal to
 the environment variable value. This is particularly helpful in a kubernetes
 deployment where each pod has a unique name but you want the option to group
 metrics across all pods in a deployment. Setting this on the pods in a
@@ -100,7 +119,7 @@ Start puma:
 Throw some traffic at it, either with curl or a tool like ab:
 
     curl http://127.0.0.1:9292/
-    ab -n 10000 -c 20 http://127.0.0.1:9292/ 
+    ab -n 10000 -c 20 http://127.0.0.1:9292/
 
 Watch the output of the UDP server process - you should see statsd data printed to stdout.
 

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'
@@ -7,24 +6,18 @@ require 'socket'
 class StatsdConnector
   ENV_NAME = "STATSD_HOST"
   STATSD_TYPES = { count: 'c', gauge: 'g' }
+  METRIC_DELIMETER = ".".freeze
 
   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: {})
+  def send(metric_name:, value:, type:, tags: nil)
     data = "#{metric_name}:#{value}|#{STATSD_TYPES.fetch(type)}"
-    if tags.any?
-      tag_str = tags.map { |k,v| "#{k}:#{v}" }.join(",")
-      data = "#{data}|##{tag_str}"
-    end
+    data = "#{data}|##{tags}" unless tags.nil?
 
     socket = UDPSocket.new
     socket.send(data, 0, host, port)
@@ -40,67 +33,77 @@ 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 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, &:+)
+      @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
 
-Puma::Plugin.create do
-  # Puma creates the plugin when encountering `plugin` in the config.
-  def initialize(loader)
-    @loader = loader
+  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
   # We can start doing something when we have a launcher:
   def start(launcher)
     @launcher = launcher
 
     @statsd = ::StatsdConnector.new
-    if @statsd.enabled?
-      @launcher.events.debug "statsd: enabled (host: #{@statsd.host})"
-      register_hooks
-    else
-      @launcher.events.debug "statsd: not enabled (no #{StatsdConnector::ENV_NAME} env var found)"
+    @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
   end
 
   private
@@ -109,34 +112,74 @@ Puma::Plugin.create do
     in_background(&method(:stats_loop))
   end
 
-  def fetch_stats
-    JSON.parse(Puma.stats)
+  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 tags
-    tags = {}
+  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
+    # associated value.
+    #
+    # Examples: simple-tag-0 tag-key-1:tag-value-1
+    #
+    tags = []
+
     if ENV.has_key?("MY_POD_NAME")
-      tags[:pod_name] = ENV.fetch("MY_POD_NAME", "no_pod")
+      tags << "pod_name:#{ENV['MY_POD_NAME']}"
     end
+
     if ENV.has_key?("STATSD_GROUPING")
-      tags[:grouping] = ENV.fetch("STATSD_GROUPING", "no-group")
+      tags << "grouping:#{ENV['STATSD_GROUPING']}"
     end
-    tags
+
+    # Standardised datadog tag attributes, so that we can share the metric
+    # tags with the application running
+    #
+    # https://docs.datadoghq.com/agent/docker/?tab=standard#global-options
+    #
+    if ENV.has_key?("DD_TAGS")
+      ENV["DD_TAGS"].split(/\s+/).each do |t|
+        tags << t
+      end
+    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?
+
+    tags.join(",")
+  end
+
+  def prefixed_metric_name(puma_metric)
+    "#{@metric_prefix}#{puma_metric}"
   end
 
   # Send data to statsd every few seconds
   def stats_loop
+    tags = environment_variable_tags
+
     sleep 5
     loop 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.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    ")}"
       ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-plugin-statsd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-06 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -19,7 +19,7 @@ dependencies:
         version: '3.12'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3.12'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -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