yabeda-prometheus 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36a4a73e4e698126e81bf8cb5069de6521ac396742a59dc13a906b2e6470f12
-  data.tar.gz: 67b7b8d5d56cff197c47bbac7b27d9a3eefe3cbbc1f63a01d8d35d2d4cd97305
+  metadata.gz: 906db4d10bd83296b001ddaa09d01bb01adb55299f054cd484c52cb8e1168dd8
+  data.tar.gz: 870e978d2065aa4ef51904b34bdd6ea38cdd48e2a5ddb19ecab4792f3d5e0194
 SHA512:
-  metadata.gz: 25eae376eda44fd094891a717efaf877bd629b7ae9fcb0867ecf146fd0ea70e1afc7df3d24f8e615c4be11081004719de67bbfd89cacdeb011e51d74a331f1b4
-  data.tar.gz: 7184e70ea9a35daaf7b29e4fc8e2f9fd18e6b89679d1a4ebcb97722e359853e5723ace3a17cc3fb4a132947f758f2a4e88ccd6a8fe30bd7b48ff5d0872d46de4
+  metadata.gz: d25b3c9449c812c329f1f6fb3acd0dcebc93a73a5895d37e2d6b76a0b3a3d3ee5b7aa04d80111469de5b0f76dfcd6986f6f5b64c8e30b52aec9196116dbda478
+  data.tar.gz: 1506ce4596bf8aaef915a1b098f32a376e7d9ec7771f2a40b02c972e9dfc38ffbc7f49171387aa5c44766329a18d26705c24019296bc0cb543594d254ea216d3

data/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 0.9.0 - 2023-07-28
+
+### Added
+
+- Support for summary metric type (Yabeda 0.12+ is required). [@Envek]
+- Metrics endpoint response compression with Rack Deflater. [@etsenake], ([#23](https://github.com/yabeda-rb/yabeda-prometheus/pull/23)
+
+### Changed
+
+- prometheus-client 3.x or 4.x is required. [@Envek]
+
+## 0.8.0 - 2021-12-30
+
+### Added
+
+- Ability to specify a logger instance for exporter web server. [@palkan], [#19](https://github.com/yabeda-rb/yabeda-prometheus/pull/19)
+- Ability to specify Prometheus instance value for push gateway. [@ollym], [#20](https://github.com/yabeda-rb/yabeda-prometheus/pull/20)
+
+### Changed
+
+- Logging is disabled by default for exporter web server. [@palkan], [#19](https://github.com/yabeda-rb/yabeda-prometheus/pull/19)
+
 ## 0.7.0 - 2021-07-21
 
 ### Added
@@ -128,3 +150,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [@alexander37137]: https://github.com/alexander37137 "Alexander Andreev"
 [@baarkerlounger]: https://github.com/baarkerlounger "Daniel Baark"
 [@dsalahutdinov]: https://github.com/dsalahutdinov "Dmitry Salahutdinov"
+[@palkan]: https://github.com/palkan "Vladimir Dementyev"
+[@ollym]: https://github.com/ollym "Oliver Morgan"
+[@etsenake]: https://github.com/etsenake "Josh Etsenake"

data/Gemfile

@@ -8,6 +8,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :development, :test do
+  gem "yabeda", ">= 0.12", github: "yabeda-rb/yabeda", branch: "master"
+
   gem "pry"
   gem "pry-byebug", platform: :mri
 

data/README.md

@@ -36,9 +36,17 @@ And then execute:
     use Yabeda::Prometheus::Exporter
     ```
 
-    Metrics will be available on `/metrics` path (configured by `:path` option).
+    Metrics will be available on `/metrics` path (configured by `:path` option), additionally metrics can be served only on specific port with `:port` option.
 
-    Also you can mount it in Rails application routes as standalone Rack application.
+    Alternatively you can mount it in Rails application routes as standalone Rack application:
+
+    ```ruby
+    Rails.application.routes.draw do
+      mount Yabeda::Prometheus::Exporter, at: "/metrics"
+    end
+    ```
+
+    Additional options (like `:port`) are also accepted and forwarded to [Prometheys Exporter](https://github.com/prometheus/client_ruby/blob/main/lib/prometheus/middleware/exporter.rb) middleware.
 
  2. Run web-server from long-running processes (delayed jobs, …):
 
@@ -94,6 +102,13 @@ end
 
 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).
 
+## Exporter logs
+
+By default, exporter web server logs are disabled. For example, you can plug in a Rails logger:
+
+```ruby
+Yabeda::Prometheus::Exporter.start_metrics_server! logger: Rails.application.logger
+```
 ## 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

@@ -73,6 +73,22 @@ module Yabeda
       raise UndeclaredMetricTags.new(build_name(metric), e)
     end
 
+    def register_summary!(metric)
+      validate_metric!(metric)
+      registry.summary(
+        build_name(metric),
+        docstring: metric.comment,
+        labels: Array(metric.tags),
+        store_settings: store_settings(metric),
+      )
+    end
+
+    def perform_summary_observe!(metric, tags, value)
+      registry.get(build_name(metric)).observe(value, labels: tags)
+    rescue ::Prometheus::Client::LabelSetValidator::InvalidLabelSetError => e
+      raise UndeclaredMetricTags.new(build_name(metric), e)
+    end
+
     def build_name(metric)
       [metric.group, metric.name, metric.unit].compact.join('_').to_sym
     end

data/lib/yabeda/prometheus/exporter.rb

@@ -14,15 +14,16 @@ module Yabeda
       class << self
         # Allows to use middleware as standalone rack application
         def call(env)
-          @app ||= new(NOT_FOUND_HANDLER, path: "/")
+          options = env.fetch("action_dispatch.request.path_parameters", {})
+          @app ||= new(NOT_FOUND_HANDLER, path: "/", **options)
           @app.call(env)
         end
 
-        def start_metrics_server!
+        def start_metrics_server!(**rack_app_options)
           Thread.new do
             default_port = ENV.fetch("PORT", 9394)
             ::Rack::Handler::WEBrick.run(
-              rack_app,
+              rack_app(**rack_app_options),
               Host: ENV["PROMETHEUS_EXPORTER_BIND"] || "0.0.0.0",
               Port: ENV.fetch("PROMETHEUS_EXPORTER_PORT", default_port),
               AccessLog: [],
@@ -30,11 +31,12 @@ module Yabeda
           end
         end
 
-        def rack_app(exporter = self, path: "/metrics")
+        def rack_app(exporter = self, logger: Logger.new(IO::NULL), use_deflater: true, **exporter_options)
           ::Rack::Builder.new do
-            use ::Rack::CommonLogger
+            use ::Rack::Deflater if use_deflater
+            use ::Rack::CommonLogger, logger
             use ::Rack::ShowExceptions
-            use exporter, path: path
+            use exporter, **exporter_options
             run NOT_FOUND_HANDLER
           end
         end

data/lib/yabeda/prometheus/version.rb

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

data/lib/yabeda/prometheus.rb

@@ -15,17 +15,12 @@ module Yabeda
       end
 
       def push_gateway
-        @push_gateway ||= begin
+        @push_gateway ||=
           ::Prometheus::Client::Push.new(
-            ENV.fetch("PROMETHEUS_JOB_NAME", "yabeda"),
-            nil,
-            ENV.fetch("PROMETHEUS_PUSH_GATEWAY", "http://localhost:9091"),
-          ).tap do |gateway|
-            http = gateway.instance_variable_get(:@http)
-            http.open_timeout = 5
-            http.read_timeout = 5
-          end
-        end
+            job: ENV.fetch("PROMETHEUS_JOB_NAME", "yabeda"),
+            gateway: ENV.fetch("PROMETHEUS_PUSH_GATEWAY", "http://localhost:9091"),
+            open_timeout: 5, read_timeout: 30,
+          )
       end
     end
   end

data/yabeda-prometheus.gemspec

@@ -27,7 +27,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 "prometheus-client", ">= 3.0", "< 5.0"
   spec.add_dependency "yabeda", "~> 0.10"
   spec.add_dependency "rack"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement