puma-metrics 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37f1ce3ea6119b2ed16fc6a44b782c73c8a5556b8a34d05d0405ef858cbe296c
-  data.tar.gz: 88c7934712eeaa24b0d4bc7b7046d2a3831da3f03052c30ed9e9b1a3273b7a81
+  metadata.gz: e6bfb3829a8b3f020867676ad2d06696602f9b3e9cdba9677c9d0cd96516d952
+  data.tar.gz: 9b22b853444c9f8eb9945582e6debd9676c0ac83487178fe056840c8cb438b96
 SHA512:
-  metadata.gz: 0914550673aeeecf7535cf6a049d041c8e9b350eb416bf090a686a426f4a51e2d9060f4899d60a74359486c02f237e266f5174a59786d4bf1ad110c9978d0e47
-  data.tar.gz: 02b8e0d1ee0f29035446915617459d651485b847f8586b8c6d6c2dbf9452ab11ed77a1db840e81e04c2d71c85eee5532e1f1e063fcd2a47e27ce92a1c5ae6224
+  metadata.gz: 79d9e90b3dc95a9508622a6142a044dd682b072dcfd3971a2bfa06b5651ba414b2dd1667be0896779ae9a08be677d9607db2e0f6e3ba2f7417581c59e4be0b37
+  data.tar.gz: 38a134598cb7f50faded591f745832423aedcc9b4c7589a796ff25a67479104348675bc2e6dea82e2f08b440ba54616fc1d81951038aa6a6195cd922d84313e7

data/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.github/workflows/workflow.yml

@@ -0,0 +1,41 @@
+name: steps
+on: [push]
+jobs:
+  test:
+    name: test on ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-ruby@master
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: gem install bundler
+    - run: bundle install
+    - run: bundle exec rake
+    - run: bundle exec overcommit --sign
+    - env:
+        GIT_AUTHOR_NAME: John Doe
+        GIT_AUTHOR_EMAIL: johndoe@example.com
+      run: bundle exec overcommit --run
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.5', '2.7']
+  deploy:
+    if: github.ref == 'refs/heads/master'
+    name: to rubygems
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-ruby@master
+      with:
+        ruby-version: 2.7
+    - env:
+        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.6
 
 Naming/FileName:
   Exclude:
@@ -10,6 +10,8 @@ Metrics/LineLength:
 
 Style/Documentation:
   Enabled: false
+Style/NumericPredicate:
+  Enabled: false
 Style/MethodMissingSuper:
   Exclude:
     - lib/puma/metrics/parser.rb

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## Unreleased
+
+## 1.2.0
+
+Changes:
+- Drop support for ruby 2.4
+- Relax prometheus-client to '>= 0.10'
+
+Housekeeping:
+- Update development dependencies
+
+## 1.1.0
+
+Changes:
+- Upgrade prometheus-client to '~> 0.10'
+
+Housekeeping:
+- Set target version to 2.6
+- Added editorconfig
+
+## 1.0.3
+
+Features:
+- can be used with puma 3 or puma 4
+
+## 1.0.2
+
+Bugfixes:
+- terminate metrics server without IO errors [#7](https://github.com/harmjanblok/puma-metrics/pull/7)
+
+## 1.0.1
+
+Bugfixes:
+- `metrics_url` in `config/puma.rb` should be optional
+
 ## 1.0.0
 
 Initial release of the `puma-metrics` gem.

data/Gemfile.lock

@@ -1,43 +1,44 @@
 PATH
   remote: .
   specs:
-    puma-metrics (1.0.0)
-      prometheus-client (~> 0.8)
-      puma (~> 3.0)
+    puma-metrics (1.2.0)
+      prometheus-client (>= 0.10)
+      puma (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    childprocess (0.9.0)
-      ffi (~> 1.0, >= 1.0.11)
-    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)
+    ast (2.4.1)
+    childprocess (3.0.0)
+    iniparse (1.5.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    overcommit (0.53.0)
+      childprocess (>= 0.6.3, < 4)
       iniparse (~> 1.4)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    parallel (1.19.1)
+    parser (2.7.1.3)
       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)
+    prometheus-client (2.0.0)
+    puma (4.3.5)
+      nio4r (~> 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.59.0)
-      jaro_winkler (~> 1.5.1)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.85.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -51,4 +52,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.16.1
+   2.1.2

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/lib/puma/metrics/app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'prometheus/client/formats/text'
 require 'puma/metrics/parser'
@@ -12,13 +14,22 @@ module Puma
       end
 
       def call(_env)
-        @parser.parse JSON.parse(@launcher.stats)
+        retrieve_and_parse_stats!
         [
           200,
           { 'Content-Type' => 'text/plain' },
           [Prometheus::Client::Formats::Text.marshal(Prometheus::Client.registry)]
         ]
       end
+
+      def retrieve_and_parse_stats!
+        puma_stats = @launcher.stats
+        if puma_stats.is_a?(Hash) # Modern Puma outputs stats as a Symbol-keyed Hash
+          @parser.parse(puma_stats)
+        else
+          @parser.parse(JSON.parse(puma_stats, symbolize_names: true))
+        end
+      end
     end
   end
 end

data/lib/puma/metrics/dsl.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Puma
   class DSL
-    def metrics_url(url = 'tcp://0.0.0.0:9393')
+    def metrics_url(url)
       @options[:metrics_url] = url
     end
   end

data/lib/puma/metrics/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'prometheus/client'
 
 module Puma
@@ -8,10 +10,10 @@ module Puma
         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'
+      def parse(symbol_keyed_stats, labels = {})
+        symbol_keyed_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
@@ -19,16 +21,34 @@ module Puma
       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)
+        registry.gauge(:puma_booted_workers,
+                       docstring: 'Number of booted workers')
+                .set(1)
+        registry.gauge(:puma_old_workers,
+                       docstring: '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)
+      def register_default_metrics # rubocop:disable Metrics/MethodLength
+        registry.gauge(:puma_backlog,
+                       docstring: 'Number of established but unaccepted connections in the backlog',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_running,
+                       docstring: 'Number of running worker threads',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_pool_capacity,
+                       docstring: 'Number of allocatable worker threads',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_max_threads,
+                       docstring: 'Maximum number of worker threads',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_workers,
+                       docstring: 'Number of configured workers')
+                .set(1)
       end
 
       def registry
@@ -38,7 +58,7 @@ module Puma
       def update_metric(key, value, labels)
         return if registry.get("puma_#{key}").nil?
 
-        registry.get("puma_#{key}").set(labels, value)
+        registry.get("puma_#{key}").set(value, labels: labels)
       end
     end
   end

data/lib/puma/metrics/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Puma
   module Metrics
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.2.0'
   end
 end

data/lib/puma/plugin/metrics.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 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
+    str = launcher.options[:metrics_url] || 'tcp://0.0.0.0:9393'
 
     require 'puma/metrics/app'
 
@@ -23,6 +24,12 @@ Puma::Plugin.create do
       launcher.events.error "Invalid control URI: #{str}"
     end
 
+    launcher.events.register(:state) do |state|
+      if %i[halt restart stop].include?(state)
+        metrics.stop(true) unless metrics.shutting_down?
+      end
+    end
+
     metrics.run
   end
   # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/puma-metrics.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -15,8 +17,8 @@ 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_runtime_dependency 'prometheus-client', '>= 0.10'
+  spec.add_runtime_dependency 'puma', '>= 3.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest'

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: puma-metrics
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Harm-Jan Blok
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2020-06-15 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'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -114,9 +114,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/workflow.yml"
 - ".overcommit.yml"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -148,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Puma plugin to export puma stats as prometheus metrics

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-rvm:
-- 2.2
-- 2.3
-- 2.4
-- 2.5
-script:
-- bundle exec rake
-- bundle exec overcommit --sign
-- bundle exec overcommit --run
-deploy:
-  provider: rubygems
-  api_key:
-    secure: WxQuGnHli0eOu/xYcO8fh8eK5sWxBQHwo5MaGhlZpdCvzELJ943gbfzhaZ7sK9okfLHPiY1uXYYA657KhlnDcrSLg16uI+HmPTi1RoKqQ3VmqQ6YoGhdl2GROlctCfHRO2iRuu7ujz9gf80OBH5ojHOwV+IrNsl911s6/4zhBY8uhFmdVb87zq1ZCPABNxanhlr0x51T6Q+JpdDW8c6FDGqUNtzqxEVMxS81tPhXnpDcUf/H0M8LOIQMyI21WyqUdo2vNqF6hCmRDogpZceJHtECboxgKoGJNEnOZdvAeX48Ysiu4O83Rq/mgBq30JBAgUe4TZPNwDjND+NJQktkzx/+IOJ+52G90VsJiUuBWsyh4IQKK+HqQr2CZyiEBybWU6FHCLifhuXfnOFA/VS2JNme16NiROrgrxoqtezbQ8yO8pgZ0PdtmL6hjBUknmZCyVDCdB1SPQGvo+b4AqkzY/SLuNCuJmOBBE5sMT6xFAiHU94rJViXMeJvF1pSQXIRFSuAQZ7ILOUC/GwqxIUmPk80p893itoFs3ExBPe2tBmzBVWyr+Dvu1SS2of+4JbBNbtOZr+nOT5pl7s4Zk4GG3b9UuozJn5yWi0Aj9iAju8T1r2tMpZ9zQtjrXtZJRi8ri8rQ2lC5ha63XLGGbDQon0bXs656GKKupaUS/BUboI=
-  gem: puma-metrics
-  on:
-    repo: harmjanblok/puma-metrics
-    rvm: 2.5