yabeda-prometheus 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ed652a9c06383f38442a04db2ed423b0bf5c2bad99a0e34da5d965ed988ced
-  data.tar.gz: ec9f84a17b4f8b773a57985fe61cc4f6a0a4a67e4216f36683a0b8d5e6f95671
+  metadata.gz: 178705f128fcff8d9fc98c8b2db3a8b9a031d2b282f99cd522587389cd3f8001
+  data.tar.gz: c800d08198dcd1b62b94daabcbe0c7fdedd8c5cf5320992a63b4606475bb7f73
 SHA512:
-  metadata.gz: 45f454d796db3b1202bc238aadb4bb744686ddffe4efbf328ac172d3eeea6c21614a643d21ae49b971ca43eee0ad29b5ebb636773ebce0cd643620b3f99646f6
-  data.tar.gz: 1300508ed83ecefa768fb7ae6a8de08534eae83b2834fa9bf3577e77897ef7efb1a8ad5dfab88af92a1ba6c96caec9412dd14d48a1aa8938749bdfdaa17a5853
+  metadata.gz: e78322f06706eb11df51cfd56bcba9890c7da377437e67a1ce021a55377b616e950dceb983cb2f654fa3c501f4e14bf73ffe7d07f8ce108837c9c009694c595d
+  data.tar.gz: 0c8eb49c988fb20e4c4154a78f4e027f35c6d216ed2c832aecb503e188f253b9c3fa6ca345e0319893ad4497e1a9f29d2213f1642b792fd22113a3262de92db4

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

@@ -8,13 +8,18 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      packages: write
+
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         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
+          ruby-version: 3.2
       - name: "Extract data from tag: version, message, body"
         id: tag
         run: |
@@ -75,8 +80,8 @@ jobs:
           GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
         run: |
           gem push yabeda-prometheus-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Configure RubyGems Credentials
+        uses: rubygems/configure-rubygems-credentials@main
       - name: Publish to RubyGems
-        env:
-          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
         run: |
           gem push yabeda-prometheus-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run tests
+name: Tests
 
 on:
   pull_request:
@@ -10,36 +10,24 @@ on:
 
 jobs:
   test:
-    name: "Run tests"
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
+    name: 'Ruby ${{ matrix.ruby }}'
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - ruby: 3.0
-          - ruby: 2.7
-          - ruby: 2.6
-          - ruby: 2.5
-    container:
-      image: ruby:${{ matrix.ruby }}
-      env:
-        CI: true
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         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
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Run RSpec
         run: bundle exec rspec

data/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 0.9.1 - 2024-01-04
+
+### Fixed
+
+- Compatibility with Rack 3 and Rack 2. [#27](https://github.com/yabeda-rb/yabeda-prometheus/pull/27) by [@aroop][].
+
+## 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
@@ -141,3 +158,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [@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"
+[@aroop]: https://github.com/aroop "Ajay Guthikonda"

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, …):
 

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,14 +14,15 @@ 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!(**rack_app_options)
           Thread.new do
             default_port = ENV.fetch("PORT", 9394)
-            ::Rack::Handler::WEBrick.run(
+            rack_handler.run(
               rack_app(**rack_app_options),
               Host: ENV["PROMETHEUS_EXPORTER_BIND"] || "0.0.0.0",
               Port: ENV.fetch("PROMETHEUS_EXPORTER_PORT", default_port),
@@ -30,14 +31,27 @@ module Yabeda
           end
         end
 
-        def rack_app(exporter = self, path: "/metrics", logger: Logger.new(IO::NULL))
+        def rack_app(exporter = self, logger: Logger.new(IO::NULL), use_deflater: true, **exporter_options)
           ::Rack::Builder.new do
+            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
+
+        def rack_handler
+          if Gem.loaded_specs['rack']&.version&.>= Gem::Version.new('3.0')
+            require 'rackup'
+            ::Rackup::Handler::WEBrick
+          else
+            ::Rack::Handler::WEBrick
+          end
+        rescue LoadError
+          warn 'Please add gems rackup and webrick to your Gemfile to expose Yabeda metrics from prometheus-mmap'
+          ::Rack::Handler::WEBrick
+        end
       end
 
       def initialize(app, options = {})

data/lib/yabeda/prometheus/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Prometheus
-    VERSION = "0.8.0"
+    VERSION = "0.9.1"
   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"),
-            ENV["PROMETHEUS_INSTANCE"],
-            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.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2024-01-04 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
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Extensible Prometheus exporter for your application