yabeda-prometheus 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec39031cd5a8edd3f8ab3badfac7568683e2d15dd84eb2adfacd0953af9a4f1b
-  data.tar.gz: 68e2c9f81ab756ff009ce0d3e638cf6391fe7e7d9a02ee482857843462db66a7
+  metadata.gz: c36a4a73e4e698126e81bf8cb5069de6521ac396742a59dc13a906b2e6470f12
+  data.tar.gz: 67b7b8d5d56cff197c47bbac7b27d9a3eefe3cbbc1f63a01d8d35d2d4cd97305
 SHA512:
-  metadata.gz: 267557ee543e48873693cfb61c31e1e535f75c0947355f3d613aac372b132848b481a5aa03fe9d1f0c2709b34482df189dd28a18039d84023384ee61016b6d52
-  data.tar.gz: f32dfd90a9814d1eef154cb36486029467d22792cd21d63dc57f9bc3028f87d2f4d939429d58a75fb6fc8e5cffd5d3d56aaa0da2f663e868c3c6d8e3c8e4be25
+  metadata.gz: 25eae376eda44fd094891a717efaf877bd629b7ae9fcb0867ecf146fd0ea70e1afc7df3d24f8e615c4be11081004719de67bbfd89cacdeb011e51d74a331f1b4
+  data.tar.gz: 7184e70ea9a35daaf7b29e4fc8e2f9fd18e6b89679d1a4ebcb97722e359853e5723ace3a17cc3fb4a132947f758f2a4e88ccd6a8fe30bd7b48ff5d0872d46de4

data/CHANGELOG.md

@@ -5,6 +5,24 @@ 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).
 
+## Unreleased
+
+## 0.7.0 - 2021-07-21
+
+### Added
+
+ - Debug mode with metric `yabeda_prometheus_render_duration` to measure how long takes to render response with already collected metrics for Prometheus. Requires Yabeda 0.10+. [@Envek], [@dsalahutdinov]
+
+### Changed
+
+ - Yabeda 0.10.0 or newer is required. [@Envek]
+
+## 0.6.2 - 2021-06-23
+
+### Fixed
+
+ - Fix `uninitialized constant Yabeda::Rack::Handler (NameError)` when using [yabeda-rack-attack](https://github.com/dsalahutdinov/yabeda-rack-attack). [@dsalahutdinov]
+
 ## 0.6.1 - 2020-04-28
 
 ### Changed
@@ -109,3 +127,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [@Envek]: https://github.com/Envek "Andrey Novikov"
 [@alexander37137]: https://github.com/alexander37137 "Alexander Andreev"
 [@baarkerlounger]: https://github.com/baarkerlounger "Daniel Baark"
+[@dsalahutdinov]: https://github.com/dsalahutdinov "Dmitry Salahutdinov"

data/README.md

@@ -48,6 +48,8 @@ And then execute:
 
     WEBrick will be launched in separate thread and will serve metrics on `/metrics` path.
 
+    > **ATTENTION**: Starting from Ruby 3.0 WEBrick isn't included with Ruby by default. You should either add `gem "webrick"` into your Gemfile or launch `Yabeda::Prometheus::Exporter.rack_app` with application server of your choice.
+
     See [yabeda-sidekiq] for example.
 
     Listening address is configured via `PROMETHEUS_EXPORTER_BIND` env variable (default is `0.0.0.0`).
@@ -86,6 +88,12 @@ group :some do
 end
 ```
 
+## Debugging metrics
+
+ - Time of already collected metrics rendering in response for Prometheus: `yabeda_prometheus_render_duration`.
+
+These are only enabled in debug mode. See [Yabeda debugging metrics](https://github.com/yabeda-rb/yabeda#debugging-metrics) on how to enable it  (e.g. by specifying `YABEDA_DEBUG=true` in your environment variables).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/yabeda/prometheus/adapter.rb

@@ -83,6 +83,17 @@ module Yabeda
       raise ArgumentError, 'Prometheus require metrics to have comments'
     end
 
+    def debug!
+      Yabeda.configure do
+        group :prometheus_exporter
+
+        histogram :render_duration,
+                  tags: %i[], unit: :seconds,
+                  buckets: [0.001, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10],
+                  comment: "Time required to render all metrics in Prometheus format"
+      end
+    end
+
     private
 
     # @param metric [Yabeda::Metric]

data/lib/yabeda/prometheus/exporter.rb

@@ -45,8 +45,17 @@ module Yabeda
       end
 
       def call(env)
-        Yabeda.collectors.each(&:call) if env["PATH_INFO"] == path
-        super
+        ::Yabeda.collect! if env["PATH_INFO"] == path
+
+        if ::Yabeda.debug?
+          result = nil
+          ::Yabeda.prometheus_exporter.render_duration.measure({}) do
+            result = super
+          end
+          result
+        else
+          super
+        end
       end
     end
   end

data/lib/yabeda/prometheus/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Prometheus
-    VERSION = "0.6.2"
+    VERSION = "0.7.0"
   end
 end

data/yabeda-prometheus.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.3"
 
   spec.add_dependency "prometheus-client", ">= 0.10", "< 3.0" # Known to work with 1.x and 2.x
-  spec.add_dependency "yabeda", "~> 0.5"
+  spec.add_dependency "yabeda", "~> 0.10"
   spec.add_dependency "rack"
 
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement