sidekiq_prometheus 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cef078a53e6742cd0cea7140dbe65ab96849acc8886880f530cbe208ee8fefc
-  data.tar.gz: 63dc0623415214f85a2bcb0b37cfaef012a016bb75d430763d9bfa3ed097460a
+  metadata.gz: a6dc43957020461f1b740cee64cdfff9b40f624d4bfe41d57eab772a27fd2b21
+  data.tar.gz: adb0cb635975340d514fbea0c798e5269238eb990700a7eeae8c9a2d8d32e6e7
 SHA512:
-  metadata.gz: 3721b3aaf34de0717d2d23639aeb2413fe5f9b9580ae1f07bcf333bcfae1d7c110425b1e0c850d06ba29459ca7506d06130322dd3ea1461e164c3264228628c0
-  data.tar.gz: cf08ac6f8f3779c3a8789063de3073e4838945cd4d6190b7284184c19bbd2ec2f156143502a160f9b9a91fb11bb644ca2f43e20aa11533313f4ada60d80a2a21
+  metadata.gz: 48f466c9d2904644ce161665b5f06092dff197e4b2550d9355d6c6e57832fc779d4ef3f5c0abaa63013c91fd249bb134234f201aafe9a9271f3bb121123b25ec
+  data.tar.gz: c2c181822b1a9d1e2ace0084301ac4517966a8bf4672884dd48c352d7af18374e7b2cb94d5f628a799dce8e12a372dadbc814d9d0cd91be211da097b0584e765

data/.travis.yml

@@ -1,7 +1,8 @@
 sudo: false
 language: ruby
 rvm:
+  - 3.0
+  - 2.7
+  - 2.6
   - 2.5
-  - 2.4
-  - 2.3
-before_install: gem install bundler -v 1.16.1
+before_install: gem install bundler -v 2.2.15

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 CHANGELOG
 
+
+<a name="v1.5.0"></a>
+## [v1.5.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.4.0...v1.5.0) (2021-08-02)
+
+### Pull Requests
+
+* Merge pull request [#23](https://github.com/fastly/sidekiq-prometheus/issues/23) from fastly/rainy/add-error-class-label
+
+
+<a name="v1.4.0"></a>
+## [v1.4.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.3.0...v1.4.0) (2021-03-30)
+
+### Pull Requests
+
+* Merge pull request [#21](https://github.com/fastly/sidekiq-prometheus/issues/21) from Kevinrob/patch-1
+
+
+<a name="v1.3.0"></a>
+## [v1.3.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.2.0...v1.3.0) (2021-03-26)
+
+### Pull Requests
+
+* Merge pull request [#22](https://github.com/fastly/sidekiq-prometheus/issues/22) from mirubiri/add-active-job-support
+* Merge pull request [#20](https://github.com/fastly/sidekiq-prometheus/issues/20) from fastly/aw/move-to-main
+
 <a name="v1.2.0"></a>
 ## [v1.2.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.1.0...v1.2.0) (2020-10-01)
 

data/README.md

@@ -1,7 +1,7 @@
 # Sidekiq Prometheus
 
 
-[![Status](https://travis-ci.org/fastly/sidekiq-prometheus.svg?branch=master)](https://travis-ci.org/fastly/sidekiq-prometheus)
+[![Status](https://travis-ci.org/fastly/sidekiq-prometheus.svg?branch=main)](https://travis-ci.org/fastly/sidekiq-prometheus)
 ![Gem](https://img.shields.io/gem/v/sidekiq_prometheus.svg?color=blue)
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
@@ -82,6 +82,7 @@ end
 * `periodic_metrics_enabled`: Boolean that determines whether to run the periodic metrics reporter. `PeriodicMetrics` runs a separate thread that reports on global metrics (if enabled) as well worker GC stats (if enabled). It reports metrics on the interval defined by `periodic_reporting_interval`. Defaults to `true`.
 * `periodic_reporting_interval`: interval in seconds for reporting periodic metrics. Default: `30`
 * `metrics_server_enabled`: Boolean that determines whether to run the rack server. Defaults to `true`
+* `metrics_server_logging_enabled`: Boolean that determines if the metrics server will log access logs. Defaults to `true`
 * `metrics_host`: Host on which the rack server will listen. Defaults to
   `localhost`
 * `metrics_port`: Port on which the rack server will listen. Defaults to `9359`
@@ -257,6 +258,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 * NHM Tanveer Hossain Khan ([@we4tech](https://github.com/we4tech))
 * [@Postmodern](https://github.com/postmodern)
 * Ross Jones ([@rossjones](https://github.com/rossjones))
+* Alejandro Arrufat ([@mirubiri](https://github.com/mirubiri))
 
 ## Contributing
 
@@ -272,7 +274,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SidekiqPrometheus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fastly/sidekiq-prometheus/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SidekiqPrometheus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fastly/sidekiq-prometheus/blob/main/CODE_OF_CONDUCT.md).
 
 # Metadata
 

data/lib/sidekiq_prometheus.rb

@@ -6,6 +6,7 @@ require 'prometheus/client'
 require 'prometheus/middleware/exporter'
 require 'sidekiq'
 require 'sidekiq/api'
+require 'webrick'
 
 begin
   require 'sidekiq/ent'
@@ -56,6 +57,9 @@ module SidekiqPrometheus
     # @return [Integer] Port on which the metrics server will listen. Default: 9357
     attr_accessor :metrics_port
 
+    # @return [Boolean] When set to false will silence the metric server access logs. Default: true
+    attr_accessor :metrics_server_logger_enabled
+
     # Override the default Prometheus::Client
     # @return [Prometheus::Client]
     attr_writer :client
@@ -75,6 +79,7 @@ module SidekiqPrometheus
   self.metrics_server_enabled = true
   self.metrics_host = 'localhost'
   self.metrics_port = 9359
+  self.metrics_server_logger_enabled = true
   self.custom_labels = {}
   self.custom_metrics = []
 
@@ -128,6 +133,13 @@ module SidekiqPrometheus
     metrics_server_enabled
   end
 
+  ##
+  # Helper method for +metrics_server_logger_enabled+ configuration setting
+  # @return [Boolean] defaults to true
+  def metrics_server_logger_enabled?
+    metrics_server_logger_enabled
+  end
+
   ##
   # Get a metric from the registry
   # @param metric [Symbol] name of metric to fetch
@@ -199,14 +211,23 @@ module SidekiqPrometheus
   # Will listen on SidekiqPrometheus.metrics_host and
   # SidekiqPrometheus.metrics_port
   def metrics_server
+    opts = {
+      Port: SidekiqPrometheus.metrics_port,
+      Host: SidekiqPrometheus.metrics_host,
+    }
+
+    unless metrics_server_logger_enabled?
+      opts[:Logger] = WEBrick::Log.new('/dev/null')
+      opts[:AccessLog] = []
+    end
+
     @_metrics_server ||= Thread.new do
       Rack::Handler::WEBrick.run(
         Rack::Builder.new {
           use Prometheus::Middleware::Exporter, registry: SidekiqPrometheus.registry
           run ->(_) { [301, { 'Location' => '/metrics' }, []] }
         },
-        Port: SidekiqPrometheus.metrics_port,
-        Host: SidekiqPrometheus.metrics_host,
+        **opts
       )
     end
   end

data/lib/sidekiq_prometheus/job_metrics.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 class SidekiqPrometheus::JobMetrics
-  def call(worker, _job, queue)
+  def call(worker, job, queue)
     before = GC.stat(:total_allocated_objects) if SidekiqPrometheus.gc_metrics_enabled?
 
-    labels = { class: worker.class.to_s, queue: queue }
+    # If we're using a wrapper class, like ActiveJob, use the "wrapped"
+    # attribute to expose the underlying thing.
+    labels = {
+      class: job['wrapped'] || worker.class.to_s,
+      queue: queue,
+    }
 
     begin
       labels.merge!(custom_labels(worker))
@@ -25,7 +30,8 @@ class SidekiqPrometheus::JobMetrics
 
       result
     rescue StandardError => e
-      registry[:sidekiq_job_failed].increment(labels: labels)
+      err_label = { :error_class => e.class.to_s }
+      registry[:sidekiq_job_failed].increment(labels: err_label.merge(labels))
       raise e
     ensure
       registry[:sidekiq_job_count].increment(labels: labels)

data/lib/sidekiq_prometheus/metrics.rb

@@ -64,7 +64,7 @@ module SidekiqPrometheus::Metrics
     { name:      :sidekiq_job_failed,
       type:      :counter,
       docstring: 'Count of failed Sidekiq jobs',
-      labels:    JOB_LABELS, },
+      labels:    JOB_LABELS + [:error_class], },
     { name:      :sidekiq_job_success,
       type:      :counter,
       docstring: 'Count of successful Sidekiq jobs',
@@ -107,7 +107,7 @@ module SidekiqPrometheus::Metrics
   end
 
   def register_sidekiq_gc_metric
-    register SIDEKIQ_GC_METRIC
+    register(**SIDEKIQ_GC_METRIC)
   end
 
   def register_sidekiq_worker_gc_metrics
@@ -120,7 +120,7 @@ module SidekiqPrometheus::Metrics
 
   def register_metrics(metrics)
     metrics.each do |metric|
-      register(metric)
+      register(**metric)
     end
   end
 
@@ -159,7 +159,7 @@ module SidekiqPrometheus::Metrics
 
     options[:buckets] = buckets if buckets
 
-    registry.send(type, name.to_sym, options)
+    registry.send(type, name.to_sym, **options)
   end
 
   def unregister(name:)

data/lib/sidekiq_prometheus/periodic_metrics.rb

@@ -8,7 +8,7 @@
 # one worker.
 #
 # @see https://github.com/mperham/sidekiq/wiki/Ent-Leader-Election
-# @see https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/api.rb
+# @see https://github.com/mperham/sidekiq/blob/main/lib/sidekiq/api.rb
 
 class SidekiqPrometheus::PeriodicMetrics
   # @return [Boolean] When +true+ will stop the reporting loop.

data/lib/sidekiq_prometheus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPrometheus
-  VERSION = '1.2.0'
+  VERSION = '1.6.0'
 end

data/sidekiq_prometheus.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.58.0'
 
   spec.add_runtime_dependency 'prometheus-client', '~> 2.0'
   spec.add_runtime_dependency 'rack'
   spec.add_runtime_dependency 'sidekiq', '> 5.1'
+  spec.add_runtime_dependency 'webrick'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Lukas Eklund
 - NHM Tanveer Hossain Khan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,21 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.1'
-description: 
+- !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'
+description:
 email:
 - leklund@fastly.com
 executables: []
@@ -153,7 +167,7 @@ homepage: https://github.com/fastly/sidekiq-prometheus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Prometheus Instrumentation for Sidekiq
 test_files: []