sensu-plugins-puma 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e0f983857efdf659eb67057528e9d77c147ee12
-  data.tar.gz: 742496cb03278b1862041b692e1b93319af0121c
+  metadata.gz: 42e1211d4781f6c859884577e4b58fc5fbd05bee
+  data.tar.gz: 5deaa8958edd9599b415c791946441249d4b5813
 SHA512:
-  metadata.gz: b66dea7f27ef420e7f89b9392b80a47a295028e06b1a52c279c41eeeda27404bf5c0d50a1ca8a2201216669a63d9816a8d355e305e459caa91947d3c7a08a492
-  data.tar.gz: e066256365d9445d94807f507e80a1b99e497bbfdc46a8787909065322399bbf65c8170522b2a2d7e8b7e738c05b395c30e41ac7847bdf0155690f0eb93969d6
+  metadata.gz: 782d65b459af28c86f857b4359beedac711f51decc9694180cad44c89aadf778157531c84f907d13126d6ae0a9cf6a0f1968c9b8d51aeb5b548b23006ea42dc3
+  data.tar.gz: 02567ef91947ebcba62f08c8d05d9fa00955b75c4cb157dd423b72b3afdabc8ad5de3a4ec59a0331e4611cc9b22fd31dbfff25f19bf93a5068084ebc7b68fb99

data/CHANGELOG.md

@@ -1,10 +1,30 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+This CHANGELOG follows the format listed listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
 
+## [2.0.0] - 2017-09-30
+### Breaking Change
+- updated `sensu-plugin` dependency to 2.x (@majormoses)
+
+### Changed
+- updated changelog guideline location (@majormoses)
+
+### Fixed
+- pr template spelling (@majormoses)
+
+### Added
+- Support for Puma v3 state files (@dnd)
+- Parsing of stats output with multiple workers (@dnd)
+- Ability to pass `--control-url` and `--auth-token` directly instead of state file (@dnd)
+- Support for connecting to control servers running on TCP ports (@dnd)
+- Add `--gc-stats` flag to allow collecting GC stats (@dnd)
+
+### Removed
+- Dependency on `puma`
+
 ## [1.0.0] - 2017-06-25
 ### Added
 - Support for Ruby 2.3 and 2.4 (@eheydrick)
@@ -31,8 +51,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-puma/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-puma/compare/2.0.0...HEAD
+[2.0.0]: https://github.com/sensu-plugins/sensu-plugins-puma/compare/1.0.0...2.0.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-puma/compare/0.0.3...1.0.0
 [0.0.3]: https://github.com/sensu-plugins/sensu-plugins-puma/compare/0.0.2...0.0.3
 [0.0.2]: https://github.com/sensu-plugins/sensu-plugins-puma/compare/0.0.1...0.0.2
-

data/bin/metrics-puma.rb

@@ -29,9 +29,7 @@
 require 'sensu-plugin/metric/cli'
 
 require 'json'
-require 'puma/configuration'
-require 'socket'
-require 'yaml'
+require 'sensu-plugins-puma'
 
 class PumaMetrics < Sensu::Plugin::Metric::CLI::Graphite
   option :scheme,
@@ -46,26 +44,77 @@ class PumaMetrics < Sensu::Plugin::Metric::CLI::Graphite
          long: '--state-file SOCKET',
          default: '/tmp/puma.state'
 
-  def puma_options
-    @puma_options ||= begin
-      return nil unless File.exist?(config[:state_file])
-      YAML.load_file(config[:state_file])['config'].options
-    end
-  end
+  option :control_auth_token,
+         description: 'The auth token to connect to the control server with',
+         long: '--auth-token TOKEN'
 
-  def puma_stats
-    stats = Socket.unix(puma_options[:control_url].gsub('unix://', '')) do |socket|
-      socket.print("GET /stats?token=#{puma_options[:control_auth_token]} HTTP/1.0\r\n\r\n")
-      socket.read
-    end
+  option :control_url,
+         description: 'The control_url the puma control server is listening on',
+         long: '--control-url PATH'
 
-    JSON.parse(stats.split("\r\n").last)
+  option :gc_stats,
+         description: 'Collect GC stats. Only available for Puma >= v3.10.0',
+         long: '--gc-stats',
+         boolean: true,
+         default: false
+
+  def puma_ctl
+    @puma_ctl ||= PumaCtl.new(
+      state_file: config[:state_file],
+      control_auth_token: config[:control_auth_token],
+      control_url: config[:control_url]
+    )
   end
 
   def run
-    puma_stats.map do |k, v|
-      output "#{config[:scheme]}.#{k}", v
+    timestamp = Time.now.to_i
+    stats = puma_ctl.stats
+    metrics = {}
+    worker_status = stats.delete('worker_status')
+
+    if worker_status
+      metrics = parse_worker_stats(metrics, worker_status)
+    end
+
+    metrics.merge!(stats)
+
+    begin
+      metrics = parse_gc_stats(metrics, puma_ctl.gc_stats) if config[:gc_stats]
+    rescue PumaCtl::UnknownCommand
+      unknown 'Control server does not support the `gc-stats` command'
+    end
+
+    metrics.map do |k, v|
+      output "#{config[:scheme]}.#{k}", v, timestamp
     end
     ok
   end
+
+  private
+
+  def parse_gc_stats(metrics, gc_stats)
+    gc_stats.map do |k, v|
+      metrics["gc.#{k}"] = v
+    end
+    metrics
+  end
+
+  def parse_worker_stats(metrics, worker_status)
+    backlog = 0
+    running = 0
+    worker_status.each do |worker|
+      idx = worker.delete('index')
+      last_status = worker.delete('last_status')
+      backlog += (worker['backlog'] = last_status['backlog'])
+      running += (worker['running'] = last_status['running'])
+      worker.map do |k, v|
+        v = Time.parse(v).to_i if k == 'last_checkin'
+        metrics["worker.#{idx}.#{k}"] = v
+      end
+    end
+
+    metrics['backlog'] = backlog
+    metrics['running'] = running
+    metrics
+  end
 end

data/lib/sensu-plugins-puma.rb

@@ -1 +1,2 @@
 require 'sensu-plugins-puma/version'
+require 'sensu-plugins-puma/puma_ctl'

data/lib/sensu-plugins-puma/puma_ctl.rb

@@ -0,0 +1,84 @@
+require 'json'
+require 'socket'
+require 'yaml'
+
+class PumaCtl
+  class UnknownCommand < StandardError; end
+
+  attr_reader :state_file
+
+  def initialize(state_file: '/tmp/puma.state', control_auth_token: nil, control_url: nil)
+    @state_file = state_file
+    @control_auth_token = control_auth_token
+    @control_url = control_url
+  end
+
+  def control_auth_token
+    @control_auth_token ||= puma_options[:control_auth_token]
+  end
+
+  def control_url
+    @control_url ||= puma_options[:control_url]
+  end
+
+  def puma_options
+    @puma_options ||= begin
+      return nil unless File.exist?(state_file)
+      state = load_puma_state(state_file)
+
+      if state.key?('config')
+        # state is < v3.0.0
+        opts = state['config']['options']
+        { control_url: opts[:control_url], control_auth_token: opts[:control_auth_token] }
+      else
+        # state is >= v3.0.0
+        { control_url: state['control_url'], control_auth_token: state['control_auth_token'] }
+      end
+    end
+  end
+
+  def gc_stats
+    send_socket_command('gc-stats')
+  end
+
+  def stats
+    send_socket_command('stats')
+  end
+
+  private
+
+  def control_socket
+    type = nil
+    args = []
+    case control_url
+    when /^unix:\/\//
+      type = :unix
+      args = [control_url.gsub('unix://', '')]
+    when /^tcp:\/\//
+      type = :tcp
+      args = control_url.gsub('tcp://', '').split(':')
+    else
+      return nil
+    end
+
+    Socket.send(type, *args) do |socket|
+      yield socket
+    end
+  end
+
+  def load_puma_state(path)
+    raw = File.read(path)
+    sanitized = raw.gsub(/!ruby\/object:.*$/, '')
+    YAML.load(sanitized)
+  end
+
+  def send_socket_command(cmd)
+    out = control_socket do |socket|
+      socket.print("GET /#{cmd}?token=#{control_auth_token} HTTP/1.0\r\n\r\n")
+      result = socket.read
+      raise UnknownCommand, cmd if result =~ /^HTTP\/1.0 404/
+      result
+    end
+    JSON.parse(out.split("\r\n").last)
+  end
+end

data/lib/sensu-plugins-puma/version.rb

@@ -1,6 +1,6 @@
 module SensuPluginsPuma
   module Version
-    MAJOR = 1
+    MAJOR = 2
     MINOR = 0
     PATCH = 0
 

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-puma
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-09-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.11.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +164,7 @@ files:
 - README.md
 - bin/metrics-puma.rb
 - lib/sensu-plugins-puma.rb
+- lib/sensu-plugins-puma/puma_ctl.rb
 - lib/sensu-plugins-puma/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-puma
 licenses:
@@ -205,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for puma