yabeda-puma-plugin 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 334f667830d1f10ef87b752b222c0a48868f1e378b03d6d10e45e5d5289fa2ba
-  data.tar.gz: 764ec2ca14697304378c7cfca7663de24865a362b4664ff42dc4a1ff41f58df7
+  metadata.gz: ea655ec09c4edd3459d19356df62760dbb70049b24a0e5ccfb69eed7d501ec7d
+  data.tar.gz: 49cab44b0913f02a372473b3e8951a6c880020f3a22970c6f9cdadee7d3935ae
 SHA512:
-  metadata.gz: 5048143d5d9c98727de4e70adb78c46b2147d4d698f083035ff42a3783301a0df2255eeb65d3c603748e4de10fb00c8b2e0fe953a541499e6dc9cb05d0b775dc
-  data.tar.gz: 4052ecba8891d22691f7477b0e5fa1eb433a779385f32184f7467d3543f8ea6350ede81f10925268e9e522d67928d3c497be20d6647e354a2c2f27962b692aec
+  metadata.gz: d68acb875bb1d793d0bf6c11f1df91313ec730bcf9984f362829586bdb7810e21b809c60980cf606feec93378957b218d046bb30ced55858f8cc704c3b073380
+  data.tar.gz: e8e0c33afd4c639ef3abb25485bf2fb9a3598a288d07033ad64ebffd354335f17558aef856afc18d439fb03cf0c767026c9e348b31de6d1ff1cc91a653ca1c7e

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

@@ -0,0 +1,54 @@
+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)')
+          # 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//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=body::$BODY"
+      - name: Build gem
+        run: gem build
+      - name: Check version
+        run: ls 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: false
+      - name: Upload Release Asset
+        id: upload-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

data/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+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: 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/README.md

@@ -1,4 +1,4 @@
-<a href="https://amplifr.com/?utm_source=uibook">
+<a href="https://amplifr.com/?utm_source=yabeda-puma-plugin">
   <img width="100" height="140" align="right"
     alt="Sponsored by Amplifr" src="https://amplifr-direct.s3-eu-west-1.amazonaws.com/social_images/image/37b580d9-3668-4005-8d5a-137de3a3e77c.png" />
 </a>
@@ -14,7 +14,7 @@ Works as the Puma plugin and provides following metrics:
  - `puma_booted_workers` - the number of booted puma workers
  - `puma_old_workers` - the number of old puma worker
 
-Segmented by the worker:
+Segmented by the worker (index of the worker):
  - `puma_pool_capacity` - the capacity of each worker: the number of requests that the server is capable of taking right now. More details are [here](https://github.com/puma/puma/blob/0f8b10737e36fc24cdd572f76a739659b5fad9cb/lib/puma/server.rb#L167).
  - `puma_running` - the number of running threads (spawned threads) for any puma worker
  - `puma_max_threads` - preconfigured maximum number of worker threads
@@ -25,7 +25,7 @@ Segmented by the worker:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'yabeda-puma'
+gem 'yabeda-puma-plugin'
 ```
 
 And then execute:
@@ -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:
@@ -84,7 +132,7 @@ docker-compose run app bundle exec rspec
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yabeda-puma.
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-puma-plugin.
 
 ## License
 

data/lib/puma/plugin/yabeda.rb

@@ -14,14 +14,14 @@ 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'
+      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'
 
       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'
       end

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

@@ -7,13 +7,29 @@ module Yabeda
       module Statistics
         class Fetcher
           def self.call
-            body = Socket.unix(Yabeda::Puma::Plugin.control_url.gsub("unix://", '')) do |socket|
-              socket << "GET /stats?token=#{Yabeda::Puma::Plugin.control_auth_token} HTTP/1.0\r\n\r\n"
-              socket.read
+            control_url = Yabeda::Puma::Plugin.control_url
+
+            body = if control_url.start_with? "unix://"
+              path = control_url.gsub("unix://", '')
+              Socket.unix(path, &socket_block)
+            elsif control_url.start_with? "tcp://"
+              host, port = control_url.match(/^tcp:\/\/([a-z0-9\-._~%]+):([0-9]+)/).captures
+              Socket.tcp(host, port, &socket_block)
+            else
+              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.1.0"
+      VERSION = "0.5.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.2"
   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.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2020-11-13 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.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !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,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -129,6 +130,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,8 +156,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.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