sidekiq_prometheus 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49989dd6e8b4c7c651f70d69e674630900cf5eb3150c4be85df6becb83fc1d18
-  data.tar.gz: c42b2eac238eaa7c435628962872c750c08b1430a8166219de0343c4fe987fa5
+  metadata.gz: c76de7fe8caef12bc6e505dd5e01648c5da34d87b00a6cf756d232a1c988bb46
+  data.tar.gz: d211a23831395d5058a7c9ddb281870fde3154956194324984a816b54067e300
 SHA512:
-  metadata.gz: 23702691b261c1f0ea0984cccca1267cb5ad3be7a3ebd0ea4c7591d12bb9403e5104cedc372b023f440e080a71ff5c432022f35527ff1e898dba5d07a36ab056
-  data.tar.gz: 84197b360bbe8c54da5c1e83911643a274a132164bf699d2f8672fbc908e93216918dc405f829f919f9a27fbbaf25d4bed26ff132428f29d14599a5eed1f1d73
+  metadata.gz: 0cc266bed6f539d955405fe35b5e41a2f539b65ce7d4a552b70e745fe760a6e1a216ee22278889a193e7456e42bc72cc54b486b7f7266a2a3e80b33754c251f4
+  data.tar.gz: 1544e8d064ccc46548153382e531131e250b4bf8acf567daebbf40daab8d934c0d46ef11bdd05ad7ff16f6961b79a205bde999d4e17b1a27e272ca2c1dd1b827

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 CHANGELOG
 
+<a name="v1.6.0"></a>
+## [v1.6.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.5.0...v1.6.0) (2021-08-03)
+
+### Features
+
+* add option for silencing the WEBrick access logging of /metrics
+
+### Pull Requests
+
+* Merge pull request [#25](https://github.com/fastly/sidekiq-prometheus/issues/25) from fastly/option_for_silencing_webrick
+
 
 <a name="v1.5.0"></a>
 ## [v1.5.0](https://github.com/fastly/sidekiq-prometheus/compare/v1.4.0...v1.5.0) (2021-08-02)

data/README.md

@@ -82,6 +82,7 @@ end
 * `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_server_logger_enabled`: Boolean that determines if the metrics server will log access logs. 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`

data/lib/sidekiq_prometheus/metrics.rb

@@ -11,6 +11,9 @@ module SidekiqPrometheus::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', },

data/lib/sidekiq_prometheus/periodic_metrics.rb

@@ -18,7 +18,7 @@ class SidekiqPrometheus::PeriodicMetrics
   attr_reader :interval
   attr_reader :senate, :sidekiq_stats, :sidekiq_queue
 
-  GLOBAL_STATS = %i[failed processed retry_size dead_size scheduled_size workers_size].freeze
+  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],

data/lib/sidekiq_prometheus/version.rb

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

data/lib/sidekiq_prometheus.rb

@@ -57,6 +57,9 @@ module SidekiqPrometheus
     # @return [Integer] Port on which the metrics server will listen. Default: 9357
     attr_accessor :metrics_port
 
+    # @return [Boolean] When set to false will silence the metric server access logs. Default: true
+    attr_accessor :metrics_server_logger_enabled
+
     # Override the default Prometheus::Client
     # @return [Prometheus::Client]
     attr_writer :client
@@ -76,6 +79,7 @@ module SidekiqPrometheus
   self.metrics_server_enabled = true
   self.metrics_host = 'localhost'
   self.metrics_port = 9359
+  self.metrics_server_logger_enabled = true
   self.custom_labels = {}
   self.custom_metrics = []
 
@@ -129,6 +133,13 @@ module SidekiqPrometheus
     metrics_server_enabled
   end
 
+  ##
+  # Helper method for +metrics_server_logger_enabled+ configuration setting
+  # @return [Boolean] defaults to true
+  def metrics_server_logger_enabled?
+    metrics_server_logger_enabled
+  end
+
   ##
   # Get a metric from the registry
   # @param metric [Symbol] name of metric to fetch
@@ -200,14 +211,23 @@ module SidekiqPrometheus
   # Will listen on SidekiqPrometheus.metrics_host and
   # SidekiqPrometheus.metrics_port
   def metrics_server
+    opts = {
+      Port: SidekiqPrometheus.metrics_port,
+      Host: SidekiqPrometheus.metrics_host,
+    }
+
+    unless metrics_server_logger_enabled?
+      opts[:Logger] = WEBrick::Log.new('/dev/null')
+      opts[:AccessLog] = []
+    end
+
     @_metrics_server ||= Thread.new do
       Rack::Handler::WEBrick.run(
         Rack::Builder.new {
           use Prometheus::Middleware::Exporter, registry: SidekiqPrometheus.registry
           run ->(_) { [301, { 'Location' => '/metrics' }, []] }
         },
-        Port: SidekiqPrometheus.metrics_port,
-        Host: SidekiqPrometheus.metrics_host,
+        **opts
       )
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_prometheus
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Lukas Eklund
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler