yabeda-puma-plugin 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea655ec09c4edd3459d19356df62760dbb70049b24a0e5ccfb69eed7d501ec7d
-  data.tar.gz: 49cab44b0913f02a372473b3e8951a6c880020f3a22970c6f9cdadee7d3935ae
+  metadata.gz: 162d9000d77164bd50dfb7745f5cccd24dd33fbc16924c1643b8403e0f4dcda8
+  data.tar.gz: 9933179275d105ac9f8e6b41c7e046f70b67df88a244dbbef62c6a37748720eb
 SHA512:
-  metadata.gz: d68acb875bb1d793d0bf6c11f1df91313ec730bcf9984f362829586bdb7810e21b809c60980cf606feec93378957b218d046bb30ced55858f8cc704c3b073380
-  data.tar.gz: e8e0c33afd4c639ef3abb25485bf2fb9a3598a288d07033ad64ebffd354335f17558aef856afc18d439fb03cf0c767026c9e348b31de6d1ff1cc91a653ca1c7e
+  metadata.gz: e49fe7f43fe1f8a68b2b221390ab77c4961b4f10776279d73e761580b193948a39c11d00913004f6cb9511398d603018e6ee07014faefb06c30328ddadeb992c
+  data.tar.gz: bdc45f4701f90333891c90f7d6657dafac35e171c636c68630a36571b9fc0e039654285b566a7b5b1bf4086ee88737ab40ebae8a1d05375566a32a296b2de8b9

data/.github/workflows/build-release.yml

@@ -21,16 +21,26 @@ jobs:
           git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
           echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
           echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
           # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
           BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          BODY="${BODY}"$'\n'"${changelog}"
           BODY="${BODY//'%'/'%25'}"
           BODY="${BODY//$'\n'/'%0A'}"
           BODY="${BODY//$'\r'/'%0D'}"
           echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
       - name: Build gem
         run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem > SHA256SUM
       - name: Check version
-        run: ls yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
+        run: ls -l yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
@@ -41,9 +51,8 @@ jobs:
           release_name: ${{ steps.tag.outputs.subject }}
           body: ${{ steps.tag.outputs.body }}
           draft: false
-          prerelease: false
-      - name: Upload Release Asset
-        id: upload-release-asset
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -52,3 +61,22 @@ jobs:
           asset_path: yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
           asset_name: yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
           asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem push yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+        run: |
+          gem push yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run tests
+name: Tests
 
 on:
   pull_request:
@@ -10,23 +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: 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

@@ -0,0 +1,61 @@
+# Changelog
+
+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.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
+
+- “Most recent” aggregation mode specified for all gauge metrics. [@botimer], [#16](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/16)
+
+## 0.5.0 - 2020-11-13
+
+### Changed
+
+- Start Yabeda exporter on `on_booted` hook to support Puma 4.x daemon mode. [@Envek], [#14](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/14)
+
+## 0.4.0 - 2020-04-29
+
+### Added
+
+- `yabeda_prometheus` plugin to allow metrics export on separate port. [@jwhitcraft], [#11](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/11)
+
+## 0.3.0 - 2020-01-27
+
+### Added
+
+- Support for yabeda 0.2 (required by prometheus-client 1.0). [@Envek]
+
+## 0.2.1 - 2019-12-16
+
+### Fixed
+
+- Fix undefined method in TCP socket. [@Neznauy], [#7](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/7)
+
+## 0.2.0 - 2019-12-12
+
+### Added
+
+- Support for TCP puma control panel url. [@dsalahutdinov]
+
+## 0.1.0 - 2019-04-02
+
+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"
+[@Envek]: https://github.com/Envek "Andrey Novikov"
+[@dsalahutdinov]: https://github.com/dsalahutdinov "Dmitry Salahutdinov"

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.
@@ -134,6 +145,38 @@ docker-compose run app bundle exec rspec
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-puma-plugin.
 
+### Releasing
+
+1. Bump version number in `lib/yabeda/puma/plugin/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/puma/plugin/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/puma/plugin/version.rb -e "puts Gem::Version.new(Yabeda::Puma::Plugin::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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.rb

@@ -15,15 +15,15 @@ Puma::Plugin.create do
     Yabeda.configure do
       group :puma
 
-      gauge :backlog, tags: %i[index], comment: 'Number of established but unaccepted connections in the backlog'
-      gauge :running, tags: %i[index], comment: 'Number of running worker threads'
-      gauge :pool_capacity, tags: %i[index], comment: 'Number of allocatable worker threads'
-      gauge :max_threads, tags: %i[index], comment: 'Maximum number of worker threads'
+      gauge :backlog, tags: %i[index], comment: 'Number of established but unaccepted connections in the backlog', aggregation: :most_recent
+      gauge :running, tags: %i[index], comment: 'Number of running worker threads', aggregation: :most_recent
+      gauge :pool_capacity, tags: %i[index], comment: 'Number of allocatable worker threads', aggregation: :most_recent
+      gauge :max_threads, tags: %i[index], comment: 'Maximum number of worker threads', aggregation: :most_recent
 
       if clustered
-        gauge :workers, comment: 'Number of configured workers'
-        gauge :booted_workers, comment: 'Number of booted workers'
-        gauge :old_workers, comment: 'Number of old workers'
+        gauge :workers, comment: 'Number of configured workers', aggregation: :most_recent
+        gauge :booted_workers, comment: 'Number of booted workers', aggregation: :most_recent
+        gauge :old_workers, comment: 'Number of old workers', aggregation: :most_recent
       end
 
       collect do

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 = events
+    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
+        unless 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.5.0"
+      VERSION = "0.7.0"
     end
   end
 end

data/yabeda-puma-plugin.gemspec

@@ -21,12 +21,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "yabeda", "~> 0.2"
+  spec.add_runtime_dependency "yabeda", "~> 0.5"
   spec.add_runtime_dependency "puma"
   spec.add_runtime_dependency "json"
 
   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.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -119,6 +133,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -136,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:
@@ -156,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.