puma-plugin-dogstatsd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7485381db49f9439d5e1557addb60ecd5b57366050de80b719c56406ffc69165
+  data.tar.gz: f500f66e8fc090a19c1e0260786d2c9a93a51ae67f470c6f58de6eac9fc002d5
+SHA512:
+  metadata.gz: 34360f459578b50e4677a5c61f7f593602c767c05b614a6a215a0aec186d500d38f5a6ece409802d0db4b51cc10c25958f5b4ef997e9a0079f11b4ff64504ddc
+  data.tar.gz: 7e2d31cbf1c413fa3f156dc8405b044fd79c2dabf7e16109c94ee7c59a18fb87a7f868b8808bb39388f300d78c3644638695a4b1885b9d59dc09da6d05c0ce83

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 James Healy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Puma Dogstatsd Plugin
+
+[Puma](https://github.com/puma/puma) integration with [dogstatsd](https://github.com/DataDog/dogstatsd-ruby) for easy tracking of key metrics that puma can provide:
+
+* puma.workers
+* puma.booted_workers
+* puma.running
+* puma.backlog
+* puma.pool_capacity
+* puma.max_threads
+
+## Installation
+
+Add this gem to your Gemfile with puma and then bundle:
+
+```ruby
+gem "puma"
+gem "puma-plugin-dogstatsd"
+```
+
+Add it to your puma config:
+
+```ruby
+# config/puma.rb
+
+bind "http://127.0.0.1:9292"
+
+workers 1
+threads 8, 16
+
+PumaPluginDogstastd.activate(self, an_instance_of_a_dogstatsd_client)
+```
+
+## Acknowledgements
+
+This gem is a fork of the excellent [puma-plugin-statsd](https://github.com/yob/puma-plugin-statsd) by James Healy.
+
+Other puma plugins that were helpful references:
+
+* [puma-heroku](https://github.com/evanphx/puma-heroku)
+* [tmp-restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb)
+* [puma-plugin-systemd](https://github.com/sj26/puma-plugin-systemd)
+
+The [puma docs](https://github.com/puma/puma/blob/master/docs/plugins.md) were also helpful.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][license].
+
+  [license]: http://opensource.org/licenses/MIT

data/lib/puma/plugin/PumaPluginDogstastd.rb

@@ -0,0 +1,69 @@
+# coding: utf-8, frozen_string_literal: true
+
+require 'json'
+require 'puma'
+require 'puma/plugin'
+
+module PumaPluginDogstastd
+
+  KEY = :puma_plugin_datadog_statsd_client
+
+  def activate(puma_config, datadog_statsd_client)
+    puma_config.inject { @options[KEY] = datadog_statsd_client }
+    puma_config.plugin(:PumaPluginDogstastd)
+  end
+  module_function :activate
+
+  def get_dogstatsd_client(puma_config)
+    puma_config.instance_variable_get(:@options)[KEY]
+  end
+  module_function :get_dogstatsd_client
+
+end
+
+Puma::Plugin.create do
+
+  def start(launcher)
+    dogstatsd_client = PumaPluginDogstastd.get_dogstatsd_client(launcher)
+
+    clustered = launcher.send(:clustered?) # See https://github.com/puma/puma/blob/master/lib/puma/launcher.rb#L285
+
+    launcher.events.debug "PumaPluginDatadogStastd: enabled"
+
+    in_background do
+      sleep 5
+      loop do
+        launcher.events.debug 'PumaPluginDatadogStastd: notify statsd'
+        begin
+          stats = fetch_stats
+
+          dogstatsd_client.gauge('puma.workers', stats.fetch('workers', 1))
+          dogstatsd_client.gauge('puma.booted_workers', stats.fetch('booted_workers', 1))
+          dogstatsd_client.gauge('puma.running', count_value_for_key(clustered, stats, 'running'))
+          dogstatsd_client.gauge('puma.backlog', count_value_for_key(clustered, stats, 'backlog'))
+          dogstatsd_client.gauge('puma.pool_capacity', count_value_for_key(clustered, stats, 'pool_capacity'))
+          dogstatsd_client.gauge('puma.max_threads', count_value_for_key(clustered, stats, 'max_threads'))
+        rescue StandardError => e
+          launcher.events.error "PumaPluginDatadogStastd: notify stats failed:\n  #{e.to_s}\n  #{e.backtrace.join("\n    ")}"
+        ensure
+          sleep 2
+        end
+      end
+    end
+  end
+
+  private
+
+  def count_value_for_key(clustered, stats, key)
+    if clustered
+      stats['worker_status'].reduce(0) { |acc, s| acc + s['last_status'].fetch(key, 0) }
+    else
+      stats.fetch(key, 0)
+    end
+  end
+
+  def fetch_stats
+    JSON.parse(Puma.stats)
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: puma-plugin-dogstatsd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jules Ivanic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  name: puma
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: json
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  name: minitest
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email: jules.ivanic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/puma/plugin/PumaPluginDogstastd.rb
+homepage: https://github.com/guizmaii/puma-plugin-statsd
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Send puma metrics to Dogstatsd via a background thread
+test_files: []