sidekiq_prometheus 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfef2dcf926147bf8113fc2ef76ebc53e194b742bff8024e52915829ed315403
-  data.tar.gz: d312f2be0b37be88b32e4031560c03ad1386283c935e911435ba8929c108dc2b
+  metadata.gz: 654002b3b3138eef5307c4e4c3cab5a6d8ca45cc283c49341d3c1760f4d3ef67
+  data.tar.gz: 5abf477f0a4a8baa64e82d22527477614d57f48c8bf26c4d637a7c24bbb5cc70
 SHA512:
-  metadata.gz: edc39e79efebc8d713ab0b4c60913b860c115fd99e6b8d096e705e41c698accb8e1765316e98371f67bd13c53e612254f656cf49713580b50675b15f8c9664f3
-  data.tar.gz: d03bdf927308ed353d34922c894c0363e68e1326792d95dd7052f87c2a38d2156a6cfd13954b3ee593adbc9a7e80407a84569387ead503ea5adcb1f2baccf955
+  metadata.gz: 0544dc888a169886f532b2aa08ef8ab3c8c34ec1dea5a72bb9a75618aecfaaf4d1de81f6ae44cd61cc2621189ad69489a082f4af877cf63e7139ca3eb124a8dc
+  data.tar.gz: 7eb8689d5514e3585a6ee722a5f21d6f964a56146750d922fa578164a72ffbb36415c47befb10f7f7c61cc82ada60c7a4200b55370cf74ceae72270f4b423d98

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 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)
+
+## What's Changed
+* Allow sidekiq-prometheus to work with prometheus-client version > 2 by @hieuk09 in https://github.com/fastly/sidekiq-prometheus/pull/29
+* Fixes Newer Sidekiq-Enterprise versions that have a Senate.leader? issue with Sidekiq Prometheus 1.8.1 by @imightbeinatree in https://github.com/fastly/sidekiq-prometheus/pull/32
+
+## New Contributors
+* @hieuk09 made their first contribution in https://github.com/fastly/sidekiq-prometheus/pull/29
+
+**Full Changelog**: https://github.com/fastly/sidekiq-prometheus/compare/v1.8.1...v1.8.2
+
 <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)
 

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

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/Rakefile

@@ -1,19 +1,12 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-begin
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    task.options = ['-c.rubocop.yml']
-  end
-rescue LoadError
-end
-
 task default: %w[
-  rubocop
+  standard
   spec
 ]

data/lib/sidekiq_prometheus/job_metrics.rb

@@ -7,8 +7,8 @@ class SidekiqPrometheus::JobMetrics
     # 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,
+      class: job["wrapped"] || worker.class.to_s,
+      queue: queue
     }
 
     begin
@@ -29,11 +29,11 @@ class SidekiqPrometheus::JobMetrics
       end
 
       result
-    rescue StandardError => e
-      if e.class.to_s == 'Sidekiq::Limiter::OverLimit'
+    rescue => e
+      if e.instance_of?(::Sidekiq::Limiter::OverLimit)
         registry[:sidekiq_job_over_limit].increment(labels: labels)
       else
-        err_label = { :error_class => e.class.to_s }
+        err_label = {error_class: e.class.to_s}
         registry[:sidekiq_job_failed].increment(labels: err_label.merge(labels))
       end
 

data/lib/sidekiq_prometheus/metrics.rb

@@ -3,106 +3,106 @@
 module SidekiqPrometheus::Metrics
   module_function
 
-  UNKNOWN = 'unknown'
+  UNKNOWN = "unknown"
 
   VALID_TYPES = %i[counter gauge histogram summary].freeze
   JOB_LABELS = %i[class queue].freeze
   SIDEKIQ_GLOBAL_METRICS = [
-    { name:      :sidekiq_workers_size,
-      type:      :gauge,
-      docstring: 'Total number of workers processing jobs', },
-    { name:      :sidekiq_processes_size,
-      type:      :gauge,
-      docstring: 'Total number of running sidekiq processes', },
-    { name:      :sidekiq_dead_size,
-      type:      :gauge,
-      docstring: 'Total Dead Size', },
-    { name:      :sidekiq_enqueued,
-      type:      :gauge,
-      docstring: 'Total Size of all known queues',
-      labels:    %i[queue], },
-    { name:      :sidekiq_queue_latency,
-      type:      :summary,
-      docstring: 'Latency (in seconds) of all queues',
-      labels:    %i[queue], },
-    { name:      :sidekiq_failed,
-      type:      :gauge,
-      docstring: 'Number of job executions which raised an error', },
-    { name:      :sidekiq_processed,
-      type:      :gauge,
-      docstring: 'Number of job executions completed (success or failure)', },
-    { name:      :sidekiq_retry_size,
-      type:      :gauge,
-      docstring: 'Total Retries Size', },
-    { name:      :sidekiq_scheduled_size,
-      type:      :gauge,
-      docstring: 'Total Scheduled Size', },
-    { name:      :sidekiq_redis_connected_clients,
-      type:      :gauge,
-      docstring: 'Number of clients connected to Redis instance for Sidekiq', },
-    { name:      :sidekiq_redis_used_memory,
-      type:      :gauge,
-      docstring: 'Used memory from Redis.info', },
-    { name:      :sidekiq_redis_used_memory_peak,
-      type:      :gauge,
-      docstring: 'Used memory peak from Redis.info', },
-    { name:      :sidekiq_redis_keys,
-      type:      :gauge,
-      docstring: 'Number of redis keys',
-      labels:     %i[database], },
-    { name:      :sidekiq_redis_expires,
-      type:      :gauge,
-      docstring: 'Number of redis keys with expiry set',
-      labels:     %i[database], },
+    {name: :sidekiq_workers_size,
+     type: :gauge,
+     docstring: "Total number of workers processing jobs"},
+    {name: :sidekiq_processes_size,
+     type: :gauge,
+     docstring: "Total number of running sidekiq processes"},
+    {name: :sidekiq_dead_size,
+     type: :gauge,
+     docstring: "Total Dead Size"},
+    {name: :sidekiq_enqueued,
+     type: :gauge,
+     docstring: "Total Size of all known queues",
+     labels: %i[queue]},
+    {name: :sidekiq_queue_latency,
+     type: :summary,
+     docstring: "Latency (in seconds) of all queues",
+     labels: %i[queue]},
+    {name: :sidekiq_failed,
+     type: :gauge,
+     docstring: "Number of job executions which raised an error"},
+    {name: :sidekiq_processed,
+     type: :gauge,
+     docstring: "Number of job executions completed (success or failure)"},
+    {name: :sidekiq_retry_size,
+     type: :gauge,
+     docstring: "Total Retries Size"},
+    {name: :sidekiq_scheduled_size,
+     type: :gauge,
+     docstring: "Total Scheduled Size"},
+    {name: :sidekiq_redis_connected_clients,
+     type: :gauge,
+     docstring: "Number of clients connected to Redis instance for Sidekiq"},
+    {name: :sidekiq_redis_used_memory,
+     type: :gauge,
+     docstring: "Used memory from Redis.info"},
+    {name: :sidekiq_redis_used_memory_peak,
+     type: :gauge,
+     docstring: "Used memory peak from Redis.info"},
+    {name: :sidekiq_redis_keys,
+     type: :gauge,
+     docstring: "Number of redis keys",
+     labels: %i[database]},
+    {name: :sidekiq_redis_expires,
+     type: :gauge,
+     docstring: "Number of redis keys with expiry set",
+     labels: %i[database]}
   ].freeze
   SIDEKIQ_JOB_METRICS = [
-    { name:      :sidekiq_job_count,
-      type:      :counter,
-      docstring: 'Count of Sidekiq jobs',
-      labels:    JOB_LABELS, },
-    { name:      :sidekiq_job_duration,
-      type:      :histogram,
-      docstring: 'Sidekiq job processing duration',
-      labels:    JOB_LABELS, },
-    { name:      :sidekiq_job_failed,
-      type:      :counter,
-      docstring: 'Count of failed Sidekiq jobs',
-      labels:    JOB_LABELS + [:error_class], },
-    { name:      :sidekiq_job_success,
-      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, },
+    {name: :sidekiq_job_count,
+     type: :counter,
+     docstring: "Count of Sidekiq jobs",
+     labels: JOB_LABELS},
+    {name: :sidekiq_job_duration,
+     type: :histogram,
+     docstring: "Sidekiq job processing duration",
+     labels: JOB_LABELS},
+    {name: :sidekiq_job_failed,
+     type: :counter,
+     docstring: "Count of failed Sidekiq jobs",
+     labels: JOB_LABELS + [:error_class]},
+    {name: :sidekiq_job_success,
+     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,
-    type:      :histogram,
-    docstring: 'Count of ruby objects allocated by a Sidekiq job',
-    buckets:   [10, 50, 100, 500, 1_000, 2_500, 5_000, 10_000, 50_000, 100_000, 500_000, 1_000_000, 5_000_000, 10_000_000, 25_000_000],
-    labels:    JOB_LABELS,
+    name: :sidekiq_job_allocated_objects,
+    type: :histogram,
+    docstring: "Count of ruby objects allocated by a Sidekiq job",
+    buckets: [10, 50, 100, 500, 1_000, 2_500, 5_000, 10_000, 50_000, 100_000, 500_000, 1_000_000, 5_000_000, 10_000_000, 25_000_000],
+    labels: JOB_LABELS
   }.freeze
   SIDEKIQ_WORKER_GC_METRICS = [
-    { name:      :sidekiq_allocated_objects,
-      type:      :counter,
-      docstring: 'Count of ruby objects allocated by a Sidekiq worker', },
-    { name:      :sidekiq_heap_free_slots,
-      type:      :gauge,
-      docstring: 'Sidekiq worker GC.stat[:heap_free_slots]', },
-    { name:      :sidekiq_heap_live_slots,
-      type:      :gauge,
-      docstring: 'Sidekiq worker GC.stat[:heap_live_slots]', },
-    { name:      :sidekiq_major_gc_count,
-      type:      :counter,
-      docstring: 'Sidekiq worker GC.stat[:major_gc_count]', },
-    { name:      :sidekiq_minor_gc_count,
-      type:      :counter,
-      docstring: 'Sidekiq worker GC.stat[:minor_gc_count]', },
-    { name:      :sidekiq_rss,
-      type:      :gauge,
-      docstring: 'Sidekiq process RSS', },
+    {name: :sidekiq_allocated_objects,
+     type: :counter,
+     docstring: "Count of ruby objects allocated by a Sidekiq worker"},
+    {name: :sidekiq_heap_free_slots,
+     type: :gauge,
+     docstring: "Sidekiq worker GC.stat[:heap_free_slots]"},
+    {name: :sidekiq_heap_live_slots,
+     type: :gauge,
+     docstring: "Sidekiq worker GC.stat[:heap_live_slots]"},
+    {name: :sidekiq_major_gc_count,
+     type: :counter,
+     docstring: "Sidekiq worker GC.stat[:major_gc_count]"},
+    {name: :sidekiq_minor_gc_count,
+     type: :counter,
+     docstring: "Sidekiq worker GC.stat[:minor_gc_count]"},
+    {name: :sidekiq_rss,
+     type: :gauge,
+     docstring: "Sidekiq process RSS"}
   ].freeze
 
   def registry
@@ -131,6 +131,16 @@ module SidekiqPrometheus::Metrics
     end
   end
 
+  def unregister_sidekiq_global_metrics
+    unregister_metrics SIDEKIQ_GLOBAL_METRICS
+  end
+
+  def unregister_metrics(metrics)
+    metrics.each do |metric|
+      unregister(name: metric[:name])
+    end
+  end
+
   ##
   # Fetch a metric from the registry
   # @param name [Symbol] name of metric to fetch
@@ -139,7 +149,7 @@ module SidekiqPrometheus::Metrics
   end
 
   class << self
-    alias get []
+    alias_method :get, :[]
   end
 
   ##
@@ -160,13 +170,18 @@ module SidekiqPrometheus::Metrics
     # Aggregate all labels
     all_labels = labels | SidekiqPrometheus.custom_labels.fetch(name, []) | all_preset_labels.keys
 
-    options = { docstring: docstring,
-                labels: all_labels,
-                preset_labels: all_preset_labels, }
+    options = {docstring: docstring,
+               labels: all_labels,
+               preset_labels: all_preset_labels}
 
     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/periodic_metrics.rb

@@ -11,7 +11,7 @@
 # @see https://github.com/mperham/sidekiq/blob/main/lib/sidekiq/api.rb
 
 begin
-  require 'sidekiq/component'
+  require "sidekiq/component"
 rescue LoadError
 end
 
@@ -21,6 +21,9 @@ class SidekiqPrometheus::PeriodicMetrics
   # @return [Boolean] When +true+ will stop the reporting loop.
   attr_accessor :done
 
+  # @return [Boolean] Indicates if this instance is currently the leader.
+  attr_accessor :leader
+
   # @return [Integer] Interval in seconds to record metrics. Default: [SidekiqPrometheus.periodic_reporting_interval]
   attr_reader :interval
   attr_reader :senate, :sidekiq_stats, :sidekiq_queue
@@ -28,7 +31,7 @@ class SidekiqPrometheus::PeriodicMetrics
   GLOBAL_STATS = %i[failed processed retry_size dead_size scheduled_size workers_size processes_size].freeze
   GC_STATS = {
     counters: %i[major_gc_count minor_gc_count total_allocated_objects],
-    gauges: %i[heap_live_slots heap_free_slots],
+    gauges: %i[heap_live_slots heap_free_slots]
   }.freeze
   REDIS_STATS = %w[connected_clients used_memory used_memory_peak].freeze
 
@@ -50,24 +53,25 @@ class SidekiqPrometheus::PeriodicMetrics
     @sidekiq_stats = sidekiq_stats
     @sidekiq_queue = sidekiq_queue
     @senate = if senate.nil?
-                if Object.const_defined?('Sidekiq::Senate')
-                  if respond_to?(:leader?)
-                    self
-                  else
-                    Sidekiq::Senate
-                  end
-                else
-                  Senate
-                end
-              else
-                senate
-              end
+      if Object.const_defined?("Sidekiq::Senate")
+        if respond_to?(:leader?)
+          self
+        else
+          Sidekiq::Senate
+        end
+      else
+        Senate
+      end
+    else
+      senate
+    end
+    @leader = false
   end
 
   ##
   # Start the period mettric reporter
   def start
-    Sidekiq.logger.info('SidekiqPrometheus: Starting periodic metrics reporting')
+    Sidekiq.logger.info("SidekiqPrometheus: Starting periodic metrics reporting")
     @thread = Thread.new(&method(:run))
   end
 
@@ -100,8 +104,8 @@ class SidekiqPrometheus::PeriodicMetrics
     end
 
     sidekiq_queue.all.each do |queue|
-      SidekiqPrometheus[:sidekiq_enqueued]&.set(queue.size, labels: { queue: queue.name })
-      SidekiqPrometheus[:sidekiq_queue_latency]&.observe(queue.latency, labels: { queue: queue.name })
+      SidekiqPrometheus[:sidekiq_enqueued]&.set(queue.size, labels: {queue: queue.name})
+      SidekiqPrometheus[:sidekiq_queue_latency]&.observe(queue.latency, labels: {queue: queue.name})
     end
   end
 
@@ -122,7 +126,7 @@ class SidekiqPrometheus::PeriodicMetrics
 
     db_stats = redis_info.select { |k, _v| k.match(/^db/) }
     db_stats.each do |db, stat|
-      label = { database: db }
+      label = {database: db}
       values = stat.scan(/\d+/)
       SidekiqPrometheus[:sidekiq_redis_keys]&.set(values[0].to_i, labels: label)
       SidekiqPrometheus[:sidekiq_redis_expires]&.set(values[1].to_i, labels: label)
@@ -134,8 +138,16 @@ class SidekiqPrometheus::PeriodicMetrics
   # @see https://github.com/discourse/prometheus_exporter/blob/v0.3.3/lib/prometheus_exporter/instrumentation/process.rb#L39-L42
   def rss
     pid = Process.pid
-    @pagesize ||= `getconf PAGESIZE`.to_i rescue 4096
-    File.read("/proc/#{pid}/statm").split(' ')[1].to_i * @pagesize rescue 0
+    @pagesize ||= begin
+      `getconf PAGESIZE`.to_i
+    rescue
+      4096
+    end
+    begin
+      File.read("/proc/#{pid}/statm").split(" ")[1].to_i * @pagesize
+    rescue
+      0
+    end
   end
 
   ##
@@ -144,10 +156,14 @@ class SidekiqPrometheus::PeriodicMetrics
   def run
     until done
       begin
-        report_global_metrics if SidekiqPrometheus.global_metrics_enabled? && senate.leader?
-        report_redis_metrics if SidekiqPrometheus.global_metrics_enabled? && senate.leader?
+        if SidekiqPrometheus.global_metrics_enabled?
+          handle_leader_state(senate.leader?)
+          report_global_metrics if leader
+          report_redis_metrics if leader
+        end
+
         report_gc_metrics if SidekiqPrometheus.gc_metrics_enabled?
-      rescue StandardError => e
+      rescue => e
         Sidekiq.logger.error e
       ensure
         sleep interval
@@ -155,6 +171,22 @@ class SidekiqPrometheus::PeriodicMetrics
     end
   end
 
+  ##
+  # If this instance was promoted to the leader set the local state and register the metrics.
+  def handle_leader_state(senate_leader)
+    return if senate_leader == leader
+
+    if senate_leader && !leader
+      # This instance is now the leader
+      self.leader = true
+      SidekiqPrometheus::Metrics.register_sidekiq_global_metrics
+    else
+      # we've been demoted!
+      SidekiqPrometheus::Metrics.unregister_sidekiq_global_metrics
+      self.leader = false
+    end
+  end
+
   ##
   # Fake Senate class to guard against undefined constant errors.
   # @private

data/lib/sidekiq_prometheus/version.rb

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

data/lib/sidekiq_prometheus.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'benchmark'
-require 'rack'
-require 'prometheus/client'
-require 'prometheus/middleware/exporter'
-require 'sidekiq'
-require 'sidekiq/api'
-require 'webrick'
+require "benchmark"
+require "rack"
+require "prometheus/client"
+require "prometheus/middleware/exporter"
+require "sidekiq"
+require "sidekiq/api"
+require "webrick"
 
 begin
-  require 'sidekiq/ent'
+  require "sidekiq/ent"
 rescue LoadError
 end
 
@@ -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
 
@@ -77,11 +85,12 @@ module SidekiqPrometheus
   self.global_metrics_enabled = true
   self.periodic_reporting_interval = 30
   self.metrics_server_enabled = true
-  self.metrics_host = 'localhost'
+  self.metrics_host = "localhost"
   self.metrics_port = 9359
   self.metrics_server_logger_enabled = true
   self.custom_labels = {}
   self.custom_metrics = []
+  self.init_label_sets = {}
 
   module_function
 
@@ -115,7 +124,7 @@ module SidekiqPrometheus
   # Requires +Sidekiq::Enterprise+ as it uses the leader election functionality
   # @return [Boolean] defaults to true if +Sidekiq::Enterprise+ is available
   def global_metrics_enabled?
-    Object.const_defined?('Sidekiq::Enterprise') && global_metrics_enabled
+    Object.const_defined?("Sidekiq::Enterprise") && global_metrics_enabled
   end
 
   ##
@@ -149,8 +158,8 @@ module SidekiqPrometheus
   end
 
   class << self
-    alias configure! configure
-    alias get []
+    alias_method :configure!, :configure
+    alias_method :get, :[]
   end
 
   ##
@@ -166,7 +175,7 @@ module SidekiqPrometheus
   def register_custom_metrics
     return if custom_metrics.empty?
 
-    raise SidekiqPrometheus::Error, 'custom_metrics is not an array.' unless custom_metrics.is_a?(Array)
+    raise SidekiqPrometheus::Error, "custom_metrics is not an array." unless custom_metrics.is_a?(Array)
 
     SidekiqPrometheus::Metrics.register_metrics(custom_metrics)
   end
@@ -178,7 +187,6 @@ module SidekiqPrometheus
     SidekiqPrometheus::Metrics.register_sidekiq_job_metrics
     SidekiqPrometheus::Metrics.register_sidekiq_gc_metric if gc_metrics_enabled?
     SidekiqPrometheus::Metrics.register_sidekiq_worker_gc_metrics if gc_metrics_enabled? && periodic_metrics_enabled?
-    SidekiqPrometheus::Metrics.register_sidekiq_global_metrics if global_metrics_enabled? && periodic_metrics_enabled?
     register_custom_metrics
 
     sidekiq_setup
@@ -195,12 +203,12 @@ module SidekiqPrometheus
       end
 
       if periodic_metrics_enabled?
-        config.on(:startup)  { SidekiqPrometheus::PeriodicMetrics.reporter(config).start }
+        config.on(:startup) { SidekiqPrometheus::PeriodicMetrics.reporter(config).start }
         config.on(:shutdown) { SidekiqPrometheus::PeriodicMetrics.reporter(config).stop }
       end
 
       if metrics_server_enabled?
-        config.on(:startup)  { SidekiqPrometheus.metrics_server }
+        config.on(:startup) { SidekiqPrometheus.metrics_server }
         config.on(:shutdown) { SidekiqPrometheus.metrics_server.kill }
       end
     end
@@ -213,11 +221,11 @@ module SidekiqPrometheus
   def metrics_server
     opts = {
       Port: SidekiqPrometheus.metrics_port,
-      Host: SidekiqPrometheus.metrics_host,
+      Host: SidekiqPrometheus.metrics_host
     }
 
     unless metrics_server_logger_enabled?
-      opts[:Logger] = WEBrick::Log.new('/dev/null')
+      opts[:Logger] = WEBrick::Log.new("/dev/null")
       opts[:AccessLog] = []
     end
 
@@ -225,7 +233,7 @@ module SidekiqPrometheus
       Rack::Handler::WEBrick.run(
         Rack::Builder.new {
           use Prometheus::Middleware::Exporter, registry: SidekiqPrometheus.registry
-          run ->(_) { [301, { 'Location' => '/metrics' }, []] }
+          run ->(_) { [301, {"Location" => "/metrics"}, []] }
         },
         **opts
       )
@@ -235,7 +243,7 @@ end
 
 class SidekiqPrometheus::Error < StandardError; end
 
-require 'sidekiq_prometheus/job_metrics'
-require 'sidekiq_prometheus/metrics'
-require 'sidekiq_prometheus/periodic_metrics'
-require 'sidekiq_prometheus/version'
+require "sidekiq_prometheus/job_metrics"
+require "sidekiq_prometheus/metrics"
+require "sidekiq_prometheus/periodic_metrics"
+require "sidekiq_prometheus/version"

data/sidekiq_prometheus.gemspec

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sidekiq_prometheus/version'
+require "sidekiq_prometheus/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'sidekiq_prometheus'
-  spec.version       = SidekiqPrometheus::VERSION
-  spec.authors       = ['Lukas Eklund', 'NHM Tanveer Hossain Khan']
-  spec.email         = ['leklund@fastly.com']
+  spec.name = "sidekiq_prometheus"
+  spec.version = SidekiqPrometheus::VERSION
+  spec.authors = ["Lukas Eklund", "NHM Tanveer Hossain Khan"]
+  spec.email = ["leklund@fastly.com"]
 
-  spec.summary       = 'Prometheus Instrumentation for Sidekiq'
-  spec.homepage      = 'https://github.com/fastly/sidekiq-prometheus'
-  spec.license       = 'MIT'
+  spec.summary = "Prometheus Instrumentation for Sidekiq"
+  spec.homepage = "https://github.com/fastly/sidekiq-prometheus"
+  spec.license = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry'
-  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_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard"
 
-  spec.add_runtime_dependency 'prometheus-client', '>= 2.0'
-  spec.add_runtime_dependency 'rack'
-  spec.add_runtime_dependency 'sidekiq', '> 5.1', '< 7.0'
-  spec.add_runtime_dependency 'webrick'
+  spec.add_runtime_dependency "prometheus-client", ">= 2.0"
+  spec.add_runtime_dependency "rack"
+  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.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Lukas Eklund
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,19 +68,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.58.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.58.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Prometheus Instrumentation for Sidekiq