sidekiq_prometheus 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533328fbd15652e9ffdc91457329eff4680f0a897b312343f9a3bea92c22795f
-  data.tar.gz: 3fa2b8614e19dd00baebd3387ddebfd52492901016a9a3ec6edb70a19d013716
+  metadata.gz: 6cef078a53e6742cd0cea7140dbe65ab96849acc8886880f530cbe208ee8fefc
+  data.tar.gz: 63dc0623415214f85a2bcb0b37cfaef012a016bb75d430763d9bfa3ed097460a
 SHA512:
-  metadata.gz: e0e51ed626201c49c023e914bbb5676d158f5e6cad2369a0b9b2b1fd8506d2190b6b905de1e34d7d39a4d2ce211feeb4ae005c42bdc63fda94e942bbe5dc4540
-  data.tar.gz: 67c7663c062de7105d921818b499c5bf0e8e6b2c4109b5d08ea513f94c526967dea885185782a3f2895ca22b569798b2fc1e993041f2fc8ff6f8c53dc142168e
+  metadata.gz: 3721b3aaf34de0717d2d23639aeb2413fe5f9b9580ae1f07bcf333bcfae1d7c110425b1e0c850d06ba29459ca7506d06130322dd3ea1461e164c3264228628c0
+  data.tar.gz: cf08ac6f8f3779c3a8789063de3073e4838945cd4d6190b7284184c19bbd2ec2f156143502a160f9b9a91fb11bb644ca2f43e20aa11533313f4ada60d80a2a21

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 CHANGELOG
 
+<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

@@ -81,6 +81,7 @@ 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`
@@ -94,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
 ```
@@ -245,7 +247,7 @@ 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`.
 
@@ -253,6 +255,8 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 * 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))
 
 ## Contributing
 

data/lib/sidekiq_prometheus.rb

@@ -47,6 +47,9 @@ 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
 
@@ -69,6 +72,7 @@ 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 = {}
@@ -117,6 +121,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
@@ -176,8 +187,10 @@ 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
 

data/lib/sidekiq_prometheus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPrometheus
-  VERSION = '1.1.0'
+  VERSION = '1.2.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', '~> 1.0'
+  spec.add_runtime_dependency 'prometheus-client', '~> 2.0'
   spec.add_runtime_dependency 'rack'
   spec.add_runtime_dependency 'sidekiq', '> 5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lukas Eklund
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -168,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Prometheus Instrumentation for Sidekiq