prometheus_exporter 2.1.1 → 2.2.0

data/lib/prometheus_exporter/instrumentation/sidekiq_process.rb

@@ -6,9 +6,7 @@ module PrometheusExporter::Instrumentation
       client ||= PrometheusExporter::Client.default
       sidekiq_process_collector = new
 
-      worker_loop do
-        client.send_json(sidekiq_process_collector.collect)
-      end
+      worker_loop { client.send_json(sidekiq_process_collector.collect) }
 
       super
     end
@@ -19,10 +17,7 @@ module PrometheusExporter::Instrumentation
     end
 
     def collect
-      {
-        type: 'sidekiq_process',
-        process: collect_stats
-      }
+      { type: "sidekiq_process", process: collect_stats }
     end
 
     def collect_stats
@@ -30,23 +25,21 @@ module PrometheusExporter::Instrumentation
       return {} unless process
 
       {
-        busy: process['busy'],
-        concurrency: process['concurrency'],
+        busy: process["busy"],
+        concurrency: process["concurrency"],
         labels: {
-          labels: process['labels'].sort.join(','),
-          queues: process['queues'].sort.join(','),
-          quiet: process['quiet'],
-          tag: process['tag'],
-          hostname: process['hostname'],
-          identity: process['identity'],
-        }
+          labels: process["labels"].sort.join(","),
+          queues: process["queues"].sort.join(","),
+          quiet: process["quiet"],
+          tag: process["tag"],
+          hostname: process["hostname"],
+          identity: process["identity"],
+        },
       }
     end
 
     def current_process
-      ::Sidekiq::ProcessSet.new.find do |sp|
-        sp['hostname'] == @hostname && sp['pid'] == @pid
-      end
+      ::Sidekiq::ProcessSet.new.find { |sp| sp["hostname"] == @hostname && sp["pid"] == @pid }
     end
   end
 end

data/lib/prometheus_exporter/instrumentation/sidekiq_queue.rb

@@ -6,9 +6,7 @@ module PrometheusExporter::Instrumentation
       client ||= PrometheusExporter::Client.default
       sidekiq_queue_collector = new(all_queues: all_queues)
 
-      worker_loop do
-        client.send_json(sidekiq_queue_collector.collect)
-      end
+      worker_loop { client.send_json(sidekiq_queue_collector.collect) }
 
       super
     end
@@ -20,10 +18,7 @@ module PrometheusExporter::Instrumentation
     end
 
     def collect
-      {
-        type: 'sidekiq_queue',
-        queues: collect_queue_stats
-      }
+      { type: "sidekiq_queue", queues: collect_queue_stats }
     end
 
     def collect_queue_stats
@@ -34,13 +29,17 @@ module PrometheusExporter::Instrumentation
         sidekiq_queues.select! { |sidekiq_queue| queues.include?(sidekiq_queue.name) }
       end
 
-      sidekiq_queues.map do |queue|
-        {
-          backlog: queue.size,
-          latency_seconds: queue.latency.to_i,
-          labels: { queue: queue.name }
-        }
-      end.compact
+      sidekiq_queues
+        .map do |queue|
+          {
+            backlog: queue.size,
+            latency_seconds: queue.latency.to_i,
+            labels: {
+              queue: queue.name,
+            },
+          }
+        end
+        .compact
     end
 
     private
@@ -48,11 +47,9 @@ module PrometheusExporter::Instrumentation
     def collect_current_process_queues
       ps = ::Sidekiq::ProcessSet.new
 
-      process = ps.find do |sp|
-        sp['hostname'] == @hostname && sp['pid'] == @pid
-      end
+      process = ps.find { |sp| sp["hostname"] == @hostname && sp["pid"] == @pid }
 
-      process.nil? ? [] : process['queues']
+      process.nil? ? [] : process["queues"]
     end
   end
 end

data/lib/prometheus_exporter/instrumentation/sidekiq_stats.rb

@@ -6,31 +6,26 @@ module PrometheusExporter::Instrumentation
       client ||= PrometheusExporter::Client.default
       sidekiq_stats_collector = new
 
-      worker_loop do
-        client.send_json(sidekiq_stats_collector.collect)
-      end
+      worker_loop { client.send_json(sidekiq_stats_collector.collect) }
 
       super
     end
 
     def collect
-      {
-        type: 'sidekiq_stats',
-        stats: collect_stats
-      }
+      { type: "sidekiq_stats", stats: collect_stats }
     end
 
     def collect_stats
       stats = ::Sidekiq::Stats.new
       {
-        'dead_size' => stats.dead_size,
-        'enqueued' => stats.enqueued,
-        'failed' => stats.failed,
-        'processed' => stats.processed,
-        'processes_size' => stats.processes_size,
-        'retry_size' => stats.retry_size,
-        'scheduled_size' => stats.scheduled_size,
-        'workers_size' => stats.workers_size,
+        "dead_size" => stats.dead_size,
+        "enqueued" => stats.enqueued,
+        "failed" => stats.failed,
+        "processed" => stats.processed,
+        "processes_size" => stats.processes_size,
+        "retry_size" => stats.retry_size,
+        "scheduled_size" => stats.scheduled_size,
+        "workers_size" => stats.workers_size,
       }
     end
   end

data/lib/prometheus_exporter/instrumentation/unicorn.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 begin
-  require 'raindrops'
+  require "raindrops"
 rescue LoadError
   # No raindrops available, dont do anything
 end
@@ -29,7 +29,7 @@ module PrometheusExporter::Instrumentation
 
     def collect
       metric = {}
-      metric[:type] = 'unicorn'
+      metric[:type] = "unicorn"
       collect_unicorn_stats(metric)
       metric
     end

data/lib/prometheus_exporter/metric/base.rb

@@ -2,7 +2,6 @@
 
 module PrometheusExporter::Metric
   class Base
-
     @default_prefix = nil if !defined?(@default_prefix)
     @default_labels = nil if !defined?(@default_labels)
     @default_aggregation = nil if !defined?(@default_aggregation)
@@ -77,11 +76,14 @@ module PrometheusExporter::Metric
     def labels_text(labels)
       labels = Base.default_labels.merge(labels || {})
       if labels && labels.length > 0
-        s = labels.map do |key, value|
-          value = value.to_s
-          value = escape_value(value) if needs_escape?(value)
-          "#{key}=\"#{value}\""
-        end.join(",")
+        s =
+          labels
+            .map do |key, value|
+              value = value.to_s
+              value = escape_value(value) if needs_escape?(value)
+              "#{key}=\"#{value}\""
+            end
+            .join(",")
         "{#{s}}"
       end
     end
@@ -109,6 +111,5 @@ module PrometheusExporter::Metric
     def needs_escape?(str)
       str.match?(/[\n"\\]/m)
     end
-
   end
 end

data/lib/prometheus_exporter/metric/counter.rb

@@ -18,9 +18,7 @@ module PrometheusExporter::Metric
     end
 
     def metric_text
-      @data.map do |labels, value|
-        "#{prefix(@name)}#{labels_text(labels)} #{value}"
-      end.join("\n")
+      @data.map { |labels, value| "#{prefix(@name)}#{labels_text(labels)} #{value}" }.join("\n")
     end
 
     def to_h

data/lib/prometheus_exporter/metric/gauge.rb

@@ -18,9 +18,7 @@ module PrometheusExporter::Metric
     end
 
     def metric_text
-      @data.map do |labels, value|
-        "#{prefix(@name)}#{labels_text(labels)} #{value}"
-      end.join("\n")
+      @data.map { |labels, value| "#{prefix(@name)}#{labels_text(labels)} #{value}" }.join("\n")
     end
 
     def reset!
@@ -39,9 +37,7 @@ module PrometheusExporter::Metric
       if value.nil?
         data.delete(labels)
       else
-        if !(Numeric === value)
-          raise ArgumentError, 'value must be a number'
-        end
+        raise ArgumentError, "value must be a number" if !(Numeric === value)
         @data[labels] = value
       end
     end

data/lib/prometheus_exporter/metric/histogram.rb

@@ -2,7 +2,6 @@
 
 module PrometheusExporter::Metric
   class Histogram < Base
-
     DEFAULT_BUCKETS = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5.0, 10.0].freeze
 
     @default_buckets = nil if !defined?(@default_buckets)
@@ -100,6 +99,5 @@ module PrometheusExporter::Metric
     def with_bucket(labels, bucket)
       labels.merge("le" => bucket)
     end
-
   end
 end

data/lib/prometheus_exporter/metric/summary.rb

@@ -2,7 +2,6 @@
 
 module PrometheusExporter::Metric
   class Summary < Base
-
     DEFAULT_QUANTILES = [0.99, 0.9, 0.5, 0.1, 0.01]
     ROTATE_AGE = 120
 
@@ -49,9 +48,7 @@ module PrometheusExporter::Metric
       result = {}
 
       if length > 0
-        @quantiles.each do |quantile|
-          result[quantile] = sorted[(length * quantile).ceil - 1]
-        end
+        @quantiles.each { |quantile| result[quantile] = sorted[(length * quantile).ceil - 1] }
       end
 
       result
@@ -61,12 +58,9 @@ module PrometheusExporter::Metric
       buffer = @buffers[@current_buffer]
 
       result = {}
-      buffer.each do |labels, raw_data|
-        result[labels] = calculate_quantiles(raw_data)
-      end
+      buffer.each { |labels, raw_data| result[labels] = calculate_quantiles(raw_data) }
 
       result
-
     end
 
     def metric_text
@@ -87,8 +81,8 @@ module PrometheusExporter::Metric
 
     # makes sure we have storage
     def ensure_summary(labels)
-      @buffers[0][labels] ||=  []
-      @buffers[1][labels] ||=  []
+      @buffers[0][labels] ||= []
+      @buffers[1][labels] ||= []
       @sums[labels] ||= 0.0
       @counts[labels] ||= 0
       nil
@@ -97,9 +91,7 @@ module PrometheusExporter::Metric
     def rotate_if_needed
       if (now = Process.clock_gettime(Process::CLOCK_MONOTONIC)) > (@last_rotated + ROTATE_AGE)
         @last_rotated = now
-        @buffers[@current_buffer].each do |labels, raw|
-          raw.clear
-        end
+        @buffers[@current_buffer].each { |labels, raw| raw.clear }
         @current_buffer = @current_buffer == 0 ? 1 : 0
       end
       nil
@@ -116,6 +108,5 @@ module PrometheusExporter::Metric
       @sums[labels] += value
       @counts[labels] += 1
     end
-
   end
 end

data/lib/prometheus_exporter/middleware.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'prometheus_exporter/instrumentation/method_profiler'
-require 'prometheus_exporter/client'
+require "prometheus_exporter/instrumentation/method_profiler"
+require "prometheus_exporter/client"
 
 class PrometheusExporter::Middleware
   MethodProfiler = PrometheusExporter::Instrumentation::MethodProfiler
@@ -11,26 +11,42 @@ class PrometheusExporter::Middleware
     @client = config[:client] || PrometheusExporter::Client.default
 
     if config[:instrument]
-      if defined?(RedisClient)
-        apply_redis_client_middleware!
-      end
-      if defined?(Redis::VERSION) && (Gem::Version.new(Redis::VERSION) >= Gem::Version.new('5.0.0'))
+      apply_redis_client_middleware! if defined?(RedisClient)
+
+      if defined?(Redis::VERSION) && (Gem::Version.new(Redis::VERSION) >= Gem::Version.new("5.0.0"))
         # redis 5 support handled via RedisClient
-      elsif defined? Redis::Client
-        MethodProfiler.patch(Redis::Client, [
-          :call, :call_pipeline
-        ], :redis, instrument: config[:instrument])
+      elsif defined?(Redis::Client)
+        MethodProfiler.patch(
+          Redis::Client,
+          %i[call call_pipeline],
+          :redis,
+          instrument: config[:instrument],
+        )
       end
-      if defined? PG::Connection
-        MethodProfiler.patch(PG::Connection, [
-          :exec, :async_exec, :exec_prepared, :exec_params, :send_query_prepared, :query
-        ], :sql, instrument: config[:instrument])
+
+      if defined?(PG::Connection)
+        MethodProfiler.patch(
+          PG::Connection,
+          %i[exec async_exec exec_prepared exec_params send_query_prepared query],
+          :sql,
+          instrument: config[:instrument],
+        )
       end
-      if defined? Mysql2::Client
+
+      if defined?(Mysql2::Client)
         MethodProfiler.patch(Mysql2::Client, [:query], :sql, instrument: config[:instrument])
         MethodProfiler.patch(Mysql2::Statement, [:execute], :sql, instrument: config[:instrument])
         MethodProfiler.patch(Mysql2::Result, [:each], :sql, instrument: config[:instrument])
       end
+
+      if defined?(Dalli::Client)
+        MethodProfiler.patch(
+          Dalli::Client,
+          %i[delete fetch get add set],
+          :memcache,
+          instrument: config[:instrument],
+        )
+      end
     end
   end
 
@@ -49,12 +65,10 @@ class PrometheusExporter::Middleware
       timings: info,
       queue_time: queue_time,
       status: status,
-      default_labels: default_labels(env, result)
+      default_labels: default_labels(env, result),
     }
     labels = custom_labels(env)
