prometheus_exporter 0.7.0 → 2.1.0

data/lib/prometheus_exporter/server/web_collector.rb

@@ -5,10 +5,10 @@ module PrometheusExporter::Server
     def initialize
       @metrics = {}
       @http_requests_total = nil
-      @http_duration_seconds = nil
-      @http_redis_duration_seconds = nil
-      @http_sql_duration_seconds = nil
-      @http_queue_duration_seconds = nil
+      @http_request_duration_seconds = nil
+      @http_request_redis_duration_seconds = nil
+      @http_request_sql_duration_seconds = nil
+      @http_request_queue_duration_seconds = nil
     end
 
     def type
@@ -33,23 +33,23 @@ module PrometheusExporter::Server
           "Total HTTP requests from web app."
         )
 
-        @metrics["http_duration_seconds"] = @http_duration_seconds = PrometheusExporter::Metric::Summary.new(
-          "http_duration_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_redis_duration_seconds"] = @http_redis_duration_seconds = PrometheusExporter::Metric::Summary.new(
-          "http_redis_duration_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_sql_duration_seconds"] = @http_sql_duration_seconds = PrometheusExporter::Metric::Summary.new(
-          "http_sql_duration_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_queue_duration_seconds"] = @http_queue_duration_seconds = PrometheusExporter::Metric::Summary.new(
-          "http_queue_duration_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
@@ -60,19 +60,19 @@ module PrometheusExporter::Server
       custom_labels = obj['custom_labels']
       labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
 
-      @http_requests_total.observe(1, labels)
+      @http_requests_total.observe(1, labels.merge("status" => obj["status"]))
 
       if timings = obj["timings"]
-        @http_duration_seconds.observe(timings["total_duration"], labels)
+        @http_request_duration_seconds.observe(timings["total_duration"], labels)
         if redis = timings["redis"]
-          @http_redis_duration_seconds.observe(redis["duration"], labels)
+          @http_request_redis_duration_seconds.observe(redis["duration"], labels)
         end
         if sql = timings["sql"]
-          @http_sql_duration_seconds.observe(sql["duration"], labels)
+          @http_request_sql_duration_seconds.observe(sql["duration"], labels)
         end
       end
       if queue_time = obj["queue_time"]
-        @http_queue_duration_seconds.observe(queue_time, labels)
+        @http_request_queue_duration_seconds.observe(queue_time, labels)
       end
     end
   end

data/lib/prometheus_exporter/server/web_server.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'webrick'
-require 'timeout'
-require 'zlib'
-require 'stringio'
+require "webrick"
+require "timeout"
+require "zlib"
+require "stringio"
 
 module PrometheusExporter::Server
   class WebServer
@@ -18,41 +18,62 @@ module PrometheusExporter::Server
       @auth = opts[:auth]
       @realm = opts[:realm] || PrometheusExporter::DEFAULT_REALM
 
-      @metrics_total = PrometheusExporter::Metric::Counter.new("collector_metrics_total", "Total metrics processed by exporter web.")
+      @metrics_total =
+        PrometheusExporter::Metric::Counter.new(
+          "collector_metrics_total",
+          "Total metrics processed by exporter web."
+        )
 
-      @sessions_total = PrometheusExporter::Metric::Counter.new("collector_sessions_total", "Total send_metric sessions processed by exporter web.")
+      @sessions_total =
+        PrometheusExporter::Metric::Counter.new(
+          "collector_sessions_total",
+          "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.")
+      @bad_metrics_total =
+        PrometheusExporter::Metric::Counter.new(
+          "collector_bad_metrics_total",
+          "Total mis-handled metrics by collector."
+        )
 
       @metrics_total.observe(0)
       @sessions_total.observe(0)
       @bad_metrics_total.observe(0)
 
       @access_log, @logger = nil
+      log_target = opts[:log_target]
 
       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($stderr)
+        @logger = WEBrick::Log.new(log_target || $stderr)
       else
         @access_log = []
-        @logger = WEBrick::Log.new("/dev/null")
+        @logger = WEBrick::Log.new(log_target || "/dev/null")
       end
 
-      @logger.info "Using Basic Authentication via #{@auth}" if @verbose && @auth
+      if @verbose && @auth
+        @logger.info "Using Basic Authentication via #{@auth}"
+      end
 
-      @server = WEBrick::HTTPServer.new(
-        Port: @port,
-        BindAddress: @bind,
-        Logger: @logger,
-        AccessLog: @access_log,
-      )
+      if %w[ALL ANY].include?(@bind)
+        @logger.info "Listening on both 0.0.0.0/:: network interfaces"
+        @bind = nil
+      end
 
-      @server.mount_proc '/' do |req, res|
-        res['Content-Type'] = 'text/plain; charset=utf-8'
-        if req.path == '/metrics'
+      @server =
+        WEBrick::HTTPServer.new(
+          Port: @port,
+          BindAddress: @bind,
+          Logger: @logger,
+          AccessLog: @access_log
+        )
+
+      @server.mount_proc "/" do |req, res|
+        res["Content-Type"] = "text/plain; charset=utf-8"
+        if req.path == "/metrics"
           authenticate(req, res) if @auth
 
           res.status = 200
@@ -70,11 +91,14 @@ module PrometheusExporter::Server
           else
             res.body = metrics
           end
-        elsif req.path == '/send-metrics'
+        elsif req.path == "/send-metrics"
           handle_metrics(req, res)
+        elsif req.path == "/ping"
+          res.body = "PONG"
         else
           res.status = 404
-          res.body = "Not Found! The Prometheus Ruby Exporter only listens on /metrics and /send-metrics"
+          res.body =
+            "Not Found! The Prometheus Ruby Exporter only listens on /ping, /metrics and /send-metrics"
         end
       end
     end
@@ -86,16 +110,11 @@ module PrometheusExporter::Server
           @metrics_total.observe
           @collector.process(block)
         rescue => e
-          if @verbose
-            STDERR.puts
-            STDERR.puts e.inspect
-            STDERR.puts e.backtrace
-            STDERR.puts
-          end
+          @logger.error "\n\n#{e.inspect}\n#{e.backtrace}\n\n" if @verbose
           @bad_metrics_total.observe
           res.body = "Bad Metrics #{e}"
           res.status = e.respond_to?(:status_code) ? e.status_code : 500
-          return
+          break
         end
       end
 
@@ -104,13 +123,14 @@ module PrometheusExporter::Server
     end
 
     def start
-      @runner ||= Thread.start do
-        begin
-          @server.start
-        rescue => e
-          STDERR.puts "Failed to start prometheus collector web on port #{@port}: #{e}"
+      @runner ||=
+        Thread.start do
+          begin
+            @server.start
+          rescue => e
+            @logger.error "Failed to start prometheus collector web on port #{@port}: #{e}"
+          end
         end
-      end
     end
 
     def stop
@@ -120,12 +140,12 @@ module PrometheusExporter::Server
     def metrics
       metric_text = nil
       begin
-        Timeout::timeout(@timeout) do
+        Timeout.timeout(@timeout) do
           metric_text = @collector.prometheus_metrics_text
         end
       rescue Timeout::Error
         # we timed out ... bummer
-        STDERR.puts "Generating Prometheus metrics text timed out"
+        @logger.error "Generating Prometheus metrics text timed out"
       end
 
       metrics = []
@@ -153,9 +173,18 @@ module PrometheusExporter::Server
     end
 
     def get_rss
-      @pagesize ||= `getconf PAGESIZE`.to_i rescue 4096
+      @pagesize ||=
+        begin
+          `getconf PAGESIZE`.to_i
+        rescue StandardError
+          4096
+        end
       @pid ||= Process.pid
-      File.read("/proc/#{@pid}/statm").split(' ')[1].to_i * @pagesize rescue 0
+      begin
+        File.read("/proc/#{@pid}/statm").split(" ")[1].to_i * @pagesize
+      rescue StandardError
+        0
+      end
     end
 
     def add_gauge(name, help, value)
@@ -166,10 +195,12 @@ 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 })
+      basic_auth =
+        WEBrick::HTTPAuth::BasicAuth.new(
+          { Realm: @realm, UserDB: htpasswd, Logger: @logger }
+        )
 
       basic_auth.authenticate(req, res)
     end
-
   end
 end

data/lib/prometheus_exporter/server.rb

@@ -6,6 +6,8 @@ require_relative "server/web_collector"
 require_relative "server/process_collector"
 require_relative "server/sidekiq_collector"
 require_relative "server/sidekiq_queue_collector"
+require_relative "server/sidekiq_process_collector"
+require_relative "server/sidekiq_stats_collector"
 require_relative "server/delayed_job_collector"
 require_relative "server/collector_base"
 require_relative "server/collector"
@@ -16,3 +18,5 @@ require_relative "server/hutch_collector"
 require_relative "server/unicorn_collector"
 require_relative "server/active_record_collector"
 require_relative "server/shoryuken_collector"
+require_relative "server/resque_collector"
+require_relative "server/good_job_collector"

data/lib/prometheus_exporter/version.rb

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

data/lib/prometheus_exporter.rb

@@ -2,21 +2,21 @@
 
 require_relative "prometheus_exporter/version"
 require "json"
-require "thread"
 
 module PrometheusExporter
   # per: https://github.com/prometheus/prometheus/wiki/Default-port-allocations
   DEFAULT_PORT = 9394
-  DEFAULT_BIND_ADDRESS = 'localhost'
-  DEFAULT_PREFIX = 'ruby_'
+  DEFAULT_BIND_ADDRESS = "localhost"
+  DEFAULT_PREFIX = "ruby_"
   DEFAULT_LABEL = {}
   DEFAULT_TIMEOUT = 2
-  DEFAULT_REALM = 'Prometheus Exporter'
+  DEFAULT_REALM = "Prometheus Exporter"
 
   class OjCompat
     def self.parse(obj)
       Oj.compat_load(obj)
     end
+
     def self.dump(obj)
       Oj.dump(obj, mode: :compat)
     end
@@ -25,7 +25,7 @@ module PrometheusExporter
   def self.hostname
     @hostname ||=
       begin
-        require 'socket'
+        require "socket"
         Socket.gethostname
       rescue => e
         STDERR.puts "Unable to lookup hostname #{e}"
@@ -45,13 +45,12 @@ module PrometheusExporter
   def self.has_oj?
     (
       @@has_oj ||=
-       begin
-         require 'oj'
-         :true
-       rescue LoadError
-         :false
-       end
-    ) == :true
+        begin
+          require "oj"
+          :T
+        rescue LoadError
+          :F
+        end
+    ) == :T
   end
-
 end

data/prometheus_exporter.gemspec

@@ -15,8 +15,6 @@ Gem::Specification.new do |spec|
   spec.homepage             = "https://github.com/discourse/prometheus_exporter"
   spec.license              = "MIT"
 
-  spec.post_install_message = "prometheus_exporter will only bind to localhost by default as of v0.5"
-
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features|bin)/})
   end
@@ -27,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "webrick"
 
   spec.add_development_dependency "rubocop", ">= 0.69"
-  spec.add_development_dependency "bundler", ">= 2.2.2"
+  spec.add_development_dependency "bundler", ">= 2.1.4"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest", "~> 5.15.0" # https://github.com/qrush/m/issues/93
   spec.add_development_dependency "guard", "~> 2.0"
-  spec.add_development_dependency "mini_racer", "~> 0.3.1"
+  spec.add_development_dependency "mini_racer", "~> 0.5.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"
@@ -39,8 +37,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-discourse", ">2"
   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.5.0'
+  spec.required_ruby_version = '>= 2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sam Saffron
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webrick
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +206,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: m
+  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
@@ -220,6 +248,7 @@ files:
 - Appraisals
 - CHANGELOG
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -231,18 +260,24 @@ files:
 - gemfiles/.bundle/config
 - gemfiles/ar_60.gemfile
 - gemfiles/ar_61.gemfile
+- gemfiles/ar_70.gemfile
 - lib/prometheus_exporter.rb
 - lib/prometheus_exporter/client.rb
 - lib/prometheus_exporter/instrumentation.rb
 - lib/prometheus_exporter/instrumentation/active_record.rb
 - lib/prometheus_exporter/instrumentation/delayed_job.rb
+- lib/prometheus_exporter/instrumentation/good_job.rb
 - lib/prometheus_exporter/instrumentation/hutch.rb
 - lib/prometheus_exporter/instrumentation/method_profiler.rb
+- lib/prometheus_exporter/instrumentation/periodic_stats.rb
 - lib/prometheus_exporter/instrumentation/process.rb
 - lib/prometheus_exporter/instrumentation/puma.rb
+- lib/prometheus_exporter/instrumentation/resque.rb
 - lib/prometheus_exporter/instrumentation/shoryuken.rb
 - lib/prometheus_exporter/instrumentation/sidekiq.rb
+- lib/prometheus_exporter/instrumentation/sidekiq_process.rb
 - lib/prometheus_exporter/instrumentation/sidekiq_queue.rb
+- lib/prometheus_exporter/instrumentation/sidekiq_stats.rb
 - lib/prometheus_exporter/instrumentation/unicorn.rb
 - lib/prometheus_exporter/metric.rb
 - lib/prometheus_exporter/metric/base.rb
@@ -256,13 +291,18 @@ files:
 - lib/prometheus_exporter/server/collector.rb
 - lib/prometheus_exporter/server/collector_base.rb
 - lib/prometheus_exporter/server/delayed_job_collector.rb
+- lib/prometheus_exporter/server/good_job_collector.rb
 - lib/prometheus_exporter/server/hutch_collector.rb
+- lib/prometheus_exporter/server/metrics_container.rb
 - lib/prometheus_exporter/server/process_collector.rb
 - lib/prometheus_exporter/server/puma_collector.rb
+- lib/prometheus_exporter/server/resque_collector.rb
 - lib/prometheus_exporter/server/runner.rb
 - lib/prometheus_exporter/server/shoryuken_collector.rb
 - lib/prometheus_exporter/server/sidekiq_collector.rb
+- lib/prometheus_exporter/server/sidekiq_process_collector.rb
 - lib/prometheus_exporter/server/sidekiq_queue_collector.rb
+- lib/prometheus_exporter/server/sidekiq_stats_collector.rb
 - lib/prometheus_exporter/server/type_collector.rb
 - lib/prometheus_exporter/server/unicorn_collector.rb
 - lib/prometheus_exporter/server/web_collector.rb
@@ -273,8 +313,7 @@ homepage: https://github.com/discourse/prometheus_exporter
 licenses:
 - MIT
 metadata: {}
-post_install_message: prometheus_exporter will only bind to localhost by default as
-  of v0.5
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -282,15 +321,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Prometheus Exporter
 test_files: []