yabeda-puma-plugin 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d2eced94a7f0365f65189ef0002ae70d555e5c9fa02a5c3a9692f6b8a8ae65
-  data.tar.gz: 232a6e796501204873651b557439cc6ecdd525b2688b7fbf77059e7b41431a8a
+  metadata.gz: 0e89900f2439ba78c8c813c423c1035133934fd7b727d355fe16be5416b40ef5
+  data.tar.gz: 1b99f6bebac908ad72fd85522b41823a42593262057cea0abb3c2c6dd9768501
 SHA512:
-  metadata.gz: 6f7d371011d50c329ccdd0e16da01291b07cff94da8825ea9b378c98d1d103a3a2c162b22bdff8e412c5b693b056b4d04b8c245b2b73b0e7fffeac174668ee6d
-  data.tar.gz: 519e7962f993e9f64d4d58a3db2c9c4bf377802c286216700d8d5b6508689afc21622e3a75ebd44ace6ae534dc1b59a0f8f465dbbabf324a191c6248b6a0a412
+  metadata.gz: 2f586fcfa8cef7892afa68690c23cb6c73c70964bed54b0ce65d5434513490b91c133d2ef2e9709ad352dde50f6ebf1dea3c884e67b668737d8cfb0eb783c215
+  data.tar.gz: 97c8662a33acdd7102d90faa8725ee86269587c8c3f104dc49ae0621793c66e6f9f5ddf8660f0dbec11598e700dc97db32dcb51073c96384f4273baa20946ac6

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

@@ -0,0 +1,82 @@
+name: Build and release gem to RubyGems
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: "Extract data from tag: version, message, body"
+        id: tag
+        run: |
+          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 -l yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ steps.tag.outputs.subject }}
+          body: ${{ steps.tag.outputs.body }}
+          draft: false
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem 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: 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

