puma-metrics 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52e6b92c221213e6d136e47d8aec1d2cb2a8279614dbd5714a30f7c82aec69b2
-  data.tar.gz: be07b67faa4b234709fa142bff7fc9beb4bb1923e5dd2753e4169895c00061bd
+  metadata.gz: 37f1ce3ea6119b2ed16fc6a44b782c73c8a5556b8a34d05d0405ef858cbe296c
+  data.tar.gz: 88c7934712eeaa24b0d4bc7b7046d2a3831da3f03052c30ed9e9b1a3273b7a81
 SHA512:
-  metadata.gz: b7e061a28a0a57092508a8d5fa2146f8f24e3b8a65d36b2408ee6a931846d516a53b1bd8af8612553d9cf01850df602694758d16da2b75e9d4d7b61148f035b9
-  data.tar.gz: a013abe137b98ae273ff7d21b408c04c334f248679757cd70a79332a6478e12050814c2f84a5a1c1df9b9ca1c609b27525dece595cc4c401deaa84823bb992c4
+  metadata.gz: 0914550673aeeecf7535cf6a049d041c8e9b350eb416bf090a686a426f4a51e2d9060f4899d60a74359486c02f237e266f5174a59786d4bf1ad110c9978d0e47
+  data.tar.gz: 02b8e0d1ee0f29035446915617459d651485b847f8586b8c6d6c2dbf9452ab11ed77a1db840e81e04c2d71c85eee5532e1f1e063fcd2a47e27ce92a1c5ae6224

data/.rubocop.yml

@@ -7,3 +7,12 @@ Naming/FileName:
 
 Metrics/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false
+Style/MethodMissingSuper:
+  Exclude:
+    - lib/puma/metrics/parser.rb
+Style/MissingRespondToMissing:
+  Exclude:
+    - lib/puma/metrics/parser.rb

data/.travis.yml

@@ -4,6 +4,10 @@ rvm:
 - 2.3
 - 2.4
 - 2.5
+script:
+- bundle exec rake
+- bundle exec overcommit --sign
+- bundle exec overcommit --run
 deploy:
   provider: rubygems
   api_key:
@@ -11,3 +15,4 @@ deploy:
   gem: puma-metrics
   on:
     repo: harmjanblok/puma-metrics
+    rvm: 2.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+Initial release of the `puma-metrics` gem.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    puma-metrics (0.0.0)
+    puma-metrics (1.0.0)
+      prometheus-client (~> 0.8)
       puma (~> 3.0)
 
 GEM
@@ -13,6 +14,7 @@ GEM
     ffi (1.9.25)
     iniparse (1.4.4)
     jaro_winkler (1.5.1)
+    minitest (5.11.3)
     overcommit (0.46.0)
       childprocess (~> 0.6, >= 0.6.3)
       iniparse (~> 1.4)
@@ -20,7 +22,10 @@ GEM
     parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    prometheus-client (0.8.0)
+      quantile (~> 0.2.1)
     puma (3.12.0)
+    quantile (0.2.1)
     rainbow (3.0.0)
     rake (10.5.0)
     rubocop (0.59.0)
@@ -39,6 +44,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  minitest
   overcommit
   puma-metrics!
   rake

data/README.md

@@ -1,8 +1,47 @@
 # puma-metrics
 
+[![Build Status](https://travis-ci.org/harmjanblok/puma-metrics.svg?branch=master)](https://travis-ci.org/harmjanblok/puma-metrics)
+
+A puma plugin to export Puma's internal statistics as Prometheus metrics.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma-metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puma-metrics
+
+
+## Usage
+
+Add following lines to your puma `config.rb` (see
+[Configuration File](https://github.com/puma/puma#configuration-file)):
+
+```ruby
+# config/puma.rb
+# Load the metrics plugin
+plugin 'metrics'
+
+# Bind the metric server to "url". "tcp://" is the only accepted protocol.
+#
+# The default is "tcp://0.0.0.0:9393".
+# metrics_url 'tcp://0.0.0.0:9393'
+```
+
 ## Credits
 
 The gem is inspired by the following projects:
+* https://github.com/puma/puma
 * https://github.com/puma/puma-heroku
 
 ## License

data/Rakefile

@@ -4,7 +4,28 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :server do
+  require 'puma'
+  require 'puma/configuration'
+  require 'puma/events'
+  require 'puma/plugin/metrics.rb'
+
+  configuration = Puma::Configuration.new do |config|
+    config.bind 'tcp://127.0.0.1:0'
+    config.metrics_url 'tcp://127.0.0.1:9494'
+    config.plugin 'metrics'
+    config.workers 1
+    config.app do |_env|
+      [200, {}, ['hello world']]
+    end
+  end
+
+  events = Puma::Events.new STDOUT, STDERR
+  launcher = Puma::Launcher.new(configuration, events: events)
+  launcher.run
 end
 
 task default: :test

data/lib/puma/metrics/app.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'prometheus/client/formats/text'
+require 'puma/metrics/parser'
+
+module Puma
+  module Metrics
+    class App
+      def initialize(launcher)
+        @launcher = launcher
+        clustered = (@launcher.options[:workers] || 0) > 0
+        @parser = Parser.new clustered
+      end
+
+      def call(_env)
+        @parser.parse JSON.parse(@launcher.stats)
+        [
+          200,
+          { 'Content-Type' => 'text/plain' },
+          [Prometheus::Client::Formats::Text.marshal(Prometheus::Client.registry)]
+        ]
+      end
+    end
+  end
+end

data/lib/puma/metrics/dsl.rb

@@ -0,0 +1,7 @@
+module Puma
+  class DSL
+    def metrics_url(url = 'tcp://0.0.0.0:9393')
+      @options[:metrics_url] = url
+    end
+  end
+end

data/lib/puma/metrics/parser.rb

@@ -0,0 +1,45 @@
+require 'prometheus/client'
+
+module Puma
+  module Metrics
+    class Parser
+      def initialize(clustered = false)
+        register_default_metrics
+        register_clustered_metrics if clustered
+      end
+
+      def parse(stats, labels = {})
+        stats.each do |key, value|
+          value.each { |s| parse(s, labels.merge(index: s['index'])) } if key == 'worker_status'
+          parse(value, labels) if key == 'last_status'
+          update_metric(key, value, labels)
+        end
+      end
+
+      private
+
+      def register_clustered_metrics
+        registry.gauge(:puma_booted_workers, 'Number of booted workers').set({}, 1)
+        registry.gauge(:puma_old_workers, 'Number of old workers').set({}, 0)
+      end
+
+      def register_default_metrics
+        registry.gauge(:puma_backlog, 'Number of established but unaccepted connections in the backlog', index: 0)
+        registry.gauge(:puma_running, 'Number of running worker threads', index: 0)
+        registry.gauge(:puma_pool_capacity, 'Number of allocatable worker threads', index: 0)
+        registry.gauge(:puma_max_threads, 'Maximum number of worker threads', index: 0)
+        registry.gauge(:puma_workers, 'Number of configured workers').set({}, 1)
+      end
+
+      def registry
+        Prometheus::Client.registry
+      end
+
+      def update_metric(key, value, labels)
+        return if registry.get("puma_#{key}").nil?
+
+        registry.get("puma_#{key}").set(labels, value)
+      end
+    end
+  end
+end

data/lib/{puma-metrics → puma/metrics}/version.rb

@@ -1,5 +1,5 @@
 module Puma
   module Metrics
-    VERSION = '0.0.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/puma/plugin/metrics.rb

@@ -0,0 +1,29 @@
+require 'puma/metrics/dsl'
+
+Puma::Plugin.create do
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+  def start(launcher)
+    str = launcher.options[:metrics_url]
+    return unless str
+
+    require 'puma/metrics/app'
+
+    app = Puma::Metrics::App.new launcher
+    uri = URI.parse str
+
+    metrics = Puma::Server.new app, launcher.events
+    metrics.min_threads = 0
+    metrics.max_threads = 1
+
+    case uri.scheme
+    when 'tcp'
+      launcher.events.log "* Starting metrics server on #{str}"
+      metrics.add_tcp_listener uri.host, uri.port
+    else
+      launcher.events.error "Invalid control URI: #{str}"
+    end
+
+    metrics.run
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+end

data/puma-metrics.gemspec

@@ -1,7 +1,7 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'puma-metrics/version'
+require 'puma/metrics/version'
 
 Gem::Specification.new do |spec|
   spec.authors       = ['Harm-Jan Blok']
@@ -15,9 +15,11 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
+  spec.add_runtime_dependency 'prometheus-client', '~> 0.8'
   spec.add_runtime_dependency 'puma', '~> 3.0'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puma-metrics
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Harm-Jan Blok
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -89,12 +117,17 @@ files:
 - ".overcommit.yml"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/puma-metrics/version.rb
+- lib/puma/metrics/app.rb
+- lib/puma/metrics/dsl.rb
+- lib/puma/metrics/parser.rb
+- lib/puma/metrics/version.rb
+- lib/puma/plugin/metrics.rb
 - puma-metrics.gemspec
 homepage: https://github.com/harmjanblok/puma-metrics
 licenses: