yabeda-prometheus 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf7f044078d39963972005e5dab30c8fa8d908ca9b1d667ce60fc36295e7fb91
-  data.tar.gz: bd89b7fa736a501e417345951c642d601af60dd537a8c03a80a11678990e61d1
+  metadata.gz: c5e54ecad52d7b0afa0763c586097de00a8dda93c125116fb879fad20d7ce40c
+  data.tar.gz: 1f8dce2a20922f7a175191660ff5de7719893a6b741dffd8d06064867ec07cfe
 SHA512:
-  metadata.gz: 2caa793706298308666cd8355eb8a04d7b56fd810fbd6ca57705246845e1cc229ce664fd70c284147fe998cf1e464580c7743af8e7aec28d569ec1f9a42c8fe8
-  data.tar.gz: 8fcf2724292390d4115c2872c4bc1de2fc2f6d5435a9fb6a26eec06444b6b3a4428cee18fbf8cb7b4af14a61e175fc0aea9e46f9639acfc268259a1396496526
+  metadata.gz: b800c70319409c9d9afd4f88599c8e881f146825ccd5ed8ebd232efc16c5df78760c9adbe1b291747c6990d13f7c7703893344d0003954f5c902f119d779b672
+  data.tar.gz: c5c5f923c9a97d5633487998850dae2e1bac9a1e34ed3f0a0d679c5d414a14452fc33c910f853b09f4376e7dcf714fa58efa09cdb04cca1f062404e5f3f8dd65

data/CHANGELOG.md

@@ -5,6 +5,27 @@ 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.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

data/README.md

@@ -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,17 @@ 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).
+
 ## 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

@@ -5,36 +5,54 @@ 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))
     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))
     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))
     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)

data/lib/yabeda/prometheus/exporter.rb

@@ -1,19 +1,11 @@
 # 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"
 
 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

data/lib/yabeda/prometheus/version.rb

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

data/yabeda-prometheus.gemspec

@@ -25,13 +25,10 @@ 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", "~> 1.0"
+  spec.add_dependency "yabeda", "~> 0.2"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 12.0"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,10 +110,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,7 +118,7 @@ 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:
   - - ">="