prometheus_exporter 2.1.0 → 2.2.0

data/lib/prometheus_exporter/server/sidekiq_process_collector.rb

@@ -5,8 +5,8 @@ module PrometheusExporter::Server
     MAX_METRIC_AGE = 60
 
     SIDEKIQ_PROCESS_GAUGES = {
-      'busy' => 'Number of running jobs',
-      'concurrency' => 'Maximum concurrency',
+      "busy" => "Number of running jobs",
+      "concurrency" => "Maximum concurrency",
     }.freeze
 
     attr_reader :sidekiq_metrics, :gauges
@@ -17,17 +17,21 @@ module PrometheusExporter::Server
     end
 
     def type
-      'sidekiq_process'
+      "sidekiq_process"
     end
 
     def metrics
       SIDEKIQ_PROCESS_GAUGES.each_key { |name| gauges[name]&.reset! }
 
       sidekiq_metrics.map do |metric|
-        labels = metric.fetch('labels', {})
+        labels = metric.fetch("labels", {})
         SIDEKIQ_PROCESS_GAUGES.map do |name, help|
           if (value = metric[name])
-            gauge = gauges[name] ||= PrometheusExporter::Metric::Gauge.new("sidekiq_process_#{name}", help)
+            gauge =
+              gauges[name] ||= PrometheusExporter::Metric::Gauge.new(
+                "sidekiq_process_#{name}",
+                help,
+              )
             gauge.observe(value, labels)
           end
         end

data/lib/prometheus_exporter/server/sidekiq_queue_collector.rb

@@ -4,8 +4,8 @@ module PrometheusExporter::Server
     MAX_METRIC_AGE = 60
 
     SIDEKIQ_QUEUE_GAUGES = {
-      'backlog' => 'Size of the sidekiq queue.',
-      'latency_seconds' => 'Latency of the sidekiq queue.',
+      "backlog" => "Size of the sidekiq queue.",
+      "latency_seconds" => "Latency of the sidekiq queue.",
     }.freeze
 
     attr_reader :sidekiq_metrics, :gauges
@@ -16,7 +16,7 @@ module PrometheusExporter::Server
     end
 
     def type
-      'sidekiq_queue'
+      "sidekiq_queue"
     end
 
     def metrics
@@ -26,7 +26,8 @@ module PrometheusExporter::Server
         labels = metric.fetch("labels", {})
         SIDEKIQ_QUEUE_GAUGES.map do |name, help|
           if (value = metric[name])
-            gauge = gauges[name] ||= PrometheusExporter::Metric::Gauge.new("sidekiq_queue_#{name}", help)
+            gauge =
+              gauges[name] ||= PrometheusExporter::Metric::Gauge.new("sidekiq_queue_#{name}", help)
             gauge.observe(value, labels)
           end
         end
@@ -36,8 +37,8 @@ module PrometheusExporter::Server
     end
 
     def collect(object)
-      object['queues'].each do |queue|
-        queue["labels"].merge!(object['custom_labels']) if object['custom_labels']
+      object["queues"].each do |queue|
+        queue["labels"].merge!(object["custom_labels"]) if object["custom_labels"]
         @sidekiq_metrics << queue
       end
     end

data/lib/prometheus_exporter/server/sidekiq_stats_collector.rb

@@ -5,14 +5,14 @@ module PrometheusExporter::Server
     MAX_METRIC_AGE = 60
 
     SIDEKIQ_STATS_GAUGES = {
-      'dead_size' => 'Size of dead the queue',
-      'enqueued' => 'Number of enqueued jobs',
-      'failed' => 'Number of failed jobs',
-      'processed' => 'Total number of processed jobs',
-      'processes_size' => 'Number of processes',
-      'retry_size' => 'Size of the retries queue',
-      'scheduled_size' => 'Size of the scheduled queue',
-      'workers_size' => 'Number of jobs actively being processed',
+      "dead_size" => "Size of dead the queue",
+      "enqueued" => "Number of enqueued jobs",
+      "failed" => "Number of failed jobs",
+      "processed" => "Total number of processed jobs",
+      "processes_size" => "Number of processes",
+      "retry_size" => "Size of the retries queue",
+      "scheduled_size" => "Size of the scheduled queue",
+      "workers_size" => "Number of jobs actively being processed",
     }.freeze
 
     attr_reader :sidekiq_metrics, :gauges
@@ -23,7 +23,7 @@ module PrometheusExporter::Server
     end
 
     def type