@@ -0,0 +1,45 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: "Run tests"
+    if: "! contains(toJSON(github.event.commits.latest.message), '[ci skip]')"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 3.0
+          - ruby: 2.7
+          - ruby: 2.6
+          - ruby: 2.5
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CI: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+            bundle-${{ matrix.ruby }}-
+      - name: Upgrade Bundler to 2.0 (for older Rubies)
+        run: gem install bundler -v '~> 2.0'
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+          bundle update
+      - name: Run RSpec
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# 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.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]
+
+[@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/README.md

@@ -34,6 +34,8 @@ And then execute:
 
 ## Usage
 
+### Collecting metrics
+
 Add those 2 lines of code to your `config/puma.rb` file:
 ```ruby
 activate_control_app
@@ -41,6 +43,52 @@ 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.
 
+### 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.
+
+#### Prometheus
+
+##### On the same endpoint with your application
+
+For non-Rails applications place following line in your `config.ru` _before_ running your application:
+
+```ruby
+use Yabeda::Prometheus::Exporter, path: "/metrics"
+```
+
+In Ruby on Rails applications you can add following line in `config/routes.rb` instead:
+
+```ruby
+mount Yabeda::Prometheus::Exporter => "/metrics"
+```
+
+In both cases your Puma instance metrics (along with your application metrics) will be available at `/metrics` endpoint.
+
+##### On different port
+
+Sometimes you don't want to expose metrics publicly for security reasons. For that case prometheus exporter plugin is bundled with this gem.
+
+Don't forget to add either `yabeda-prometheus` or `yabeda-prometheus-mmap` gem into your `Gemfile`!
+
+Add this plugin into your `config/puma.rb`:
+
+```ruby
+plugin :yabeda_prometheus
+```
+
+By default metrics will be available at `http://0.0.0.0:9394/metrics`.
+
+Bind host, port, and path can be controlled either by config file option `prometheus_exporter_url`:
+
+```ruby
+# config/puma.rb
+prometheus_exporter_url "tcp://127.0.0.1:9395/shmetrics"
+```
+
+Or by environment variables `PROMETHEUS_EXPORTER_URL`, `PROMETHEUS_EXPORTER_BIND`, `PROMETHEUS_EXPORTER_PORT`, and `PROMETHEUS_EXPORTER_PATH` (takes precedence over configuration option).
+
+
 ## Details
 
 In accordance with the [architecture](https://github.com/puma/puma/blob/master/docs/architecture.md) of the puma web server lets look how it works:
@@ -86,6 +134,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/lib/puma/plugin/yabeda.rb

@@ -14,16 +14,16 @@ Puma::Plugin.create do
 
     Yabeda.configure do
       group :puma
-      
-      gauge :backlog, comment: 'Number of established but unaccepted connections in the backlog'
-      gauge :running, comment: 'Number of running worker threads'
-      gauge :pool_capacity, comment: 'Number of allocatable worker threads'
-      gauge :max_threads, comment: 'Maximum number of worker threads'
-      gauge :workers, comment: 'Number of configured workers'
+
+      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 :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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+begin
+  require 'yabeda/prometheus/exporter'
+rescue LoadError
+  raise LoadError, 'Please add either yabeda-prometheus or yabeda-prometheus-mmap gem into your Gemfile to use yabeda/prometheus/exporter!'
+end
+
+require 'uri'
+require 'rack'
+
+module Puma
+  class DSL
+    def prometheus_exporter_url(uri)
+      @options[:prometheus_exporter_url] = uri
+    end
+  end
+end
+
+Puma::Plugin.create do
+  def start(launcher)
+    events = launcher.events
+
+    uri = launcher.options.fetch(:prometheus_exporter_url, 'tcp://0.0.0.0:9394/metrics')
+    uri = URI.parse(ENV.fetch('PROMETHEUS_EXPORTER_URL', uri))
+    host = ENV.fetch('PROMETHEUS_EXPORTER_BIND', uri.host)
+    port = Integer(ENV.fetch('PROMETHEUS_EXPORTER_PORT', uri.port))
+    path = ENV.fetch('PROMETHEUS_EXPORTER_PATH', uri.path)
+
+    events.on_booted do
+      app = Yabeda::Prometheus::Exporter.rack_app(Yabeda::Prometheus::Exporter, path: path)
+
+      metrics = Puma::Server.new app, events
+      metrics.min_threads = 0
+      metrics.max_threads = 1
+
+      events.log "* Starting Yabeda Prometheus metrics exporter on http://#{host}:#{port}#{path}"
+      metrics.add_tcp_listener host, port
+
+      events.register(:state) do |state|
+        if %i[halt restart stop].include?(state)
+          metrics.stop(true) unless metrics.shutting_down?
+        end
+      end
+
+      metrics.run
+    end
+  end
+end

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

@@ -2,8 +2,8 @@ module Yabeda
   module Puma
     module Plugin
       module Statistics
-        METRICS = [:backlog, :running, :pool_capacity, :max_threads, :workers]
-        CLUSTERED_METRICS = [:booted_workers, :old_workers]
+        METRICS = [:backlog, :running, :pool_capacity, :max_threads]
+        CLUSTERED_METRICS = [:booted_workers, :old_workers, :workers]
       end
     end
   end

data/lib/yabeda/puma/plugin/statistics/fetcher.rb

@@ -9,24 +9,27 @@ module Yabeda
           def self.call
             control_url = Yabeda::Puma::Plugin.control_url
 
-            if control_url.start_with? "unix://"
+            body = if control_url.start_with? "unix://"
               path = control_url.gsub("unix://", '')
-              sock = Socket.unix(path)
+              Socket.unix(path, &socket_block)
             elsif control_url.start_with? "tcp://"
               host, port = control_url.match(/^tcp:\/\/([a-z0-9\-._~%]+):([0-9]+)/).captures
-
-              sock = Socket.tcp(host, port)
+              Socket.tcp(host, port, &socket_block)
             else
-              raise ArgumentError("Unknown puma control url type #{control_url}")
-            end
-
-            body = sock do |socket|
-              socket << "GET /stats?token=#{Yabeda::Puma::Plugin.control_auth_token} HTTP/1.0\r\n\r\n"
-              socket.read
+              raise ArgumentError.new("Unknown puma control url type #{control_url}")
             end
 
             JSON.parse(body.split("\n").last)
           end
+
+          private
+
+          def self.socket_block
+            Proc.new do |s|
+              s << "GET /stats?token=#{Yabeda::Puma::Plugin.control_auth_token} HTTP/1.0\r\n\r\n"
+              s.read
+            end
+          end
         end
       end
     end

data/lib/yabeda/puma/plugin/statistics/parser.rb

@@ -13,21 +13,33 @@ module Yabeda
           end
 
           def call
-            Array.new.tap { |result| parse(data, result) }
+            [].tap { |result| parse(data, {}, result) }
           end
 
           private
 
-          def parse(stats, labels = {}, result)
+          def parse(stats, labels, result)
             stats.each do |key, value|
-              value.each { |s| parse(s, labels.merge(index: s['index']), result) } if key == 'worker_status'
-              parse(value, labels, result) if key == 'last_status'
-              result << {name: key, value: value, labels: labels} if metric?(key)
+              case key
+              when 'worker_status'
+                value.each { |s| parse(s, labels.merge(index: s['index']), result) }
+              when 'last_status'
+                parse(value, labels, result)
+              else
+                next unless metric?(key)
+
+                l = clustered_metric?(key) ? labels : { index: 0 }.merge(labels)
+                result << { name: key, value: value, labels: l }
+              end
             end
           end
 
           def metric?(name)
-            Statistics::METRICS.include?(name.to_sym) || (Statistics::CLUSTERED_METRICS.include?(name.to_sym) && clustered)
+            Statistics::METRICS.include?(name.to_sym) || clustered_metric?(name)
+          end
+
+          def clustered_metric?(name)
+            clustered && Statistics::CLUSTERED_METRICS.include?(name.to_sym)
           end
         end
       end

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

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

data/yabeda-puma-plugin.gemspec

@@ -21,12 +21,12 @@ 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"
+  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", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rack"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-puma-plugin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,9 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -129,6 +131,7 @@ files:
 - docs/diagram.png
 - docs/grafana.png
 - lib/puma/plugin/yabeda.rb
+- lib/puma/plugin/yabeda_prometheus.rb
 - lib/yabeda/puma/plugin.rb
 - lib/yabeda/puma/plugin/statistics.rb
 - lib/yabeda/puma/plugin/statistics/fetcher.rb
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Puma web server plugin for collecting puma metrics with Yabeda framework.

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: require
-services:
-  - docker
-
-before_script:
-  - unset BUNDLE_GEMFILE
-  - docker-compose run app bundle install
-script:
-  - docker-compose run app bundle exec rspec