sidekiq_prometheus 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9a7474fb0e37d8c0aa3849bc4c5df6ff3b8a173a3545fcf5027dc29f8d1c4eb
-  data.tar.gz: 6cb664182b40af876f6e58c532c235d3169ca3cb154f9aa785faaec384c3e9db
+  metadata.gz: 654002b3b3138eef5307c4e4c3cab5a6d8ca45cc283c49341d3c1760f4d3ef67
+  data.tar.gz: 5abf477f0a4a8baa64e82d22527477614d57f48c8bf26c4d637a7c24bbb5cc70
 SHA512:
-  metadata.gz: 467ce07f7b4a5b79dcb16f61d8da97076c32ed5e5bb7b892d19a9a1d397214bb254188cacdb615fa3495d7485ddad38d38ea3e6078bae6ffaf4928a513a79deb
-  data.tar.gz: 3b47b8a80fa6569456b166374e9395db173c243e86fc63e36a25292f0d463c0a0501cd29374d51d490e5add972412b5901f77a077937436f5e1b7cfbb64a83b2
+  metadata.gz: 0544dc888a169886f532b2aa08ef8ab3c8c34ec1dea5a72bb9a75618aecfaaf4d1de81f6ae44cd61cc2621189ad69489a082f4af877cf63e7139ca3eb124a8dc
+  data.tar.gz: 7eb8689d5514e3585a6ee722a5f21d6f964a56146750d922fa578164a72ffbb36415c47befb10f7f7c61cc82ada60c7a4200b55370cf74ceae72270f4b423d98

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 CHANGELOG
 
+<a name="v1.8.3"></a>
+## [v1.8.3](https://github.com/fastly/sidekiq-prometheus/compare/v1.8.2...v1.8.3) (2023-01-30)
+
+## What's Changed
+* Track leader state so that can unregister when demoted by @leklund in https://github.com/fastly/sidekiq-prometheus/pull/36
+
+**Full Changelog**: https://github.com/fastly/sidekiq-prometheus/compare/v1.8.2...v1.8.3
+
 <a name="v1.8.2"></a>
 ## [v1.8.2](https://github.com/fastly/sidekiq-prometheus/compare/v1.8.1...v1.8.2) (2022-11-29)
 

data/README.md

@@ -79,6 +79,7 @@ end
 * `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.
+* `init_label_sets`: Hash of metrics and label sets that are initialized by calling `metric.init_label_set` after the metric is registered. See[ prometheus-client docs](https://github.com/prometheus/client_ruby/tree/e144d6225d3c346e9a4dd0a11f41f8acde386dd8#init_label_set) for details. `Hash{Symbol (metric name) => Array<Hash> (label sets)}`.
 * `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`
@@ -94,6 +95,7 @@ SidekiqPrometheus.configure do |config|
   config.custom_labels                 = { sidekiq_job_count: [:worker_class, :job_type, :any_other_label] }
   config.gc_metrics_enabled            = false
   config.global_metrics_enabled        = true
+  config.init_label_sets               = { sidekiq_job_count: [{worker_class: "class", job_type: "single", any_other_label: "value"}, {worker_class: "class", job_type: "batch", any_other_label: "other-value"}] }
   config.periodic_metrics_enabled      = true
   config.periodic_reporting_interval   = 20
   config.metrics_server_enabled        = true
@@ -101,7 +103,7 @@ SidekiqPrometheus.configure do |config|
 end
 ```
 
-Custom labels may be added by defining the `prometheus_labels` method in the worker class, 
+Custom labels may be added by defining the `prometheus_labels` method in the worker class,
 prior you need to register the custom labels as of the above example:
 
 ```ruby
@@ -130,10 +132,13 @@ All Sidekiq job metrics are reported with these labels:
 | sidekiq_job_success | counter | Count of successful Sidekiq jobs |
 | sidekiq_job_allocated_objects | histogram | Count of ruby objects allocated by a Sidekiq job |
 | sidekiq_job_failed | counter | Count of failed Sidekiq jobs |
+| sidekiq_job_over_limit | counter | Count of over limit Sidekiq jobs |
+
 
 Notes:
 
 * when a job fails only `sidekiq_job_count` and `sidekiq_job_failed` will be reported.
+* when a job fails due to Sidekiq::Limiter::OverLimit error, only `sidekiq_job_count` and `sidekiq_job_over_limit` will be reported.
 * `sidekiq_job_allocated_objects` will only be reported if `SidekiqPrometheus.gc_metrics_enabled? == true`
 
 ### Periodic GC Metrics
@@ -217,7 +222,7 @@ There is also a method to register more than one metric at a time:
 customer_worker_metrics = [
   {
     name: :file_count, type: :counter, docstring: 'Number of active files',
-    name: :file_size,  type: :gauge,   docstring: 'Size of files in bytes',    
+    name: :file_size,  type: :gauge,   docstring: 'Size of files in bytes',
   }
 ]
 

data/lib/sidekiq_prometheus/job_metrics.rb

@@ -30,7 +30,7 @@ class SidekiqPrometheus::JobMetrics
 
       result
     rescue => e
-      if e.class.to_s == "Sidekiq::Limiter::OverLimit"
+      if e.instance_of?(::Sidekiq::Limiter::OverLimit)
         registry[:sidekiq_job_over_limit].increment(labels: labels)
       else
         err_label = {error_class: e.class.to_s}

data/lib/sidekiq_prometheus/metrics.rb

@@ -176,7 +176,12 @@ module SidekiqPrometheus::Metrics
 
     options[:buckets] = buckets if buckets
 
-    registry.send(type, name.to_sym, **options)
+    metric = registry.send(type, name.to_sym, **options)
+
+    init_label_sets = SidekiqPrometheus.init_label_sets.fetch(name, [])
+    init_label_sets.each { |label_set| metric.init_label_set(label_set) }
+
+    metric
   end
 
   def unregister(name:)

data/lib/sidekiq_prometheus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPrometheus
-  VERSION = "1.8.3"
+  VERSION = "1.9.0"
 end

data/lib/sidekiq_prometheus.rb

@@ -42,6 +42,14 @@ module SidekiqPrometheus
     # @return [Boolean] Setting to control enabling/disabling global metrics. Default: true
     attr_accessor :global_metrics_enabled
 
+    # @return [Hash{Symbol => Array(Hash)}] Label sets that will be initiliazed when a metric is registered.
+    # @example
+    # {
+    #   metric_name: [{label: 'value1', other_label: 'value1'}, {label: 'value1', other_label: 'value2'}],
+    #   another_metric_name: [{label: 'value1', other_label: 'value1'}]
+    # }
+    attr_accessor :init_label_sets
+
     # @return [Boolean] Setting to control enabling/disabling periodic metrics. Default: true
     attr_accessor :periodic_metrics_enabled
 
@@ -82,6 +90,7 @@ module SidekiqPrometheus
   self.metrics_server_logger_enabled = true
   self.custom_labels = {}
   self.custom_metrics = []
+  self.init_label_sets = {}
 
   module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.9.0
 platform: ruby
 authors:
 - Lukas Eklund
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Prometheus Instrumentation for Sidekiq