-    if labels
-      obj = obj.merge(custom_labels: labels)
-    end
+    obj = obj.merge(custom_labels: labels) if labels
 
     @client.send_json(obj)
   end
@@ -72,10 +86,7 @@ class PrometheusExporter::Middleware
       controller = "preflight"
     end
 
-    {
-      action: action || "other",
-      controller: controller || "other"
-    }
+    { action: action || "other", controller: controller || "other" }
   end
 
   # allows subclasses to add custom labels based on env
@@ -103,32 +114,29 @@ class PrometheusExporter::Middleware
 
   # determine queue start from well-known trace headers
   def queue_start(env)
-
     # get the content of the x-queue-start or x-request-start header
-    value = env['HTTP_X_REQUEST_START'] || env['HTTP_X_QUEUE_START']
-    unless value.nil? || value == ''
+    value = env["HTTP_X_REQUEST_START"] || env["HTTP_X_QUEUE_START"]
+    unless value.nil? || value == ""
       # nginx returns time as milliseconds with 3 decimal places
       # apache returns time as microseconds without decimal places
       # this method takes care to convert both into a proper second + fractions timestamp
-      value = value.to_s.gsub(/t=|\./, '')
+      value = value.to_s.gsub(/t=|\./, "")
       return "#{value[0, 10]}.#{value[10, 13]}".to_f
     end
 
     # get the content of the x-amzn-trace-id header
     # see also: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-request-tracing.html
-    value = env['HTTP_X_AMZN_TRACE_ID']
-    value&.split('Root=')&.last&.split('-')&.fetch(1)&.to_i(16)
-
+    value = env["HTTP_X_AMZN_TRACE_ID"]
+    value&.split("Root=")&.last&.split("-")&.fetch(1)&.to_i(16)
   end
 
   private
 
   module RedisInstrumenter
-    MethodProfiler.define_methods_on_module(self, ["call", "call_pipelined"], "redis")
+    MethodProfiler.define_methods_on_module(self, %w[call call_pipelined], "redis")
   end
 
   def apply_redis_client_middleware!
     RedisClient.register(RedisInstrumenter)
   end
-
 end

data/lib/prometheus_exporter/server/active_record_collector.rb

@@ -10,15 +10,15 @@ module PrometheusExporter::Server
       dead: "Dead connections in pool",
       idle: "Idle connections in pool",
       waiting: "Connection requests waiting",
-      size: "Maximum allowed connection pool size"
+      size: "Maximum allowed connection pool size",
     }
 
     def initialize
       @active_record_metrics = MetricsContainer.new(ttl: MAX_METRIC_AGE)
-      @active_record_metrics.filter = -> (new_metric, old_metric) do
+      @active_record_metrics.filter = ->(new_metric, old_metric) do
         new_metric["pid"] == old_metric["pid"] &&
-        new_metric["hostname"] == old_metric["hostname"] &&
-        new_metric["metric_labels"]["pool_name"] == old_metric["metric_labels"]["pool_name"]
+          new_metric["hostname"] == old_metric["hostname"] &&
+          new_metric["metric_labels"]["pool_name"] == old_metric["metric_labels"]["pool_name"]
       end
     end
 
@@ -32,13 +32,18 @@ module PrometheusExporter::Server
       metrics = {}
 
       @active_record_metrics.map do |m|
-        metric_key = (m["metric_labels"] || {}).merge("pid" => m["pid"], "hostname" => m["hostname"])
+        metric_key =
+          (m["metric_labels"] || {}).merge("pid" => m["pid"], "hostname" => m["hostname"])
         metric_key.merge!(m["custom_labels"]) if m["custom_labels"]
 
         ACTIVE_RECORD_GAUGES.map do |k, help|
           k = k.to_s
           if v = m[k]
-            g = metrics[k] ||= PrometheusExporter::Metric::Gauge.new("active_record_connection_pool_#{k}", help)
+            g =
+              metrics[k] ||= PrometheusExporter::Metric::Gauge.new(
+                "active_record_connection_pool_#{k}",
+                help,
+              )
             g.observe(v, metric_key)
           end
         end

data/lib/prometheus_exporter/server/collector.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 module PrometheusExporter::Server
-
   class Collector < CollectorBase
-
     def initialize(json_serializer: nil)
       @process_metrics = []
       @metrics = {}
@@ -40,19 +38,15 @@ module PrometheusExporter::Server
           collector.collect(obj)
         else
           metric = @metrics[obj["name"]]
-          if !metric
-            metric = register_metric_unsafe(obj)
-          end
+          metric = register_metric_unsafe(obj) if !metric
 
           keys = obj["keys"] || {}
-          if obj["custom_labels"]
-            keys = obj["custom_labels"].merge(keys)
-          end
+          keys = obj["custom_labels"].merge(keys) if obj["custom_labels"]
 
           case obj["prometheus_exporter_action"]
-          when 'increment'
+          when "increment"
             metric.increment(keys, obj["value"])
-          when 'decrement'
+          when "decrement"
             metric.decrement(keys, obj["value"])
           else
             metric.observe(obj["value"], keys)
@@ -63,15 +57,14 @@ module PrometheusExporter::Server
 
     def prometheus_metrics_text
       @mutex.synchronize do
-        (@metrics.values + @collectors.values.map(&:metrics).flatten)
-          .map(&:to_prometheus_text).join("\n")
+        (@metrics.values + @collectors.values.map(&:metrics).flatten).map(
+          &:to_prometheus_text
+        ).join("\n")
       end
     end
 
     def register_metric(metric)
-      @mutex.synchronize do
-        @metrics[metric.name] = metric
-      end
+      @mutex.synchronize { @metrics[metric.name] = metric }
     end
 
     protected
@@ -101,7 +94,10 @@ module PrometheusExporter::Server
     end
 
     def symbolize_keys(hash)
-      hash.inject({}) { |memo, k| memo[k.first.to_sym] = k.last; memo }
+      hash.inject({}) do |memo, k|
+        memo[k.first.to_sym] = k.last
+        memo
+      end
     end
   end
 end

data/lib/prometheus_exporter/server/collector_base.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 module PrometheusExporter::Server
-
   # minimal interface to implement a customer collector
   class CollectorBase
-
     # called each time a string is delivered from the web
     def process(str)
     end