yabeda-prometheus 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91ea963e20dc59d762257269ec9b4646857f610d99d47836ab18f4873088f97a
-  data.tar.gz: 01af29b75b3d3e2023643b9c67e22ea34662e87e4d6d78155a3f0b2262cf3240
+  metadata.gz: 03ed652a9c06383f38442a04db2ed423b0bf5c2bad99a0e34da5d965ed988ced
+  data.tar.gz: ec9f84a17b4f8b773a57985fe61cc4f6a0a4a67e4216f36683a0b8d5e6f95671
 SHA512:
-  metadata.gz: a1f48ae1345bce39bf3341a6f9f1d6c282fc4389f8eeded65ce1d6f400887698130346e8a1872790e08a45ce781e7b3ec620779f9ce02c7155181b5d3fd5b5d2
-  data.tar.gz: d77af840aa442ab415eab7eeb766331f84523ba1bea800fd4d71c1e5daa195953b28a01fa65b9f92f3dc1a4d8b4218dfb77e401c4994ae47baa179960836d6c8
+  metadata.gz: 45f454d796db3b1202bc238aadb4bb744686ddffe4efbf328ac172d3eeea6c21614a643d21ae49b971ca43eee0ad29b5ebb636773ebce0cd643620b3f99646f6
+  data.tar.gz: 1300508ed83ecefa768fb7ae6a8de08534eae83b2834fa9bf3577e77897ef7efb1a8ad5dfab88af92a1ba6c96caec9412dd14d48a1aa8938749bdfdaa17a5853

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

@@ -0,0 +1,82 @@
+name: Build and release gem to RubyGems
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        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
+      - name: "Extract data from tag: version, message, body"
+        id: tag
+        run: |
+          git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
+          echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
+          # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
+          BODY="${BODY}"$'\n'"${changelog}"
+          BODY="${BODY//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
+      - name: Build gem
+        run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-prometheus-${{ steps.tag.outputs.version }}.gem > SHA256SUM
+      - name: Check version
+        run: ls -l yabeda-prometheus-${{ steps.tag.outputs.version }}.gem
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ steps.tag.outputs.subject }}
+          body: ${{ steps.tag.outputs.body }}
+          draft: false
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: yabeda-prometheus-${{ steps.tag.outputs.version }}.gem
+          asset_name: yabeda-prometheus-${{ steps.tag.outputs.version }}.gem
+          asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          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: 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

@@ -0,0 +1,45 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: "Run tests"
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    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
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        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
+      - name: Run RSpec
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -5,6 +5,42 @@ 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.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
+
+ - 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
+
+ - Fixed issue with Push Gateway require. [#13](https://github.com/yabeda-rb/yabeda-prometheus/pull/13) by [@baarkerlounger].
+ - Fixed possible issue with rack absense in non-web applications. Declared it as a dependency. [@Envek]
+
 ## 0.6.0 - 2020-04-15
 
 ### Changed
@@ -99,4 +135,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
  - Initial release of evil-metrics-prometheus gem. @Envek
 
+[@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"
+[@palkan]: https://github.com/palkan "Vladimir Dementyev"
+[@ollym]: https://github.com/ollym "Oliver Morgan"

data/README.md

@@ -1,4 +1,4 @@
-# Yabeda::[Prometheus]
+# ![`Yabeda::Prometheus`](./yabeda-prometheus-logo.png)
 
 [![Gem Version](https://badge.fury.io/rb/yabeda-prometheus.svg)](https://rubygems.org/gems/yabeda-prometheus)
 
@@ -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,19 @@ 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).
+
+## 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.
@@ -96,6 +111,38 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-prometheus.
 
+### Releasing
+
+1. Bump version number in `lib/yabeda/prometheus/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::Prometheus::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/prometheus/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/prometheus/version.rb -e "puts Gem::Version.new(Yabeda::Prometheus::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "prometheus/middleware/exporter"
+require "rack"
 
 module Yabeda
   module Prometheus
@@ -17,11 +18,11 @@ module Yabeda
           @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::Handler::WEBrick.run(
+              rack_app(**rack_app_options),
               Host: ENV["PROMETHEUS_EXPORTER_BIND"] || "0.0.0.0",
               Port: ENV.fetch("PROMETHEUS_EXPORTER_PORT", default_port),
               AccessLog: [],
@@ -29,10 +30,10 @@ module Yabeda
           end
         end
 
-        def rack_app(exporter = self, path: "/metrics")
-          Rack::Builder.new do
-            use Rack::CommonLogger
-            use Rack::ShowExceptions
+        def rack_app(exporter = self, path: "/metrics", logger: Logger.new(IO::NULL))
+          ::Rack::Builder.new do
+            use ::Rack::CommonLogger, logger
+            use ::Rack::ShowExceptions
             use exporter, path: path
             run NOT_FOUND_HANDLER
           end
@@ -44,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.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/yabeda/prometheus.rb

@@ -2,6 +2,7 @@
 
 require "yabeda"
 require "prometheus/client"
+require "prometheus/client/push"
 require "yabeda/prometheus/version"
 require "yabeda/prometheus/adapter"
 require "yabeda/prometheus/exporter"
@@ -17,7 +18,7 @@ module Yabeda
         @push_gateway ||= begin
           ::Prometheus::Client::Push.new(
             ENV.fetch("PROMETHEUS_JOB_NAME", "yabeda"),
-            nil,
+            ENV["PROMETHEUS_INSTANCE"],
             ENV.fetch("PROMETHEUS_PUSH_GATEWAY", "http://localhost:9091"),
           ).tap do |gateway|
             http = gateway.instance_variable_get(:@http)

data/yabeda-prometheus.gemspec

@@ -28,9 +28,10 @@ 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", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -36,42 +36,56 @@ 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
+    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: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,10 +107,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -108,6 +123,7 @@ files:
 - lib/yabeda/prometheus/adapter.rb
 - lib/yabeda/prometheus/exporter.rb
 - lib/yabeda/prometheus/version.rb
+- yabeda-prometheus-logo.png
 - yabeda-prometheus.gemspec
 homepage: https://github.com/yabeda-rb/yabeda-prometheus
 licenses:
@@ -131,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Extensible Prometheus exporter for your application

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1