yabeda-puma-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 334f667830d1f10ef87b752b222c0a48868f1e378b03d6d10e45e5d5289fa2ba
+  data.tar.gz: 764ec2ca14697304378c7cfca7663de24865a362b4664ff42dc4a1ff41f58df7
+SHA512:
+  metadata.gz: 5048143d5d9c98727de4e70adb78c46b2147d4d698f083035ff42a3783301a0df2255eeb65d3c603748e4de10fb00c8b2e0fe953a541499e6dc9cb05d0b775dc
+  data.tar.gz: 4052ecba8891d22691f7477b0e5fa1eb433a779385f32184f7467d3543f8ea6350ede81f10925268e9e522d67928d3c497be20d6647e354a2c2f27962b692aec

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.byebug_history
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'prometheus-client'
+gem 'yabeda-prometheus'
+# Specify your gem's dependencies in yabeda-puma.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Salahutdinov Dmitry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Salahutdinov Dmitry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+<a href="https://amplifr.com/?utm_source=uibook">
+  <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>
+
+# Yabeda::Puma::Plugin
+
+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.
+
+## Metrics
+
+Works as the Puma plugin and provides following metrics:
+ - `puma_workers` - the number of running puma workers
+ - `puma_booted_workers` - the number of booted puma workers
+ - `puma_old_workers` - the number of old puma worker
+
+Segmented by 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
+ - `puma_backlog` - the number of backlog threads, the number of connections in that worker's "todo" set waiting for a worker thread.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-puma'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add those 2 lines of code to your `config/puma.rb` file:
+```ruby
+activate_control_app
+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.
+
+## 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:
+
+![Yabeda::Puma get metrics from puma control app over the unix socket](docs/diagram.png).
+
+
+For the configuration above, we will have the list of metrics (with help of `yabeda-prometheus` exporter):
+```
+GET /metrics
+
+puma_backlog{index="0"} 0
+puma_backlog{index="1"} 0
+puma_running{index="0"} 5
+puma_running{index="1"} 5
+puma_pool_capacity{index="0"} 1
+puma_pool_capacity{index="1"} 5
+puma_max_threads{index="0"} 5
+puma_max_threads{index="1"} 5
+puma_workers 2
+puma_booted_workers 2
+puma_old_workers 0
+```
+
+See also the grafana screenshot of monitoring puma pool size and it's capacity when application is overloaded:
+
+![Monitor puma metrics with grafana](docs/grafana.png).
+
+
+## Roadmap (TODO or Help wanted)
+
+- Collect also `control-gc` puma metrics
+
+## Development with Docker
+
+Get local development environment working and tests running is very easy with docker-compose:
+```bash
+docker-compose run app bundle
+docker-compose run app bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yabeda-puma.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yabeda/puma"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.4'
+
+services:
+  app:
+    image: ruby:2.6.0
+    environment:
+      - BUNDLE_PATH=/bundle
+      - BUNDLE_CONFIG=/app/.bundle/config
+    command: bash
+    working_dir: /app
+    volumes:
+      - .:/app:cached
+      - bundler_data:/bundle
+    tmpfs:
+      - /tmp
+
+volumes:
+  bundler_data:

data/lib/puma/plugin/yabeda.rb

@@ -0,0 +1,40 @@
+require 'yabeda/puma/plugin.rb'
+
+Puma::Plugin.create do
+  def start(launcher)
+    clustered = (launcher.options[:workers] || 0) > 0
+
+    control_url = launcher.options[:control_url]
+    raise StandardError, "Puma control app is not activated" if control_url == nil
+
+    Yabeda::Puma::Plugin.tap do |puma|
+      puma.control_url = control_url
+      puma.control_auth_token = launcher.options[:control_auth_token]
+    end
+
+    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'
+
+      if clustered
+        gauge :booted_workers, comment: 'Number of booted workers'
+        gauge :old_workers, comment: 'Number of old workers'
+      end
+
+      collect do
+        require 'yabeda/puma/plugin/statistics/fetcher'
+        stats = Yabeda::Puma::Plugin::Statistics::Fetcher.call
+        require 'yabeda/puma/plugin/statistics/parser'
+        Yabeda::Puma::Plugin::Statistics::Parser.new(clustered: clustered, data: stats).call.each do |item|
+          send("puma_#{item[:name]}").set(item[:labels], item[:value])
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,21 @@
+require 'yabeda/puma/plugin/statistics'
+require 'json'
+
+module Yabeda
+  module Puma
+    module Plugin
+      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
+            end
+
+            JSON.parse(body.split("\n").last)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'yabeda/puma/plugin/statistics'
+
+module Yabeda
+  module Puma
+    module Plugin
+      module Statistics
+        class Parser
+          attr_reader :clustered, :data
+
+          def initialize(clustered:, data:)
+            @clustered = clustered
+            @data = data
+          end
+
+          def call
+            Array.new.tap { |result| parse(data, result) }
+          end
+
+          private
+
+          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)
+            end
+          end
+
+          def metric?(name)
+            Statistics::METRICS.include?(name.to_sym) || (Statistics::CLUSTERED_METRICS.include?(name.to_sym) && clustered)
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,7 @@
+module Yabeda
+  module Puma
+    module Plugin
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/yabeda/puma/plugin.rb

@@ -0,0 +1,12 @@
+require "yabeda/puma/plugin/version"
+require 'yabeda'
+
+module Yabeda
+  module Puma
+    module Plugin
+      class << self
+        attr_accessor :control_url, :control_auth_token
+      end
+    end
+  end
+end

data/yabeda-puma-plugin.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yabeda/puma/plugin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yabeda-puma-plugin"
+  spec.version       = Yabeda::Puma::Plugin::VERSION
+  spec.authors       = ["Salahutdinov Dmitry"]
+  spec.email         = ["dsalahutdinov@gmail.com"]
+
+  spec.summary       = %q{Puma web server plugin for collecting puma metrics with Yabeda framework.}
+  spec.description   = %q{Extends Yabeda metrics with puma web server values by using puma plugin}
+  spec.homepage      = "http://github.com/yabeda-rb/yabeda-puma-plugin"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "yabeda"
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "rack"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-puma-plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salahutdinov Dmitry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends Yabeda metrics with puma web server values by using puma plugin
+email:
+- dsalahutdinov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- docs/diagram.png
+- docs/grafana.png
+- lib/puma/plugin/yabeda.rb
+- lib/yabeda/puma/plugin.rb
+- lib/yabeda/puma/plugin/statistics.rb
+- lib/yabeda/puma/plugin/statistics/fetcher.rb
+- lib/yabeda/puma/plugin/statistics/parser.rb
+- lib/yabeda/puma/plugin/version.rb
+- yabeda-puma-plugin.gemspec
+homepage: http://github.com/yabeda-rb/yabeda-puma-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Puma web server plugin for collecting puma metrics with Yabeda framework.
+test_files: []