sidekiq_prometheus 1.8.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564b12c7284161a3350d677f809da15ca5d70b0b2a9eb5303970639cb85aeedb
-  data.tar.gz: 99c3995589218b36b0016d7585bedf17a4ac783fdfa4efb306b5bffbd8c6e766
+  metadata.gz: cfef2dcf926147bf8113fc2ef76ebc53e194b742bff8024e52915829ed315403
+  data.tar.gz: d312f2be0b37be88b32e4031560c03ad1386283c935e911435ba8929c108dc2b
 SHA512:
-  metadata.gz: 261e2cc263e08cf1d5784c63a2af38855db615f995f5d66f5b8c8c837e80fe22c0a5f2c6a85671c7bc1c4144a5b5ca816916088a77281ffd5e099ebf1da07a23
-  data.tar.gz: 6bccef33e7d74236fdad77eb93072f02804e838c5dc6760b26e7ed624667b1a73d0ebce1170469ce60345d2fed43bb1c2fab615e202c6fe4a76388b11d8e6054
+  metadata.gz: edc39e79efebc8d713ab0b4c60913b860c115fd99e6b8d096e705e41c698accb8e1765316e98371f67bd13c53e612254f656cf49713580b50675b15f8c9664f3
+  data.tar.gz: d03bdf927308ed353d34922c894c0363e68e1326792d95dd7052f87c2a38d2156a6cfd13954b3ee593adbc9a7e80407a84569387ead503ea5adcb1f2baccf955

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 CHANGELOG
 
+<a name="v1.8.1"></a>
+## [v1.8.1](https://github.com/fastly/sidekiq-prometheus/compare/v1.8.0...v1.8.1) (2022-10-18)
+
+### Feature
+
+* Support newer Sidekiq-Enterprise (#[31](https://github.com/fastly/sidekiq-prometheus/pull/31))
+
+<a name="v1.8.0"></a>
+## [v1.8.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.7.0...v1.8.0) (2022-10-04)
+
+### Features
+
+* handle rate limiting exceptions distinctly from other exceptions ([#28](https://github.com/fastly/sidekiq-prometheus/issues/28))
+
+### Pull Requests
+
+* Merge pull request [#27](https://github.com/fastly/sidekiq-prometheus/issues/27) from pinkahd/patch-1
+
+
 <a name="v1.7.0"></a>
 ## [v1.7.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.6.0...v1.7.0) (2022-09-29)
 

data/README.md

@@ -75,8 +75,8 @@ end
 
 #### Configuration options
 
-* `preset_labels`: Hash of labels that will be included with every metric when they are registered.
-* `custom_labels`: Array of names for each label that will be passed during the reporting. 
+* `preset_labels`: Hash of labels that will be included with every metric when they are registered. `Hash{Symbol (label name) => String (label value)}`
+* `custom_labels`: Hash of metrics and labels that can be applied to specific metrics. The metric name must be a registered metric. `Hash{Symbol (metric name) => Array<Symbol> (label names)}`
 * `gc_metrics_enabled`: Boolean that determines whether to record object allocation metrics per job. The default is `true`. Setting this to `false` if you don't need this metric.
 * `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`.
@@ -91,7 +91,7 @@ end
 ```ruby
 SidekiqPrometheus.configure do |config|
   config.preset_labels                 = { service: 'myapp' }
-  config.custom_labels                 = [:worker_class, :job_type, :any_other_label]
+  config.custom_labels                 = { sidekiq_job_count: [:worker_class, :job_type, :any_other_label] }
   config.gc_metrics_enabled            = false
   config.global_metrics_enabled        = true
   config.periodic_metrics_enabled      = true
@@ -254,11 +254,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributors
 
-* 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))
+See: https://github.com/fastly/sidekiq-prometheus/graphs/contributors
 
 ## Contributing
 

data/lib/sidekiq_prometheus/periodic_metrics.rb

@@ -10,7 +10,14 @@
 # @see https://github.com/mperham/sidekiq/wiki/Ent-Leader-Election
 # @see https://github.com/mperham/sidekiq/blob/main/lib/sidekiq/api.rb
 
+begin
+  require 'sidekiq/component'
+rescue LoadError
+end
+
 class SidekiqPrometheus::PeriodicMetrics
+  include Sidekiq::Component if defined? Sidekiq::Component
+
   # @return [Boolean] When +true+ will stop the reporting loop.
   attr_accessor :done
 
@@ -28,23 +35,27 @@ class SidekiqPrometheus::PeriodicMetrics
   ##
   # Instance of SidekiqPrometheus::PeriodicMetrics
   # @return [SidekiqPrometheus:PeriodicMetrics]
-  def self.reporter
-    @reporter ||= new
+  def self.reporter(config)
+    @reporter ||= new(config: config)
   end
 
   ##
   # @param interval [Integer] Interval in seconds to record metrics.
   # @param sidekiq_stats [Sidekiq::Stats]
   # @param senate [#leader?] Sidekiq::Senate
-  def initialize(interval: SidekiqPrometheus.periodic_reporting_interval, sidekiq_stats: Sidekiq::Stats, sidekiq_queue: Sidekiq::Queue, senate: nil)
+  def initialize(interval: SidekiqPrometheus.periodic_reporting_interval, sidekiq_stats: Sidekiq::Stats, sidekiq_queue: Sidekiq::Queue, senate: nil, config: nil)
     self.done = false
     @interval = interval
-
+    @config = config
     @sidekiq_stats = sidekiq_stats
     @sidekiq_queue = sidekiq_queue
     @senate = if senate.nil?
                 if Object.const_defined?('Sidekiq::Senate')
-                  Sidekiq::Senate
+                  if respond_to?(:leader?)
+                    self
+                  else
+                    Sidekiq::Senate
+                  end
                 else
                   Senate
                 end

data/lib/sidekiq_prometheus/version.rb

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

data/lib/sidekiq_prometheus.rb

@@ -195,8 +195,8 @@ module SidekiqPrometheus
       end
 
       if periodic_metrics_enabled?
-        config.on(:startup)  { SidekiqPrometheus::PeriodicMetrics.reporter.start }
-        config.on(:shutdown) { SidekiqPrometheus::PeriodicMetrics.reporter.stop }
+        config.on(:startup)  { SidekiqPrometheus::PeriodicMetrics.reporter(config).start }
+        config.on(:shutdown) { SidekiqPrometheus::PeriodicMetrics.reporter(config).stop }
       end
 
       if metrics_server_enabled?

data/sidekiq_prometheus.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   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 'prometheus-client', '>= 2.0'
   spec.add_runtime_dependency 'rack'
-  spec.add_runtime_dependency 'sidekiq', '> 5.1'
+  spec.add_runtime_dependency 'sidekiq', '> 5.1', '< 7.0'
   spec.add_runtime_dependency 'webrick'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Lukas Eklund
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,14 +85,14 @@ dependencies:
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -116,6 +116,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -123,6 +126,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement