sidekiq_prometheus 1.7.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c76de7fe8caef12bc6e505dd5e01648c5da34d87b00a6cf756d232a1c988bb46
-  data.tar.gz: d211a23831395d5058a7c9ddb281870fde3154956194324984a816b54067e300
+  metadata.gz: 99f2c02a2ecdac71a05de9212319cc8efafb5e15d39d1a46d9dcd60d32ff847d
+  data.tar.gz: b43c963a8c63ca92ad695a8a5ef191701a2486772aaea24ad333ad6aacf66363
 SHA512:
-  metadata.gz: 0cc266bed6f539d955405fe35b5e41a2f539b65ce7d4a552b70e745fe760a6e1a216ee22278889a193e7456e42bc72cc54b486b7f7266a2a3e80b33754c251f4
-  data.tar.gz: 1544e8d064ccc46548153382e531131e250b4bf8acf567daebbf40daab8d934c0d46ef11bdd05ad7ff16f6961b79a205bde999d4e17b1a27e272ca2c1dd1b827
+  metadata.gz: 74a9dda61a073d84576614a107966b9e6f714896b1925b1a2983f8f5ff64d2fa4f19007b47eaa6926f9f8a76cd0162a4c95dc11e97b11b9d40d9804ed6765d69
+  data.tar.gz: d7d1784f6aa693eb0e96613d2f0af6ee49d26e11f6d061c61dc7c75e73c12760fbc95b4e526c6b8d017083a7a5c518b79fa0c339266c60d9e2c6611a702bd641

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 CHANGELOG
 
+<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)
+
+### Bug Fixes
+
+* s/metrics_server_logging_enabled/metrics_server_logger_enabled/
+
+### Features
+
+* add Sidekiq::Stats processes_size to the periodic metrics
+
+### Pull Requests
+
+* Merge pull request [#30](https://github.com/fastly/sidekiq-prometheus/issues/30) from fastly/add_processes_size
+
+
 <a name="v1.6.0"></a>
 ## [v1.6.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.5.0...v1.6.0) (2021-08-03)
 
@@ -46,8 +74,9 @@ CHANGELOG
 
 ### 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 [#18](https://github.com/fastly/sidekiq-prometheus/issues/18) from jetpks/release-120
 * Merge pull request [#15](https://github.com/fastly/sidekiq-prometheus/issues/15) from silicakes/master
+* Merge pull request [#17](https://github.com/fastly/sidekiq-prometheus/issues/17) from jetpks/add-option-to-disable-metrics-server
 
 <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)
@@ -63,6 +92,14 @@ CHANGELOG
 * 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.1"></a>
+## [v1.0.1](https://github.com/fastly/sidekiq-prometheus/compare/v0.9.2...v1.0.1) (2019-10-30)
+
+### Pull Requests
+
+* Merge pull request [#9](https://github.com/fastly/sidekiq-prometheus/issues/9) from we4tech/features/update-prometheus-client
+
+
 <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)
 
@@ -71,6 +108,10 @@ CHANGELOG
 * Merge pull request [#9](https://github.com/fastly/sidekiq-prometheus/issues/9) from we4tech/features/update-prometheus-client
 
 
+<a name="v0.9.2"></a>
+## [v0.9.2](https://github.com/fastly/sidekiq-prometheus/compare/v1.0.0...v0.9.2) (2019-10-30)
+
+
 <a name="v0.9.1"></a>
 ## [v0.9.1](https://github.com/fastly/sidekiq-prometheus/compare/v0.9.0...v0.9.1) (2019-07-08)
 

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/job_metrics.rb

@@ -30,8 +30,13 @@ class SidekiqPrometheus::JobMetrics
 
       result
     rescue StandardError => e
-      err_label = { :error_class => e.class.to_s }
-      registry[:sidekiq_job_failed].increment(labels: err_label.merge(labels))
+      if e.class.to_s == 'Sidekiq::Limiter::OverLimit'
+        registry[:sidekiq_job_over_limit].increment(labels: labels)
+      else
+        err_label = { :error_class => e.class.to_s }
+        registry[:sidekiq_job_failed].increment(labels: err_label.merge(labels))
+      end
+
       raise e
     ensure
       registry[:sidekiq_job_count].increment(labels: labels)

data/lib/sidekiq_prometheus/metrics.rb

@@ -72,6 +72,10 @@ module SidekiqPrometheus::Metrics
       type:      :counter,
       docstring: 'Count of successful Sidekiq jobs',
       labels:    JOB_LABELS, },
+    { name:      :sidekiq_job_over_limit,
+      type:      :counter,
+      docstring: 'Count of over limit Sidekiq jobs',
+      labels:    JOB_LABELS, },
   ].freeze
   SIDEKIQ_GC_METRIC = {
     name:      :sidekiq_job_allocated_objects,

data/lib/sidekiq_prometheus/periodic_metrics.rb

@@ -44,7 +44,11 @@ class SidekiqPrometheus::PeriodicMetrics
     @sidekiq_queue = sidekiq_queue
     @senate = if senate.nil?
                 if Object.const_defined?('Sidekiq::Senate')
-                  Sidekiq::Senate
+                  if Sidekiq::Senate.respond_to?(:leader?)
+                    Sidekiq::Senate
+                  else
+                    Sidekiq::Senate.new(Sidekiq)
+                  end
                 else
                   Senate
                 end

data/lib/sidekiq_prometheus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Lukas Eklund
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler