sidekiq_prometheus 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533328fbd15652e9ffdc91457329eff4680f0a897b312343f9a3bea92c22795f
-  data.tar.gz: 3fa2b8614e19dd00baebd3387ddebfd52492901016a9a3ec6edb70a19d013716
+  metadata.gz: 49989dd6e8b4c7c651f70d69e674630900cf5eb3150c4be85df6becb83fc1d18
+  data.tar.gz: c42b2eac238eaa7c435628962872c750c08b1430a8166219de0343c4fe987fa5
 SHA512:
-  metadata.gz: e0e51ed626201c49c023e914bbb5676d158f5e6cad2369a0b9b2b1fd8506d2190b6b905de1e34d7d39a4d2ce211feeb4ae005c42bdc63fda94e942bbe5dc4540
-  data.tar.gz: 67c7663c062de7105d921818b499c5bf0e8e6b2c4109b5d08ea513f94c526967dea885185782a3f2895ca22b569798b2fc1e993041f2fc8ff6f8c53dc142168e
+  metadata.gz: 23702691b261c1f0ea0984cccca1267cb5ad3be7a3ebd0ea4c7591d12bb9403e5104cedc372b023f440e080a71ff5c432022f35527ff1e898dba5d07a36ab056
+  data.tar.gz: 84197b360bbe8c54da5c1e83911643a274a132164bf699d2f8672fbc908e93216918dc405f829f919f9a27fbbaf25d4bed26ff132428f29d14599a5eed1f1d73

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,57 @@
 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)
+
+### Feature
+
+* allow the metrics host to be disabled with a configuration option
+* use prometheus-client ~> 2.0
+
+### Pull Requests
+
+* Merge pull request [#17](https://github.com/fastly/sidekiq-prometheus/issues/17) from jetpks/add-option-to-disable-metrics-server
+* Merge pull request [#15](https://github.com/fastly/sidekiq-prometheus/issues/15) from silicakes/master
+
+<a name="v1.1.0"></a>
+## [v1.1.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.0.1...v1.1.0) (2020-02-12)
+
+### Feature
+
+* allow for configuration of the metrics host (instead of always binding to 127.0.0.1)
+* Use prometheus-client ~> 1.0.0
+
+### Pull Requests
+
+* Merge pull request [#13](https://github.com/fastly/sidekiq-prometheus/issues/13) from postmodern/metrics_host
+* Merge pull request [#11](https://github.com/fastly/sidekiq-prometheus/issues/11) from rossjones/patch-1
+* Merge pull request [#12](https://github.com/fastly/sidekiq-prometheus/issues/12) from fastly/hr
+
 <a name="v1.0.0"></a>
 ## [v1.0.0](https://github.com/fastly/sidekiq-prometheus/compare/v0.9.1...v1.0.0) (2019-10-24)
 

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)
 
@@ -81,6 +81,7 @@ end
 * `global_metrics_enabled`: Boolean that determines whether to report global metrics from the PeriodicMetrics reporter. When `true` this will report on a number of stats from the Sidekiq API for the cluster. This requires Sidekiq::Enterprise as the reporter uses the leader election functionality to ensure that only one worker per cluster is reporting metrics.
 * `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_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`
@@ -94,6 +95,7 @@ SidekiqPrometheus.configure do |config|
   config.global_metrics_enabled        = true
   config.periodic_metrics_enabled      = true
   config.periodic_reporting_interval   = 20
+  config.metrics_server_enabled        = true
   config.metrics_port                  = 8675
 end
 ```
@@ -245,7 +247,7 @@ See the [documentation of the Prometheus::Client library](https://github.com/pro
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
@@ -253,6 +255,9 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 * Lukas Eklund  ([@leklund](https://github.com/leklund))
 * 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
 
@@ -268,7 +273,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'
@@ -47,6 +48,9 @@ module SidekiqPrometheus
     # @return [Integer] Interval in seconds to record metrics. Default: 30
     attr_accessor :periodic_reporting_interval
 
+    # @return [Boolean] Setting to control enabling/disabling the metrics server. Default: true
+    attr_accessor :metrics_server_enabled
+
     # @return [String] Host on which the metrics server will listen. Default: localhost
     attr_accessor :metrics_host
 
@@ -69,6 +73,7 @@ module SidekiqPrometheus
   self.periodic_metrics_enabled = true
   self.global_metrics_enabled = true
   self.periodic_reporting_interval = 30
+  self.metrics_server_enabled = true
   self.metrics_host = 'localhost'
   self.metrics_port = 9359
   self.custom_labels = {}
@@ -117,6 +122,13 @@ module SidekiqPrometheus
     periodic_metrics_enabled
   end
 
+  ##
+  # Helper method for +metrics_server_enabled+ configuration setting
+  # @return [Boolean] defaults to true
+  def metrics_server_enabled?
+    metrics_server_enabled
+  end
+
   ##
   # Get a metric from the registry
   # @param metric [Symbol] name of metric to fetch
@@ -176,8 +188,10 @@ module SidekiqPrometheus
         config.on(:shutdown) { SidekiqPrometheus::PeriodicMetrics.reporter.stop }
       end
 
-      config.on(:startup)  { SidekiqPrometheus.metrics_server }
-      config.on(:shutdown) { SidekiqPrometheus.metrics_server.kill }
+      if metrics_server_enabled?
+        config.on(:startup)  { SidekiqPrometheus.metrics_server }
+        config.on(:shutdown) { SidekiqPrometheus.metrics_server.kill }
+      end
     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.1.0'
+  VERSION = '1.5.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', '~> 1.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.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Lukas Eklund
 - NHM Tanveer Hossain Khan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2021-08-02 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
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack
   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,9 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Prometheus Instrumentation for Sidekiq
 test_files: []