yabeda-puma-plugin 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e89900f2439ba78c8c813c423c1035133934fd7b727d355fe16be5416b40ef5
-  data.tar.gz: 1b99f6bebac908ad72fd85522b41823a42593262057cea0abb3c2c6dd9768501
+  metadata.gz: f9b1df64591444d1f95959e4a18a2f84ddc0422da1a8aa7762b6da41cf0090ab
+  data.tar.gz: b0b6fd8696a7c35db5a2b31ddf462463a64038581dd9e414ed26d46a27eedbd0
 SHA512:
-  metadata.gz: 2f586fcfa8cef7892afa68690c23cb6c73c70964bed54b0ce65d5434513490b91c133d2ef2e9709ad352dde50f6ebf1dea3c884e67b668737d8cfb0eb783c215
-  data.tar.gz: 97c8662a33acdd7102d90faa8725ee86269587c8c3f104dc49ae0621793c66e6f9f5ddf8660f0dbec11598e700dc97db32dcb51073c96384f4273baa20946ac6
+  metadata.gz: 474080f9c29212326062d91f968cde58fdfb573edf571194d786dbd895ba6e8400e81d05a77ff50aa9847c8681c6af6852a1c3bbc40032ad8b9b70b10d70d0ba
+  data.tar.gz: d89bac196177c49be5ef55df912bf29fe2eb3c487c7495d6e36020ad071fba53b3aeac38d22b89ad0e6870f3aa10b866face96a40c3bcae09d9a1501ab3c607e

data/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run tests
+name: Tests
 
 on:
   pull_request:
@@ -10,24 +10,32 @@ on:
 
 jobs:
   test:
-    name: "Run tests"
-    if: "! contains(toJSON(github.event.commits.latest.message), '[ci skip]')"
+    name: 'Puma ${{ matrix.puma }} on Ruby ${{ matrix.ruby }}'
+    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         include:
-          - ruby: 3.0
-          - ruby: 2.7
-          - ruby: 2.6
-          - ruby: 2.5
+          - ruby: "3.1"
+            puma: "6"
+          - ruby: "3.0"
+            puma: "5"
+          - ruby: "2.7"
+            puma: "5"
+          - ruby: "2.6"
+            puma: "4"
+          - ruby: "2.5"
+            puma: "4"
     container:
       image: ruby:${{ matrix.ruby }}
       env:
         CI: true
+        PUMA_VERSION: ${{ matrix.puma }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.7.1 - 2022-11-28
+
+### Fixed
+
+ - Error if exporter is stopped before creation. [@ollym][], [#27](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/27)
+
+## 0.7.0 - 2022-10-24
+
+### Added
+
+ - Puma 6.x support for `yabeda_prometheus` plugin. [@ollym][], [#25](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/25)
+ - Support phased restarts with standalone Prometheus exporter. [@botimer][], [#23](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/23)
+ - `on_prometheus_exporter_boot` hook in Puma config DSL. [@Envek][]
+
 ## 0.6.0 - 2021-02-05
 
 ### Changed
@@ -45,6 +59,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Initial release with basic metrics collection. [@dsalahutdinov]
 
+[@ollym]: https://github.com/ollym "Oliver Morgan"
 [@botimer]: https://github.com/botimer "Noah Botimer"
 [@jwhitcraft]: https://github.com/jwhitcraft "Jon Whitcraft"
 [@Neznauy]: https://github.com/Neznauy "Aleksandr Shlyakov"

data/Gemfile

@@ -1,6 +1,10 @@
 source "https://rubygems.org"
 
-gem 'prometheus-client'
 gem 'yabeda-prometheus'
+
 # Specify your gem's dependencies in yabeda-puma.gemspec
 gemspec
+
+puma_version = ENV.fetch("PUMA_VERSION", "~> 6.0")
+puma_version = "~> #{puma_version}.0" if puma_version.match?(/^\d+$/)
+gem "puma", puma_version

data/README.md

@@ -3,7 +3,7 @@
     alt="Sponsored by Amplifr" src="https://amplifr-direct.s3-eu-west-1.amazonaws.com/social_images/image/37b580d9-3668-4005-8d5a-137de3a3e77c.png" />
 </a>
 
-# Yabeda::Puma::Plugin
+# ![`Yabeda::Puma::Plugin`](./yabeda-puma-plugin-logo.png)
 
 Built-in metrics for [Puma](https://github.com/puma/puma) web server monitoring out of the box! Part of the [yabeda](https://github.com/yabeda-rb/yabeda) suite.
 
@@ -43,6 +43,17 @@ plugin :yabeda
 ```
 It will activate default puma control application working over the unix socket, and runs the `yabeda` puma plugin, for registering and collecting the metrics.
 
+> **Note**
+>
+> In case if you're **not** using Rails, don't forget configure Yabeda manually either in your app initialization or in Puma configuration hook:
+> ```ruby
+> # config/puma.rb
+> before_fork do
+>   Yabeda.configure!
+> end
+> ```
+> See [yabeda usage](https://github.com/yabeda-rb/yabeda#usage) for more information.
+
 ### Exposing metrics
 
 Some monitoring system agents (like NewRelic or DataDog) will send metrics automatically in the background. But for some of monitoring systems (like Prometheus) you have to explicitly set up metrics export.

data/docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.4'
 
 services:
   app:
-    image: ruby:2.6.0
+    image: ruby:3.1.0
     environment:
       - BUNDLE_PATH=/bundle
       - BUNDLE_CONFIG=/app/.bundle/config

data/lib/puma/plugin/yabeda_prometheus.rb

@@ -14,6 +14,11 @@ module Puma
     def prometheus_exporter_url(uri)
       @options[:prometheus_exporter_url] = uri
     end
+
+    def on_prometheus_exporter_boot(&block)
+      @options[:prometheus_exporter_boot_hooks] ||= []
+      @options[:prometheus_exporter_boot_hooks] << block
+    end
   end
 end
 
@@ -27,23 +32,67 @@ Puma::Plugin.create do
     port = Integer(ENV.fetch('PROMETHEUS_EXPORTER_PORT', uri.port))
     path = ENV.fetch('PROMETHEUS_EXPORTER_PATH', uri.path)
 
-    events.on_booted do
+    server = nil
+    logger = nil
+    banner = "Yabeda Prometheus metrics exporter on http://#{host}:#{port}#{path}"
+
+    create_server = -> {
       app = Yabeda::Prometheus::Exporter.rack_app(Yabeda::Prometheus::Exporter, path: path)
+      internal_events = Puma::Events.respond_to?(:null) ? Puma::Events.null : Puma::Events.new
+      server = Puma::Server.new app, internal_events, min_threads: 0, max_threads: 1
+      logger = server.respond_to?(:log_writer) ? server.log_writer : events
+
+      server.add_tcp_listener host, port
+      if server.respond_to?(:min_threads=)
+        server.min_threads = 0
+        server.max_threads = 1
+      end
 
-      metrics = Puma::Server.new app, events
-      metrics.min_threads = 0
-      metrics.max_threads = 1
+      internal_events.register(:state) do |state|
+        next unless state == :running
+        hooks = launcher.options.fetch(:prometheus_exporter_boot_hooks, [])
+        hooks.each(&:call)
+      end
 
-      events.log "* Starting Yabeda Prometheus metrics exporter on http://#{host}:#{port}#{path}"
-      metrics.add_tcp_listener host, port
+      [server, logger]
+    }
 
-      events.register(:state) do |state|
-        if %i[halt restart stop].include?(state)
-          metrics.stop(true) unless metrics.shutting_down?
+    events.on_booted do
+      unless server&.running
+        server, logger = create_server.call
+        logger.log "* Starting #{banner}"
+        server.run
+      end
+    end
+
+    # on_stopped and on_restart hooks were added in Puma 5.1 in https://github.com/puma/puma/commit/288a4cf756852a4837c77ee70d7fdcca1edb8e82
+    if events.respond_to?(:on_stopped) && events.respond_to?(:on_restart)
+
+      events.on_stopped do
+        if server && !server.shutting_down?
+          logger.log "* Stopping #{banner}"
+          server.stop(true)
         end
       end
 
-      metrics.run
+      events.on_restart do
+        logger.log "* Restarting #{banner}"
+        server.stop(true)
+        server, logger = create_server.call
+        server.run
+      end
+
+    else
+
+      events.register(:state) do |state|
+        next unless %i[halt restart stop].include?(state)
+
+        metrics.stop(true) unless metrics.shutting_down?
+        next unless state == :restart
+
+        server, logger = create_server.call
+        server.run
+      end
     end
   end
 end

data/lib/yabeda/puma/plugin/version.rb

@@ -1,7 +1,7 @@
 module Yabeda
   module Puma
     module Plugin
-      VERSION = "0.6.0"
+      VERSION = "0.7.1"
     end
   end
 end

data/yabeda-puma-plugin.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rack", "< 3"
+  spec.add_development_dependency "yabeda-prometheus", "~> 0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-puma-plugin
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
@@ -98,16 +98,30 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: yabeda-prometheus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Extends Yabeda metrics with puma web server values by using puma plugin
 email:
 - dsalahutdinov@gmail.com
@@ -137,6 +151,7 @@ files:
 - lib/yabeda/puma/plugin/statistics/fetcher.rb
 - lib/yabeda/puma/plugin/statistics/parser.rb
 - lib/yabeda/puma/plugin/version.rb
+- yabeda-puma-plugin-logo.png
 - yabeda-puma-plugin.gemspec
 homepage: http://github.com/yabeda-rb/yabeda-puma-plugin
 licenses:
@@ -157,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Puma web server plugin for collecting puma metrics with Yabeda framework.