sidekiq_prometheus 0.9.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 109c4043a6a4fec7f4240feb567b8919c97e90e92624d829d60f915787307b8e
-  data.tar.gz: e922e320009be0ac69ffeb11c64ce78c74ea803af76bff6dbfd9ec1148cfb5d4
+  metadata.gz: d3f496cf0e6e5f8cd1b1642d324029bfaa2eec41eed88c54c570cda486a25d9c
+  data.tar.gz: 64b0a6b104b23cb4081bbb5d006b8fd958b397a18e2c35c4cdcb37c9b8ac8e25
 SHA512:
-  metadata.gz: 8299b54bd66498be1891a5e408d1baa2b40a3277a87c676a02b49b96fd898738f1a4cd4ecd1533a0a360e4f21797cde92b3b4fb308d688fc3ba14637e8f4f27e
-  data.tar.gz: ed121301c19da12849cd166d12f7701e81e52aa9fda24cbcde99b364b18b7650a8ebb77e1267b1a778faa827c42fcd95f5e4c00c35952facd8f62ae7aa5ba759
+  metadata.gz: e14cb219e363d1d13e1c1c40fd56e14e0dcbb873240482ef685f48a948f170af0f7e44d3530ceff578b421f1d938445526e98311b0b8d4280f27d7d4863bd3f9
+  data.tar.gz: e309be13ae7d718f1746d4fdb05977673b4d1f067e979bb37309280c0d7bf8de6b6b7f73f9cabea1ad9459d995a98b76c334ba73c2a272ec6e6e3496b6cd402a

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 .rspec_status
 Gemfile.lock
+/.idea/

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 CHANGELOG
 
+<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)
+
+### Pull Requests
+
+* Merge pull request [#9](https://github.com/fastly/sidekiq-prometheus/issues/9) from we4tech/features/update-prometheus-client
+
+
+<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)
+
+### Bug Fixes
+
+* properly alias configure!
+
+
 <a name="v0.9.0"></a>
 ## [v0.9.0](https://github.com/fastly/sidekiq-prometheus/compare/v0.8.1...v0.9.0) (2019-03-18)
 

data/README.md

@@ -58,24 +58,25 @@ You can configure the gem by calling `configure`:
 
 ```ruby
 SidekiqPrometheus.configure do |config|
-  config.base_labels = { service: 'kubernandos_api' }
+  config.preset_labels = { service: 'kubernandos_api' }
 end
 ```
 
 `configure` will automatically call setup so
 
-If you are running multiple services that will be reporting Sidekiq metrics you will want to take advantage of the `base_labels` configuration option. For example:
+If you are running multiple services that will be reporting Sidekiq metrics you will want to take advantage of the `preset_labels` configuration option. For example:
 
 ```ruby
 SidekiqPrometheus.configure do |config|
-  config.base_labels  = { service: 'image_api' }
+  config.preset_labels  = { service: 'image_api' }
   config.metrics_port = 9090
 end
 ```
 
 #### Configuration options
 
-* `base_labels`: Hash of labels that will be included with every metric when they are registered.
+* `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. 
 * `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`.
@@ -85,7 +86,8 @@ end
 
 ```ruby
 SidekiqPrometheus.configure do |config|
-  config.base_labels                   = { service: 'myapp' }
+  config.preset_labels                 = { service: 'myapp' }
+  config.custom_labels                 = [:worker_class, :job_type, :any_other_label]
   config.gc_metrics_enabled            = false
   config.global_metrics_enabled        = true
   config.periodic_metrics_enabled      = true
@@ -94,7 +96,8 @@ 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
 class SomeWorker
@@ -164,7 +167,7 @@ which ensures that metrics are only reported once per cluster.
 | sidekiq_redis_keys | gauge | Number of redis keys |
 | sidekiq_redis_expires | gauge | Number of redis keys with expiry set |
 
-The global metrics are reported with the only the `base_labels` with the exception of `sidekiq_enqueued` which will add a `queue` label and record a metric per Sidekiq queue.
+The global metrics are reported with the only the `preset_labels` with the exception of `sidekiq_enqueued` which will add a `queue` label and record a metric per Sidekiq queue.
 
 ## Custom Worker Metrics
 
@@ -175,14 +178,14 @@ There are a few different ways to register custom metrics with SidekiqPrometheus
   name:        :metric_name,
   type:        :gauge,
   docstring:   'description',
-  base_labels: { label_name: 'label_text' },
+  preset_labels: { label_name: 'label_text' },
 }
 ```
 
 * `:name` (required) - Unique name of the metric and should be a symbol.
 * `:type` (required) - Prometheus metric type. Supported values are: `:counter`, `:gauge`, `:histogram`, and `:summary`.
 * `:docstring` (required) - Human readable description of the metric.
-* `:base_labels` (optional) - Hash of labels that will be applied to every instance of this metric.
+* `:preset_labels` (optional) - Hash of labels that will be applied to every instance of this metric.
 
 #### Registering custom metrics:
 

data/lib/sidekiq_prometheus.rb

@@ -14,10 +14,10 @@ end
 
 module SidekiqPrometheus
   class << self
-    # @return [Hash] Base labels applied to every registered metric
-    attr_accessor :base_labels
+    # @return [Hash] Preset labels applied to every registered metric
+    attr_accessor :preset_labels
 
-    # @return [Hash] Custom labels applied to specific metrics
+    # @return [Hash{Symbol => Array<Symbol>}] Custom labels applied to specific metrics
     attr_accessor :custom_labels
 
     # @return [Array] Custom metrics that will be registered on setup.
@@ -27,12 +27,12 @@ module SidekiqPrometheus
     #       name: :metric_name,
     #       type: :prometheus_metric_type,
     #       docstring: 'Description of the metric',
-    #       base_labels : { label: 'value' },
+    #       preset_labels : { label: 'value' },
     #     }
     #   ]
     # @note Each element of the array is a hash and must have the required keys: `:name`, `:type`, and `:docstring`.
     #   The values for `:name` and `:type` should be symbols and `:docstring` should be a string.
-    #   `base_labels` is optional and, if used, must be a hash of labels that will be included on every instance of this metric.
+    #   `preset_labels` is optional and, if used, must be a hash of labels that will be included on every instance of this metric.
     attr_accessor :custom_metrics
 
     # @return [Boolean] Setting to control enabling/disabling GC metrics. Default: true
@@ -82,8 +82,8 @@ module SidekiqPrometheus
   # Configure SidekiqPrometheus and setup for reporting
   # @example
   #   SidekiqPrometheus.configure do |config|
-  #     config.base_labels = { service: 'images_api' }
-  #     config.custom_labels = { sidekiq_job_count: { object_klass: nil } }
+  #     config.preset_labels = { service: 'images_api' }
+  #     config.custom_labels = { sidekiq_job_count: [:custom_label_1, :custom_label_2] } }
   #     config.gc_metrics_enabled = true
   #   end
   def configure

data/lib/sidekiq_prometheus/job_metrics.rb

@@ -15,20 +15,20 @@ class SidekiqPrometheus::JobMetrics
       # In case the labels have changed after the worker perform method has been called
       labels.merge!(custom_labels(worker))
 
-      registry[:sidekiq_job_duration].observe(labels, duration)
-      registry[:sidekiq_job_success].increment(labels)
+      registry[:sidekiq_job_duration].observe(duration, labels: labels)
+      registry[:sidekiq_job_success].increment(labels: labels)
 
       if SidekiqPrometheus.gc_metrics_enabled?
         allocated = GC.stat(:total_allocated_objects) - before
-        registry[:sidekiq_job_allocated_objects].observe(labels, allocated)
+        registry[:sidekiq_job_allocated_objects].observe(allocated, labels: labels)
       end
 
       result
     rescue StandardError => e
-      registry[:sidekiq_job_failed].increment(labels)
+      registry[:sidekiq_job_failed].increment(labels: labels)
       raise e
     ensure
-      registry[:sidekiq_job_count].increment(labels)
+      registry[:sidekiq_job_count].increment(labels: labels)
     end
   end
 

data/lib/sidekiq_prometheus/metrics.rb

@@ -6,6 +6,7 @@ module SidekiqPrometheus::Metrics
   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,
@@ -15,10 +16,12 @@ module SidekiqPrometheus::Metrics
       docstring: 'Total Dead Size', },
     { name:      :sidekiq_enqueued,
       type:      :gauge,
-      docstring: 'Total Size of all known queues', },
+      docstring: 'Total Size of all known queues',
+      labels:    %i[queue], },
     { name:      :sidekiq_queue_latency,
       type:      :summary,
-      docstring: 'Latency (in seconds) of all queues', },
+      docstring: 'Latency (in seconds) of all queues',
+      labels:    %i[queue], },
     { name:      :sidekiq_failed,
       type:      :gauge,
       docstring: 'Number of job executions which raised an error', },
@@ -42,30 +45,37 @@ module SidekiqPrometheus::Metrics
       docstring: 'Used memory peak from Redis.info', },
     { name:      :sidekiq_redis_keys,
       type:      :gauge,
-      docstring: 'Number of redis keys', },
+      docstring: 'Number of redis keys',
+      labels:     %i[database], },
     { name:      :sidekiq_redis_expires,
       type:      :gauge,
-      docstring: 'Number of redis keys with expiry set', },
+      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', },
+      docstring: 'Count of Sidekiq jobs',
+      labels:    JOB_LABELS, },
     { name:      :sidekiq_job_duration,
       type:      :histogram,
-      docstring: 'Sidekiq job processing duration', },
+      docstring: 'Sidekiq job processing duration',
+      labels:    JOB_LABELS, },
     { name:      :sidekiq_job_failed,
       type:      :counter,
-      docstring: 'Count of failed Sidekiq jobs', },
+      docstring: 'Count of failed Sidekiq jobs',
+      labels:    JOB_LABELS, },
     { name:      :sidekiq_job_success,
       type:      :counter,
-      docstring: 'Count of successful Sidekiq jobs', },
+      docstring: 'Count of successful 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,
   }.freeze
   SIDEKIQ_WORKER_GC_METRICS = [
     { name:      :sidekiq_allocated_objects,
@@ -130,21 +140,26 @@ module SidekiqPrometheus::Metrics
   # @param types [Symbol] type of metric to register. Valid types: %w(counter gauge summary histogram)
   # @param name [Symbol] name of metric
   # @param docstring [String] help text for metric
-  # @param base_labels [Hash] Optional hash of base labels to use for every instance of this metric
+  # @param labels [Array] Optionally an array of labels to configure for every instance of this metric
+  # @param preset_labels [Hash] Optionally a Hash of labels to use for every instance of this metric
   # @param buckets [Hash] Optional hash of bucket values. Only used for histogram metrics.
-  def register(type:, name:, docstring:, base_labels: {}, buckets: nil)
+  def register(type:, name:, docstring:, labels: [], preset_labels: {}, buckets: nil)
     raise InvalidMetricType, type unless VALID_TYPES.include? type
 
-    custom_labels = SidekiqPrometheus.custom_labels[name]
+    # Aggregate all preset labels
+    all_preset_labels = preset_labels.dup
+    all_preset_labels.merge!(SidekiqPrometheus.preset_labels) if SidekiqPrometheus.preset_labels
 
-    base_labels.merge! custom_labels if custom_labels&.is_a?(Hash)
-    base_labels.merge! SidekiqPrometheus.base_labels if SidekiqPrometheus.base_labels
+    # Aggregate all labels
+    all_labels = labels | SidekiqPrometheus.custom_labels.fetch(name, []) | all_preset_labels.keys
 
-    args = [name.to_sym, docstring]
-    args << base_labels
-    args << buckets if buckets
+    options = { docstring: docstring,
+                labels: all_labels,
+                preset_labels: all_preset_labels, }
 
-    registry.send(type, *args)
+    options[:buckets] = buckets if buckets
+
+    registry.send(type, name.to_sym, options)
   end
 
   def unregister(name:)

data/lib/sidekiq_prometheus/periodic_metrics.rb

@@ -71,13 +71,13 @@ class SidekiqPrometheus::PeriodicMetrics
   def report_gc_metrics
     stats = GC.stat
     GC_STATS[:counters].each do |stat|
-      SidekiqPrometheus["sidekiq_#{stat}"]&.increment({}, stats[stat])
+      SidekiqPrometheus["sidekiq_#{stat}"]&.increment(labels: {}, by: stats[stat])
     end
     GC_STATS[:gauges].each do |stat|
-      SidekiqPrometheus["sidekiq_#{stat}"]&.set({}, stats[stat])
+      SidekiqPrometheus["sidekiq_#{stat}"]&.set(stats[stat], labels: {})
     end
 
-    SidekiqPrometheus[:sidekiq_rss]&.set({}, rss)
+    SidekiqPrometheus[:sidekiq_rss]&.set(rss, labels: {})
   end
 
   ##
@@ -85,12 +85,12 @@ class SidekiqPrometheus::PeriodicMetrics
   def report_global_metrics
     current_stats = sidekiq_stats.new
     GLOBAL_STATS.each do |stat|
-      SidekiqPrometheus["sidekiq_#{stat}"]&.set({}, current_stats.send(stat))
+      SidekiqPrometheus["sidekiq_#{stat}"]&.set(current_stats.send(stat), labels: {})
     end
 
     sidekiq_queue.all.each do |queue|
-      SidekiqPrometheus[:sidekiq_enqueued]&.set({ queue: queue.name }, queue.size)
-      SidekiqPrometheus[:sidekiq_queue_latency]&.observe({ queue: queue.name }, queue.latency)
+      SidekiqPrometheus[:sidekiq_enqueued]&.set(queue.size, labels: { queue: queue.name })
+      SidekiqPrometheus[:sidekiq_queue_latency]&.observe(queue.latency, labels: { queue: queue.name })
     end
   end
 
@@ -106,15 +106,15 @@ class SidekiqPrometheus::PeriodicMetrics
     return if redis_info.nil?
 
     REDIS_STATS.each do |stat|
-      SidekiqPrometheus["sidekiq_redis_#{stat}"]&.set({}, redis_info[stat].to_i)
+      SidekiqPrometheus["sidekiq_redis_#{stat}"]&.set(redis_info[stat].to_i, labels: {})
     end
 
     db_stats = redis_info.select { |k, _v| k.match(/^db/) }
     db_stats.each do |db, stat|
       label = { database: db }
       values = stat.scan(/\d+/)
-      SidekiqPrometheus[:sidekiq_redis_keys]&.set(label, values[0].to_i)
-      SidekiqPrometheus[:sidekiq_redis_expires]&.set(label, values[1].to_i)
+      SidekiqPrometheus[:sidekiq_redis_keys]&.set(values[0].to_i, labels: label)
+      SidekiqPrometheus[:sidekiq_redis_expires]&.set(values[1].to_i, labels: label)
     end
   end
 

data/lib/sidekiq_prometheus/version.rb

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

data/sidekiq_prometheus.gemspec

@@ -27,7 +27,7 @@ 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', '~> 0.8.0'
+  spec.add_runtime_dependency 'prometheus-client', '~> 0.10.0'
   spec.add_runtime_dependency 'rack'
-  spec.add_runtime_dependency 'sidekiq', '> 5.1'
+  spec.add_runtime_dependency 'sidekiq', '~> 5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Lukas Eklund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,14 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
 description: