yabeda-puma-plugin 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94f38e97079338e19849ddc164b859f9ea221d1842347f86d25e4809b507615
-  data.tar.gz: 5fec9afef71af361875885ad5dd6006d49518d5fb9d5582f89883453a6539752
+  metadata.gz: 7ec5a12b14554eb6e0a7b62d76ab1360501f600348c71e779005a4bca8624a3d
+  data.tar.gz: 9be1f9b5b0f6d7516848673d7a2e49e1ab18282d1c7ae1c1dbd79612d0befa5c
 SHA512:
-  metadata.gz: 5c554a0d7a13f92c6e1d64741e1a03295901f0562d8f49e3f3dedf5d828eac484e1f23083842a21f40f5002d11357d7bf52f3efada435a21e7d676fd5a02e5b5
-  data.tar.gz: f468a304b54fefbe4f2b5585259ddcf15088c4f0a993a8da9ff9a0b0f5646e25da67ea9b8aae861c93546b65e147101682d7bc60d02f97829a796e1ae73bdc1c
+  metadata.gz: 250d92d5d1fb71f8a9b5d04d07e2ce33e5cad0cb61428c2f728b22df567d13c87959e4e0f3add1aefd1bf29112d2e2686edb4a0cae2f857e988b716a48579060
+  data.tar.gz: 5b637cd1c1c3cc0ae935beaf9c0bc05a65053bc3aec696f09e2b3920c0164cdaac3692a100a8c4a8d944399174317576feabddfde2179446ab7db3b25d32b4b2

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:

data/lib/puma/plugin/yabeda_prometheus.rb

@@ -0,0 +1,47 @@
+# 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)
+
+    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

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

@@ -1,7 +1,7 @@
 module Yabeda
   module Puma
     module Plugin
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-puma-plugin
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
@@ -129,6 +129,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