sidekiq_prometheus 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f496cf0e6e5f8cd1b1642d324029bfaa2eec41eed88c54c570cda486a25d9c
-  data.tar.gz: 64b0a6b104b23cb4081bbb5d006b8fd958b397a18e2c35c4cdcb37c9b8ac8e25
+  metadata.gz: bd485c3e82871eb0083e0f8c66b506d72624cdc48bcee1fa2e3c0d45eee9a8fa
+  data.tar.gz: a1e2fa1f170d6c2115c6de05bb9f029f4bc6c54f0fa208a683c9a074afc06c06
 SHA512:
-  metadata.gz: e14cb219e363d1d13e1c1c40fd56e14e0dcbb873240482ef685f48a948f170af0f7e44d3530ceff578b421f1d938445526e98311b0b8d4280f27d7d4863bd3f9
-  data.tar.gz: e309be13ae7d718f1746d4fdb05977673b4d1f067e979bb37309280c0d7bf8de6b6b7f73f9cabea1ad9459d995a98b76c334ba73c2a272ec6e6e3496b6cd402a
+  metadata.gz: f52ccff4847c333ba9c50d9e5033214f0d739edd4eca461b1b9b5406c6d236505b0e3e7fcc04f7f26bc460debb16e0ada2f1834ffc49c73b24f8c9369fe21bff
+  data.tar.gz: 7e0e854ab573ead62b8ff19a1a8d736587e00250a4fd447a9bbc393d1765c7eab8083d6beb9f14ac7e766d88d28875088f8ee5a3bf2c77d34a1d00af5a573136

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 CHANGELOG
 
+<a name="v1.3.0"></a>
+## [v1.3.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.2.0...v1.3.0) (2021-03-26)
+
+### Pull Requests
+
+* Merge pull request [#22](https://github.com/fastly/sidekiq-prometheus/issues/22) from mirubiri/add-active-job-support
+* Merge pull request [#20](https://github.com/fastly/sidekiq-prometheus/issues/20) from fastly/aw/move-to-main
+
+<a name="v1.2.0"></a>
+## [v1.2.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.1.0...v1.2.0) (2020-10-01)
+
+### Feature
+
+* allow the metrics host to be disabled with a configuration option
+* use prometheus-client ~> 2.0
+
+### 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 [#15](https://github.com/fastly/sidekiq-prometheus/issues/15) from silicakes/master
+
+<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)
+
+### Feature
+
+* allow for configuration of the metrics host (instead of always binding to 127.0.0.1)
+* Use prometheus-client ~> 1.0.0
+
+### Pull Requests
+
+* Merge pull request [#13](https://github.com/fastly/sidekiq-prometheus/issues/13) from postmodern/metrics_host
+* 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.0"></a>
 ## [v1.0.0](https://github.com/fastly/sidekiq-prometheus/compare/v0.9.1...v1.0.0) (2019-10-24)
 

data/README.md

@@ -1,7 +1,7 @@
 # Sidekiq Prometheus
 
 
-[![Status](https://travis-ci.org/fastly/sidekiq-prometheus.svg?branch=master)](https://travis-ci.org/fastly/sidekiq-prometheus)
+[![Status](https://travis-ci.org/fastly/sidekiq-prometheus.svg?branch=main)](https://travis-ci.org/fastly/sidekiq-prometheus)
 ![Gem](https://img.shields.io/gem/v/sidekiq_prometheus.svg?color=blue)
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
@@ -81,6 +81,9 @@ end
 * `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`.
 * `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`
+* `metrics_host`: Host on which the rack server will listen. Defaults to
+  `localhost`
 * `metrics_port`: Port on which the rack server will listen. Defaults to `9359`
 * `registry`: An instance of `Prometheus::Client::Registry`. If you have a registry with defined metrics you can use this option to pass in your registry.
 
@@ -92,6 +95,7 @@ SidekiqPrometheus.configure do |config|
   config.global_metrics_enabled        = true
   config.periodic_metrics_enabled      = true
   config.periodic_reporting_interval   = 20
+  config.metrics_server_enabled        = true
   config.metrics_port                  = 8675
 end
 ```
@@ -243,10 +247,18 @@ See the [documentation of the Prometheus::Client library](https://github.com/pro
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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))
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/fastly/sidekiq-prometheus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -261,4 +273,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SidekiqPrometheus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fastly/sidekiq-prometheus/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SidekiqPrometheus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fastly/sidekiq-prometheus/blob/main/CODE_OF_CONDUCT.md).
+
+# Metadata
+
+- Ignore

data/lib/sidekiq_prometheus.rb

@@ -6,6 +6,7 @@ require 'prometheus/client'
 require 'prometheus/middleware/exporter'
 require 'sidekiq'
 require 'sidekiq/api'
+require 'webrick'
 
 begin
   require 'sidekiq/ent'
@@ -47,6 +48,12 @@ module SidekiqPrometheus
     # @return [Integer] Interval in seconds to record metrics. Default: 30
     attr_accessor :periodic_reporting_interval
 
+    # @return [Boolean] Setting to control enabling/disabling the metrics server. Default: true
+    attr_accessor :metrics_server_enabled
+
+    # @return [String] Host on which the metrics server will listen. Default: localhost
+    attr_accessor :metrics_host
+
     # @return [Integer] Port on which the metrics server will listen. Default: 9357
     attr_accessor :metrics_port
 
@@ -66,6 +73,8 @@ module SidekiqPrometheus
   self.periodic_metrics_enabled = true
   self.global_metrics_enabled = true
   self.periodic_reporting_interval = 30
+  self.metrics_server_enabled = true
+  self.metrics_host = 'localhost'
   self.metrics_port = 9359
   self.custom_labels = {}
   self.custom_metrics = []
@@ -113,6 +122,13 @@ module SidekiqPrometheus
     periodic_metrics_enabled
   end
 
+  ##
+  # Helper method for +metrics_server_enabled+ configuration setting
+  # @return [Boolean] defaults to true
+  def metrics_server_enabled?
+    metrics_server_enabled
+  end
+
   ##
   # Get a metric from the registry
   # @param metric [Symbol] name of metric to fetch
@@ -172,14 +188,17 @@ module SidekiqPrometheus
         config.on(:shutdown) { SidekiqPrometheus::PeriodicMetrics.reporter.stop }
       end
 
-      config.on(:startup)  { SidekiqPrometheus.metrics_server }
-      config.on(:shutdown) { SidekiqPrometheus.metrics_server.kill }
+      if metrics_server_enabled?
+        config.on(:startup)  { SidekiqPrometheus.metrics_server }
+        config.on(:shutdown) { SidekiqPrometheus.metrics_server.kill }
+      end
     end
   end
 
   ##
   # Start a new Prometheus exporter in a new thread.
-  # Will listen on SidekiqPrometheus.metrics_port
+  # Will listen on SidekiqPrometheus.metrics_host and
+  # SidekiqPrometheus.metrics_port
   def metrics_server
     @_metrics_server ||= Thread.new do
       Rack::Handler::WEBrick.run(
@@ -188,7 +207,7 @@ module SidekiqPrometheus
           run ->(_) { [301, { 'Location' => '/metrics' }, []] }
         },
         Port: SidekiqPrometheus.metrics_port,
-        BindAddress: '127.0.0.1',
+        Host: SidekiqPrometheus.metrics_host,
       )
     end
   end

data/lib/sidekiq_prometheus/job_metrics.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 class SidekiqPrometheus::JobMetrics
-  def call(worker, _job, queue)
+  def call(worker, job, queue)
     before = GC.stat(:total_allocated_objects) if SidekiqPrometheus.gc_metrics_enabled?
 
-    labels = { class: worker.class.to_s, queue: queue }
+    # 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,
+    }
 
     begin
       labels.merge!(custom_labels(worker))

data/lib/sidekiq_prometheus/metrics.rb

@@ -107,7 +107,7 @@ module SidekiqPrometheus::Metrics
   end
 
   def register_sidekiq_gc_metric
-    register SIDEKIQ_GC_METRIC
+    register(**SIDEKIQ_GC_METRIC)
   end
 
   def register_sidekiq_worker_gc_metrics
@@ -120,7 +120,7 @@ module SidekiqPrometheus::Metrics
 
   def register_metrics(metrics)
     metrics.each do |metric|
-      register(metric)
+      register(**metric)
     end
   end
 
@@ -159,7 +159,7 @@ module SidekiqPrometheus::Metrics
 
     options[:buckets] = buckets if buckets
 
-    registry.send(type, name.to_sym, options)
+    registry.send(type, name.to_sym, **options)
   end
 
   def unregister(name:)

data/lib/sidekiq_prometheus/periodic_metrics.rb

@@ -8,7 +8,7 @@
 # one worker.
 #
 # @see https://github.com/mperham/sidekiq/wiki/Ent-Leader-Election
-# @see https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/api.rb
+# @see https://github.com/mperham/sidekiq/blob/main/lib/sidekiq/api.rb
 
 class SidekiqPrometheus::PeriodicMetrics
   # @return [Boolean] When +true+ will stop the reporting loop.

data/lib/sidekiq_prometheus/version.rb

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

data/sidekiq_prometheus.gemspec

@@ -7,7 +7,7 @@ require 'sidekiq_prometheus/version'
 Gem::Specification.new do |spec|
   spec.name          = 'sidekiq_prometheus'
   spec.version       = SidekiqPrometheus::VERSION
-  spec.authors       = ['Lukas Eklund']
+  spec.authors       = ['Lukas Eklund', 'NHM Tanveer Hossain Khan']
   spec.email         = ['leklund@fastly.com']
 
   spec.summary       = 'Prometheus Instrumentation for Sidekiq'
@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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_runtime_dependency 'prometheus-client', '~> 0.10.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'
+  spec.add_runtime_dependency 'webrick'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Lukas Eklund
-autorequire: 
+- NHM Tanveer Hossain Khan
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -112,17 +113,31 @@ 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: 
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - leklund@fastly.com
 executables: []
@@ -152,7 +167,7 @@ homepage: https://github.com/fastly/sidekiq-prometheus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,9 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Prometheus Instrumentation for Sidekiq
 test_files: []