yabeda-prometheus 0.1.5 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf7f044078d39963972005e5dab30c8fa8d908ca9b1d667ce60fc36295e7fb91
-  data.tar.gz: bd89b7fa736a501e417345951c642d601af60dd537a8c03a80a11678990e61d1
+  metadata.gz: ec39031cd5a8edd3f8ab3badfac7568683e2d15dd84eb2adfacd0953af9a4f1b
+  data.tar.gz: 68e2c9f81ab756ff009ce0d3e638cf6391fe7e7d9a02ee482857843462db66a7
 SHA512:
-  metadata.gz: 2caa793706298308666cd8355eb8a04d7b56fd810fbd6ca57705246845e1cc229ce664fd70c284147fe998cf1e464580c7743af8e7aec28d569ec1f9a42c8fe8
-  data.tar.gz: 8fcf2724292390d4115c2872c4bc1de2fc2f6d5435a9fb6a26eec06444b6b3a4428cee18fbf8cb7b4af14a61e175fc0aea9e46f9639acfc268259a1396496526
+  metadata.gz: 267557ee543e48873693cfb61c31e1e535f75c0947355f3d613aac372b132848b481a5aa03fe9d1f0c2709b34482df189dd28a18039d84023384ee61016b6d52
+  data.tar.gz: f32dfd90a9814d1eef154cb36486029467d22792cd21d63dc57f9bc3028f87d2f4d939429d58a75fb6fc8e5cffd5d3d56aaa0da2f663e868c3c6d8e3c8e4be25

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,48 @@ 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).
 
+## 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
+
+ - Relaxed version constraints for prometheus-client as [v2.0.0](https://github.com/prometheus/client_ruby/releases/tag/v2.0.0) doesn't break APIs. @Envek
+
+## 0.5.0 - 2020-01-29
+
+### Added
+
+ - Support for metric aggregation when prometheus-client's Direct File Store is used. @Envek
+
+   See https://github.com/prometheus/client_ruby#aggregation-settings-for-multi-process-stores for details.
+
+## 0.2.0 - 2020-01-14
+
+### Changed
+
+ - Support for new versions of the official prometheus-client gem. @Envek
+
+   It is now required to specify not only comments, but also `tags` option for all metrics as prometheus-client now enforces this.
+
+   Support for specifying tags for metrics was added to yabeda 0.2.
+
+### Removed
+
+ - Removed support for old versions of the official prometheus-client gem. @Envek
+
+   Due to incompatible changes in official client API
+
+ - Removed support for prometheus-client-mmap gem. @Envek
+
+   Support for multiprocess servers is now included in official Prometheus ruby client.
+
+
 ## 0.1.5 - 2019-10-15
 
 ### Fixed
@@ -64,4 +106,6 @@ 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"

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)
 
@@ -16,10 +16,9 @@ Adapter for easy exporting your collected metrics from your application to the [
 
 ## Installation
 
-Add this lines to your application's Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
-gem 'prometheus-client' # Or 'prometheus-client-mmap' if you need multi-process support
 gem 'yabeda-prometheus'
 ```
 
@@ -63,6 +62,30 @@ And then execute:
 
     Address of push gateway is configured with `PROMETHEUS_PUSH_GATEWAY` env variable.
 
+
+## Multi-process server support
+
+To use Unicorn or Puma in clustered mode, you'll want to set up underlying prometheus-client gem to use `DirectFileStore`, which aggregates metrics across the processes.
+
+```ruby
+Prometheus::Client.config.data_store = Prometheus::Client::DataStores::DirectFileStore.new(dir: '/tmp/prometheus_direct_file_store')
+```
+
+See more information at [prometheus-client README](https://github.com/prometheus/client_ruby#data-stores).
+
+### Aggregation settings
+
+You can specify aggregation policy in gauges declaration:
+
+```ruby
+group :some do
+  gauge :tasks do
+    comment "Number of test tasks"
+    aggregation :max
+  end
+end
+```
+
 ## 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.
@@ -73,6 +96,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.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"

data/lib/yabeda/prometheus/adapter.rb

@@ -1,40 +1,76 @@
 # frozen_string_literal: true
 
 require "prometheus/client"
+require 'prometheus/client/data_stores/direct_file_store'
+require 'prometheus/client/data_stores/single_threaded'
 require "yabeda/base_adapter"
 
 module Yabeda
   class Prometheus::Adapter < BaseAdapter
+    class UndeclaredMetricTags < RuntimeError
+      attr_reader :message
+
+      def initialize(metric_name, caused_exception)
+        @message = <<~MESSAGE.strip
+          Prometheus requires all used tags to be declared at metric registration time. \
+          Please add `tags` option to the declaration of metric `#{metric_name}`. \
+          Error: #{caused_exception.message}
+        MESSAGE
+      end
+    end
+
     def registry
       @registry ||= ::Prometheus::Client.registry
     end
 
     def register_counter!(metric)
       validate_metric!(metric)
-      registry.counter(build_name(metric), metric.comment)
+      registry.counter(
+        build_name(metric),
+        docstring: metric.comment,
+        labels: Array(metric.tags),
+        store_settings: store_settings(metric),
+      )
     end
 
     def perform_counter_increment!(metric, tags, value)
-      registry.get(build_name(metric)).increment(tags, value)
+      registry.get(build_name(metric)).increment(by: value, labels: tags)
+    rescue ::Prometheus::Client::LabelSetValidator::InvalidLabelSetError => e
+      raise UndeclaredMetricTags.new(build_name(metric), e)
     end
 
     def register_gauge!(metric)
       validate_metric!(metric)
-      registry.gauge(build_name(metric), metric.comment)
+      registry.gauge(
+        build_name(metric),
+        docstring: metric.comment,
+        labels: Array(metric.tags),
+        store_settings: store_settings(metric),
+      )
     end
 
     def perform_gauge_set!(metric, tags, value)
-      registry.get(build_name(metric)).set(tags, value)
+      registry.get(build_name(metric)).set(value, labels: tags)
+    rescue ::Prometheus::Client::LabelSetValidator::InvalidLabelSetError => e
+      raise UndeclaredMetricTags.new(build_name(metric), e)
     end
 
     def register_histogram!(metric)
       validate_metric!(metric)
       buckets = metric.buckets || ::Prometheus::Client::Histogram::DEFAULT_BUCKETS
-      registry.histogram(build_name(metric), metric.comment, {}, buckets)
+      registry.histogram(
+        build_name(metric),
+        docstring: metric.comment,
+        buckets: buckets,
+        labels: Array(metric.tags),
+        store_settings: store_settings(metric),
+      )
     end
 
     def perform_histogram_measure!(metric, tags, value)
-      registry.get(build_name(metric)).observe(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)
@@ -47,6 +83,19 @@ module Yabeda
       raise ArgumentError, 'Prometheus require metrics to have comments'
     end
 
+    private
+
+    # @param metric [Yabeda::Metric]
+    # @return [Hash]
+    def store_settings(metric)
+      case ::Prometheus::Client.config.data_store
+      when ::Prometheus::Client::DataStores::Synchronized, ::Prometheus::Client::DataStores::SingleThreaded
+        {} # Default synchronized store doesn't allow to pass any options
+      when ::Prometheus::Client::DataStores::DirectFileStore, ::Object # Anything else
+        { aggregation: metric.aggregation }.compact
+      end
+    end
+
     Yabeda.register_adapter(:prometheus, new)
   end
 end

data/lib/yabeda/prometheus/exporter.rb

@@ -1,19 +1,12 @@
 # frozen_string_literal: true
 
-begin
-  # Try to load exporter from GitLab's prometheus-client-mmap gem
-  require "prometheus/client/rack/exporter"
-  BASE_EXPORTER_CLASS = ::Prometheus::Client::Rack::Exporter
-rescue LoadError
-  # Try to load exporter from original prometheus-client
-  require "prometheus/middleware/exporter"
-  BASE_EXPORTER_CLASS = ::Prometheus::Middleware::Exporter
-end
+require "prometheus/middleware/exporter"
+require "rack"
 
 module Yabeda
   module Prometheus
     # Rack application or middleware that provides metrics exposition endpoint
-    class Exporter < BASE_EXPORTER_CLASS
+    class Exporter < ::Prometheus::Middleware::Exporter
       NOT_FOUND_HANDLER = lambda do |_env|
         [404, { "Content-Type" => "text/plain" }, ["Not Found\n"]]
       end.freeze
@@ -28,7 +21,7 @@ module Yabeda
         def start_metrics_server!
           Thread.new do
             default_port = ENV.fetch("PORT", 9394)
-            Rack::Handler::WEBrick.run(
+            ::Rack::Handler::WEBrick.run(
               rack_app,
               Host: ENV["PROMETHEUS_EXPORTER_BIND"] || "0.0.0.0",
               Port: ENV.fetch("PROMETHEUS_EXPORTER_PORT", default_port),
@@ -38,9 +31,9 @@ module Yabeda
         end
 
         def rack_app(exporter = self, path: "/metrics")
-          Rack::Builder.new do
-            use Rack::CommonLogger
-            use Rack::ShowExceptions
+          ::Rack::Builder.new do
+            use ::Rack::CommonLogger
+            use ::Rack::ShowExceptions
             use exporter, path: path
             run NOT_FOUND_HANDLER
           end

data/lib/yabeda/prometheus/version.rb

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

data/yabeda-prometheus.gemspec

@@ -25,15 +25,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "yabeda"
+  spec.required_ruby_version = ">= 2.3"
 
-  spec.post_install_message = <<~MESSAGE
-    You need to have installed either prometheus-client or prometheus-client-mmap
-    gem for yabeda-prometheus to work.
-    Please make sure that you have added one of them to your Gemfile.
-  MESSAGE
+  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 "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,17 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.6.2
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -30,28 +64,28 @@ dependencies:
     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
@@ -73,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
@@ -88,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:
@@ -96,10 +132,7 @@ metadata:
   homepage_uri: https://github.com/yabeda-rb/yabeda-prometheus
   source_code_uri: https://github.com/yabeda-rb/yabeda-prometheus
   changelog_uri: https://github.com/yabeda-rb/yabeda-prometheus/blob/master/CHANGELOG.md
-post_install_message: |
-  You need to have installed either prometheus-client or prometheus-client-mmap
-  gem for yabeda-prometheus to work.
-  Please make sure that you have added one of them to your Gemfile.
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,14 +140,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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