-      'sidekiq_stats'
+      "sidekiq_stats"
     end
 
     def metrics
@@ -31,8 +31,9 @@ module PrometheusExporter::Server
 
       sidekiq_metrics.map do |metric|
         SIDEKIQ_STATS_GAUGES.map do |name, help|
-          if (value = metric['stats'][name])
-            gauge = gauges[name] ||= PrometheusExporter::Metric::Gauge.new("sidekiq_stats_#{name}", help)
+          if (value = metric["stats"][name])
+            gauge =
+              gauges[name] ||= PrometheusExporter::Metric::Gauge.new("sidekiq_stats_#{name}", help)
             gauge.observe(value)
           end
         end

data/lib/prometheus_exporter/server/unicorn_collector.rb

@@ -7,9 +7,9 @@ module PrometheusExporter::Server
     MAX_METRIC_AGE = 60
 
     UNICORN_GAUGES = {
-      workers: 'Number of unicorn workers.',
-      active_workers: 'Number of active unicorn workers',
-      request_backlog: 'Number of requests waiting to be processed by a unicorn worker.'
+      workers: "Number of unicorn workers.",
+      active_workers: "Number of active unicorn workers",
+      request_backlog: "Number of requests waiting to be processed by a unicorn worker.",
     }.freeze
 
     def initialize
@@ -17,7 +17,7 @@ module PrometheusExporter::Server
     end
 
     def type
-      'unicorn'
+      "unicorn"
     end
 
     def metrics

data/lib/prometheus_exporter/server/web_collector.rb

@@ -9,6 +9,7 @@ module PrometheusExporter::Server
       @http_request_redis_duration_seconds = nil
       @http_request_sql_duration_seconds = nil
       @http_request_queue_duration_seconds = nil
+      @http_request_memcache_duration_seconds = nil
     end
 
     def type
@@ -28,36 +29,49 @@ module PrometheusExporter::Server
 
     def ensure_metrics
       unless @http_requests_total
-        @metrics["http_requests_total"] = @http_requests_total = PrometheusExporter::Metric::Counter.new(
-          "http_requests_total",
-          "Total HTTP requests from web app."
-        )
+        @metrics["http_requests_total"] = @http_requests_total =
+          PrometheusExporter::Metric::Counter.new(
+            "http_requests_total",
+            "Total HTTP requests from web app.",
+          )
 
-        @metrics["http_request_duration_seconds"] = @http_request_duration_seconds = PrometheusExporter::Metric::Base.default_aggregation.new(
-          "http_request_duration_seconds",
-          "Time spent in HTTP reqs in seconds."
-        )
+        @metrics["http_request_duration_seconds"] = @http_request_duration_seconds =
+          PrometheusExporter::Metric::Base.default_aggregation.new(
+            "http_request_duration_seconds",
+            "Time spent in HTTP reqs in seconds.",
+          )
 
-        @metrics["http_request_redis_duration_seconds"] = @http_request_redis_duration_seconds = PrometheusExporter::Metric::Base.default_aggregation.new(
-          "http_request_redis_duration_seconds",
-          "Time spent in HTTP reqs in Redis, in seconds."
-        )
+        @metrics["http_request_redis_duration_seconds"] = @http_request_redis_duration_seconds =
+          PrometheusExporter::Metric::Base.default_aggregation.new(
+            "http_request_redis_duration_seconds",
+            "Time spent in HTTP reqs in Redis, in seconds.",
+          )
 
-        @metrics["http_request_sql_duration_seconds"] = @http_request_sql_duration_seconds = PrometheusExporter::Metric::Base.default_aggregation.new(
-          "http_request_sql_duration_seconds",
-          "Time spent in HTTP reqs in SQL in seconds."
-        )
+        @metrics["http_request_sql_duration_seconds"] = @http_request_sql_duration_seconds =
+          PrometheusExporter::Metric::Base.default_aggregation.new(
+            "http_request_sql_duration_seconds",
+            "Time spent in HTTP reqs in SQL in seconds.",
+          )
 
-        @metrics["http_request_queue_duration_seconds"] = @http_request_queue_duration_seconds = PrometheusExporter::Metric::Base.default_aggregation.new(
-          "http_request_queue_duration_seconds",
-          "Time spent queueing the request in load balancer in seconds."
-        )
+        @metrics[
+          "http_request_memcache_duration_seconds"
+        ] = @http_request_memcache_duration_seconds =
+          PrometheusExporter::Metric::Base.default_aggregation.new(
+            "http_request_memcache_duration_seconds",
+            "Time spent in HTTP reqs in Memcache in seconds.",
+          )
+
+        @metrics["http_request_queue_duration_seconds"] = @http_request_queue_duration_seconds =
+          PrometheusExporter::Metric::Base.default_aggregation.new(
+            "http_request_queue_duration_seconds",
+            "Time spent queueing the request in load balancer in seconds.",
+          )
       end
     end
 
     def observe(obj)
-      default_labels = obj['default_labels']
-      custom_labels = obj['custom_labels']
+      default_labels = obj["default_labels"]
+      custom_labels = obj["custom_labels"]
       labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
 
       @http_requests_total.observe(1, labels.merge("status" => obj["status"]))
@@ -70,6 +84,9 @@ module PrometheusExporter::Server
         if sql = timings["sql"]
           @http_request_sql_duration_seconds.observe(sql["duration"], labels)
         end
+        if memcache = timings["memcache"]
+          @http_request_memcache_duration_seconds.observe(memcache["duration"], labels)
+        end
       end
       if queue_time = obj["queue_time"]
         @http_request_queue_duration_seconds.observe(queue_time, labels)

data/lib/prometheus_exporter/server/web_server.rb

@@ -21,19 +21,19 @@ module PrometheusExporter::Server
       @metrics_total =
         PrometheusExporter::Metric::Counter.new(
           "collector_metrics_total",
-          "Total metrics processed by exporter web."
+          "Total metrics processed by exporter web.",
         )
 
       @sessions_total =
         PrometheusExporter::Metric::Counter.new(
           "collector_sessions_total",
-          "Total send_metric sessions processed by exporter web."
+          "Total send_metric sessions processed by exporter web.",
         )
 
       @bad_metrics_total =
         PrometheusExporter::Metric::Counter.new(
           "collector_bad_metrics_total",
-          "Total mis-handled metrics by collector."
+          "Total mis-handled metrics by collector.",
         )
 
       @metrics_total.observe(0)
@@ -46,7 +46,7 @@ module PrometheusExporter::Server
       if @verbose
         @access_log = [
           [$stderr, WEBrick::AccessLog::COMMON_LOG_FORMAT],
-          [$stderr, WEBrick::AccessLog::REFERER_LOG_FORMAT]
+          [$stderr, WEBrick::AccessLog::REFERER_LOG_FORMAT],
         ]
         @logger = WEBrick::Log.new(log_target || $stderr)
       else
@@ -54,9 +54,7 @@ module PrometheusExporter::Server
         @logger = WEBrick::Log.new(log_target || "/dev/null")
       end
 
-      if @verbose && @auth
-        @logger.info "Using Basic Authentication via #{@auth}"
-      end
+      @logger.info "Using Basic Authentication via #{@auth}" if @verbose && @auth
 
       if %w[ALL ANY].include?(@bind)
         @logger.info "Listening on both 0.0.0.0/:: network interfaces"
@@ -68,7 +66,7 @@ module PrometheusExporter::Server
           Port: @port,
           BindAddress: @bind,
           Logger: @logger,
-          AccessLog: @access_log
+          AccessLog: @access_log,
         )
 
       @server.mount_proc "/" do |req, res|
@@ -140,9 +138,7 @@ module PrometheusExporter::Server
     def metrics
       metric_text = nil
       begin
-        Timeout.timeout(@timeout) do
-          metric_text = @collector.prometheus_metrics_text
-        end
+        Timeout.timeout(@timeout) { metric_text = @collector.prometheus_metrics_text }
       rescue Timeout::Error
         # we timed out ... bummer
         @logger.error "Generating Prometheus metrics text timed out"
@@ -153,14 +149,10 @@ module PrometheusExporter::Server
       metrics << add_gauge(
         "collector_working",
         "Is the master process collector able to collect metrics",
-        metric_text && metric_text.length > 0 ? 1 : 0
+        metric_text && metric_text.length > 0 ? 1 : 0,
       )
 
-      metrics << add_gauge(
-        "collector_rss",
-        "total memory used by collector process",
-        get_rss
-      )
+      metrics << add_gauge("collector_rss", "total memory used by collector process", get_rss)
 
       metrics << @metrics_total
       metrics << @sessions_total
@@ -196,9 +188,7 @@ module PrometheusExporter::Server
     def authenticate(req, res)
       htpasswd = WEBrick::HTTPAuth::Htpasswd.new(@auth)
       basic_auth =
-        WEBrick::HTTPAuth::BasicAuth.new(
-          { Realm: @realm, UserDB: htpasswd, Logger: @logger }
-        )
+        WEBrick::HTTPAuth::BasicAuth.new({ Realm: @realm, UserDB: htpasswd, Logger: @logger })
 
       basic_auth.authenticate(req, res)
     end

data/lib/prometheus_exporter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrometheusExporter
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/prometheus_exporter.gemspec

@@ -5,42 +5,40 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "prometheus_exporter/version"
 
 Gem::Specification.new do |spec|
-  spec.name                 = "prometheus_exporter"
-  spec.version              = PrometheusExporter::VERSION
-  spec.authors              = ["Sam Saffron"]
-  spec.email                = ["sam.saffron@gmail.com"]
+  spec.name = "prometheus_exporter"
+  spec.version = PrometheusExporter::VERSION
+  spec.authors = ["Sam Saffron"]
+  spec.email = ["sam.saffron@gmail.com"]
 
-  spec.summary              = %q{Prometheus Exporter}
-  spec.description          = %q{Prometheus metric collector and exporter for Ruby}
-  spec.homepage             = "https://github.com/discourse/prometheus_exporter"
-  spec.license              = "MIT"
+  spec.summary = "Prometheus Exporter"
+  spec.description = "Prometheus metric collector and exporter for Ruby"
+  spec.homepage = "https://github.com/discourse/prometheus_exporter"
+  spec.license = "MIT"
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|bin)/})
-  end
-  spec.bindir               = "bin"
-  spec.executables          = ["prometheus_exporter"]
-  spec.require_paths        = ["lib"]
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
+  spec.bindir = "bin"
+  spec.executables = ["prometheus_exporter"]
+  spec.require_paths = ["lib"]
 
   spec.add_dependency "webrick"
 
   spec.add_development_dependency "rubocop", ">= 0.69"
   spec.add_development_dependency "bundler", ">= 2.1.4"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "minitest", "~> 5.15.0" # https://github.com/qrush/m/issues/93
+  spec.add_development_dependency "minitest", "~> 5.23.0"
   spec.add_development_dependency "guard", "~> 2.0"
-  spec.add_development_dependency "mini_racer", "~> 0.5.0"
+  spec.add_development_dependency "mini_racer", "~> 0.12.0"
   spec.add_development_dependency "guard-minitest", "~> 2.0"
   spec.add_development_dependency "oj", "~> 3.0"
-  spec.add_development_dependency "rack-test", "~> 0.8.3"
+  spec.add_development_dependency "rack-test", "~> 2.1.0"
   spec.add_development_dependency "minitest-stub-const", "~> 0.6"
-  spec.add_development_dependency "rubocop-discourse", ">2"
+  spec.add_development_dependency "rubocop-discourse", ">= 3"
   spec.add_development_dependency "appraisal", "~> 2.3"
   spec.add_development_dependency "activerecord", "~> 6.0.0"
   spec.add_development_dependency "redis", "> 5"
   spec.add_development_dependency "m"
-  if !RUBY_ENGINE == 'jruby'
-    spec.add_development_dependency "raindrops", "~> 0.19"
-  end
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.add_development_dependency "syntax_tree"
+  spec.add_development_dependency "syntax_tree-disable_ternary"
+  spec.add_development_dependency "raindrops", "~> 0.19" if !RUBY_ENGINE == "jruby"
+  spec.required_ruby_version = ">= 3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webrick
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 5.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 5.23.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: minitest-stub-const
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +168,16 @@ dependencies:
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +234,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree-disable_ternary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Prometheus metric collector and exporter for Ruby
 email:
 - sam.saffron@gmail.com
@@ -244,7 +272,9 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop"
 - ".rubocop.yml"
+- ".streerc"
 - Appraisals
 - CHANGELOG
 - CODE_OF_CONDUCT.md
@@ -261,6 +291,7 @@ files:
 - gemfiles/ar_60.gemfile
 - gemfiles/ar_61.gemfile
 - gemfiles/ar_70.gemfile
+- gemfiles/ar_71.gemfile
 - lib/prometheus_exporter.rb
 - lib/prometheus_exporter/client.rb
 - lib/prometheus_exporter/instrumentation.rb
@@ -321,7 +352,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="