prometheus_exporter 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f516c39448418a2216851149f0479f3f9e0f5feadae5a5468e7953fc0551d318
-  data.tar.gz: dcc937b79e05d4cd74a64ab2135425c75c4bba1be053bec99e8db0695a3ac998
+  metadata.gz: 2f949348bbafc06b8f7a3dd3927693de8fef54090d85a7889afbfbf7dcb167b6
+  data.tar.gz: adeca8000ebb59c7225c1453135900aeab5c1760902edd5b4fecf9fa4b879a57
 SHA512:
-  metadata.gz: 5664f24c1c4a1520bafe789e5df8a9f1c40b118933cab9b73baa953f633ec6e81c3a11bbc9fc63097a2a2acdd2390daeade9449e6451cc83207fc2162575b359
-  data.tar.gz: ca4aeedbc6e211818569257e8a3e9fde93be363a2da246abae45749bc9cc232052ac52f0850cd54d0f600904bed193a10db1f76e4fc9567b837b20a78264158b
+  metadata.gz: 7d3829ad57f03a19f6081c3444f9b13906aedd4fa1c5b99237d454096e0d993c27c2df0993482c421b6034a58a55c9603620bcdf7698248e4ac23a5063d63718
+  data.tar.gz: fb915716acbbb4f24a152c8ebf9eb35bdc97185a7144eb986e50aafad07a36d5cc83cbbbf7c16e8b399207e9c66d90973d2e6f9ddcdc8a17cab797840d13ed8b

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby: ["2.7", "2.6", "2.5", "2.4"]
+        ruby: ["2.7", "2.6", "2.5"]
     steps:
       - uses: actions/checkout@master
         with:
@@ -23,14 +23,20 @@ jobs:
       - uses: actions/cache@v2
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-v2-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-v2-
       - name: Setup gems
         run: |
+          gem install bundler
+          # for Ruby <= 2.6 , details https://github.com/rubygems/rubygems/issues/3284
+          gem update --system 3.0.8 && gem update --system
           bundle config path vendor/bundle
           bundle install --jobs 4
+          bundle exec appraisal install
       - name: Rubocop
         run: bundle exec rubocop
+      - name: install gems
+        run: bundle exec appraisal bundle
       - name: Run tests
-        run: bundle exec rake
+        run: bundle exec appraisal rake

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+/gemfiles/*.gemfile.lock
+
 
 .rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rubocop.yml

@@ -1,2 +1,7 @@
 inherit_gem:
   rubocop-discourse: default.yml
+
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*'
+    - 'vendor/**/*'

data/Appraisals

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+appraise "ar-60" do
+  # we are using this version as default in gemspec
+  # gem "activerecord", "~> 6.0.0"
+end
+
+appraise "ar-61" do
+  gem "activerecord", "~> 6.1.0.rc2"
+end

data/CHANGELOG

@@ -1,4 +1,12 @@
-0.6.0 - 10-11-2020
+0.7.0 - 29-12-2020
+
+- Dev: Removed support from EOL rubies, only 2.5, 2.6, 2.7 and 3.0 are supported now.
+- Dev: Better support for Ruby 3.0, explicitly depending on webrick
+- Dev: Rails 6.1 instrumentation support
+- FEATURE: clean pattern for overriding middleware labels was introduced (in README)
+- Fix: Better support for forking
+
+0.6.0 - 17-11-2020
 
 - FEATURE: add support for basic-auth in the prometheus_exporter web server
 

data/README.md

@@ -33,7 +33,7 @@ To learn more see [Instrumenting Rails with Prometheus](https://samsaffron.com/a
 
 ## Requirements
 
-Minimum Ruby of version 2.3.0 is required, Ruby 2.2.0 is EOL as of 2018-03-31
+Minimum Ruby of version 2.5.0 is required, Ruby 2.4.0 is EOL as of 2020-04-05
 
 ## Installation
 
@@ -218,6 +218,32 @@ class MyMiddleware < PrometheusExporter::Middleware
 end
 ```
 
+If you're not using Rails like framework, you can extend `PrometheusExporter::Middleware#default_labels` in a way to add more relevant labels.
+For example you can mimic [prometheus-client](https://github.com/prometheus/client_ruby) labels with code like this:
+```ruby
+class MyMiddleware < PrometheusExporter::Middleware
+  def default_labels(env, result)
+    status = (result && result[0]) || -1
+    path = [env["SCRIPT_NAME"], env["PATH_INFO"]].join
+    {
+      path: strip_ids_from_path(path),
+      method: env["REQUEST_METHOD"],
+      status: status
+    }
+  end
+
+  def strip_ids_from_path(path)
+    path
+      .gsub(%r{/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(/|$)}, '/:uuid\\1')
+      .gsub(%r{/\d+(/|$)}, '/:id\\1')
+  end
+end
+```
+That way you won't have all metrics labeled with `controller=other` and `action=other`, but have labels such as
+```
+ruby_http_duration_seconds{path="/api/v1/teams/:id",method="GET",status="200",quantile="0.99"} 0.009880661998977303
+```
+
 ¹) Only available when Redis is used.
 ²) Only available when Mysql or PostgreSQL are used.
 ³) Only available when [Instrumenting Request Queueing Time](#instrumenting-request-queueing-time) is set up.

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/ar_60.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"

data/gemfiles/ar_61.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/prometheus_exporter/client.rb

@@ -188,7 +188,7 @@ module PrometheusExporter
 
     def close_socket!
       begin
-        if @socket
+        if @socket && !@socket.closed?
           @socket.write("0\r\n")
           @socket.write("\r\n")
           @socket.flush

data/lib/prometheus_exporter/instrumentation/active_record.rb

@@ -67,21 +67,30 @@ module PrometheusExporter::Instrumentation
       ObjectSpace.each_object(::ActiveRecord::ConnectionAdapters::ConnectionPool) do |pool|
         next if pool.connections.nil?
 
-        labels_from_config = pool.spec.config
-          .select { |k, v| @config_labels.include? k }
-          .map { |k, v| [k.to_s.dup.prepend("dbconfig_"), v] }
-
-        labels = @metric_labels.merge(pool_name: pool.spec.name).merge(Hash[labels_from_config])
-
         metric = {
           pid: pid,
           type: "active_record",
           hostname: ::PrometheusExporter.hostname,
-          metric_labels: labels
+          metric_labels: labels(pool)
         }
         metric.merge!(pool.stat)
         metrics << metric
       end
     end
+
+    private
+
+    def labels(pool)
+      if pool.respond_to?(:spec) # ActiveRecord <= 6.0
+        @metric_labels.merge(pool_name: pool.spec.name).merge(pool.spec.config
+          .select { |k, v| @config_labels.include? k }
+          .map { |k, v| [k.to_s.dup.prepend("dbconfig_"), v] }.to_h)
+      elsif pool.respond_to?(:db_config) # ActiveRecord >= 6.1.rc1
+        @metric_labels.merge(pool_name: pool.db_config.name).merge(
+          @config_labels.each_with_object({}) { |l, acc| acc["dbconfig_#{l}"] = pool.db_config.public_send(l) })
+      else
+        raise "Unsupported connection pool"
+      end
+    end
   end
 end

data/lib/prometheus_exporter/middleware.rb

@@ -36,21 +36,12 @@ class PrometheusExporter::Middleware
 
     result
   ensure
-    status = (result && result[0]) || -1
-    params = env["action_dispatch.request.parameters"]
-    action, controller = nil
-    if params
-      action = params["action"]
-      controller = params["controller"]
-    end
 
     obj = {
       type: "web",
       timings: info,
       queue_time: queue_time,
-      action: action,
-      controller: controller,
-      status: status
+      default_labels: default_labels(env, result)
     }
     labels = custom_labels(env)
     if labels
@@ -60,6 +51,22 @@ class PrometheusExporter::Middleware
     @client.send_json(obj)
   end
 
+  def default_labels(env, result)
+    status = (result && result[0]) || -1
+    params = env["action_dispatch.request.parameters"]
+    action = controller = nil
+    if params
+      action = params["action"]
+      controller = params["controller"]
+    end
+
+    {
+      action: action || "other",
+      controller: controller || "other",
+      status: status
+    }
+  end
+
   # allows subclasses to add custom labels based on env
   def custom_labels(env)
     nil

data/lib/prometheus_exporter/server/web_collector.rb

@@ -56,14 +56,11 @@ module PrometheusExporter::Server
     end
 
     def observe(obj)
-      default_labels = {
-        controller: obj['controller'] || 'other',
-        action: obj['action'] || 'other'
-      }
+      default_labels = obj['default_labels']
       custom_labels = obj['custom_labels']
       labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
 
-      @http_requests_total.observe(1, labels.merge(status: obj["status"]))
+      @http_requests_total.observe(1, labels)
 
       if timings = obj["timings"]
         @http_duration_seconds.observe(timings["total_duration"], labels)

data/lib/prometheus_exporter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrometheusExporter
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/prometheus_exporter.gemspec

@@ -24,19 +24,23 @@ Gem::Specification.new do |spec|
   spec.executables          = ["prometheus_exporter"]
   spec.require_paths        = ["lib"]
 
+  spec.add_dependency "webrick"
+
   spec.add_development_dependency "rubocop", ">= 0.69"
-  spec.add_development_dependency "bundler", "> 1.16"
+  spec.add_development_dependency "bundler", ">= 2.2.2"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "guard", "~> 2.0"
-  spec.add_development_dependency "mini_racer", "~> 0.1"
+  spec.add_development_dependency "mini_racer", "~> 0.3.1"
   spec.add_development_dependency "guard-minitest", "~> 2.0"
   spec.add_development_dependency "oj", "~> 3.0"
   spec.add_development_dependency "rack-test", "~> 0.8.3"
   spec.add_development_dependency "minitest-stub-const", "~> 0.6"
   spec.add_development_dependency "rubocop-discourse", ">2"
+  spec.add_development_dependency "appraisal", "~> 2.3"
+  spec.add_development_dependency "activerecord", "~> 6.0.0"
   if !RUBY_ENGINE == 'jruby'
     spec.add_development_dependency "raindrops", "~> 0.19"
   end
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.5.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -28,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,34 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 description: Prometheus metric collector and exporter for Ruby
 email:
 - sam.saffron@gmail.com
@@ -175,6 +217,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- Appraisals
 - CHANGELOG
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -185,6 +228,9 @@ files:
 - bench/bench.rb
 - bin/prometheus_exporter
 - examples/custom_collector.rb
+- gemfiles/.bundle/config
+- gemfiles/ar_60.gemfile
+- gemfiles/ar_61.gemfile
 - lib/prometheus_exporter.rb
 - lib/prometheus_exporter/client.rb
 - lib/prometheus_exporter/instrumentation.rb
@@ -236,14 +282,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.2
 signing_key:
 specification_version: 4
 summary: Prometheus Exporter