prometheus_exporter 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7725cb2b5d8846c874cd69d2ce92ca7a7fd2859ce9e6babe8cc86e96db9e3f2b
-  data.tar.gz: c08f9d1a4b18733c9a1c8882453bc40ffb7347ac5a71ccc972500334245aecba
+  metadata.gz: e41c3872a56ccec50aa5442ede71eb37509761e1a53c065ff3b877f8ef3732a0
+  data.tar.gz: 921f95d6a0e28bc17b212fda81984d28327d31e364d9a8efc34718a32d2c4053
 SHA512:
-  metadata.gz: 436ad9dcd8248147fb13ba1f0fc3d2e0b1badc113c41bc7ead07c560f984f32b7caa72fd4cfa1162209b525319574cfb962dff9dd092c2557fca39df2fbe1a8c
-  data.tar.gz: 9365bea75c02bc742514058cd7d66c077a8b0d49ce941a5067887cacd6a051ca28f86870c4456579f16101e98ea4d70733c08e8f9924ff8dead52be4b2c01d91
+  metadata.gz: e208fd0be610e8a268c0a1dcf7559b07dbdf8745bff9cedf6fb04967d132d36d324b8d76c85cad19f74ec4e623eeb356f90c624f4918d7e264839d55eebb8815
+  data.tar.gz: e1d6287fa0ca432e59ad48be400e375f75448f539a56117f8fde8c9a32314af5ee37fdaf989229c8d1000115d802012082fc641d098426354b9eccef46622237

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.4.0 - 23-10-2018
+
+- Feature: histogram support
+- Feature: custom quantile support for summary
+- Feature: Puma metrics
+- Fix: delayed job metrics
+
 0.3.4 - 02-10-2018
 
 - Fix: custom collector via CLI was not working correctly

data/README.md

@@ -8,11 +8,13 @@ To learn more see [Instrumenting Rails with Prometheus](https://samsaffron.com/a
 * [Installation](#installation)
 * [Usage](#usage)
   * [Single process mode](#single-process-mode)
+    * [Custom quantiles and buckets](#custom-quantiles-and-buckets)
   * [Multi process mode](#multi-process-mode)
   * [Rails integration](#rails-integration)
     * [Per-process stats](#per-process-stats)
     * [Sidekiq metrics](#sidekiq-metrics)
     * [Delayed Job plugin](#delayed-job-plugin)
+  * [Puma metrics](#puma-metrics)
   * [Custom type collectors](#custom-type-collectors)
   * [Multi process mode with custom collector](#multi-process-mode-with-custom-collector)
   * [GraphQL support](#graphql-support)
@@ -60,10 +62,12 @@ server.start
 gauge = PrometheusExporter::Metric::Gauge.new("rss", "used RSS for process")
 counter = PrometheusExporter::Metric::Counter.new("web_requests", "number of web requests")
 summary = PrometheusExporter::Metric::Summary.new("page_load_time", "time it took to load page")
+histogram = PrometheusExporter::Metric::Histogram.new("api_access_time", "time it took to call api")
 
 server.collector.register_metric(gauge)
 server.collector.register_metric(counter)
 server.collector.register_metric(summary)
+server.collector.register_metric(histogram)
 
 gauge.observe(get_rss)
 gauge.observe(get_rss)
@@ -75,10 +79,23 @@ summary.observe(1.1)
 summary.observe(1.12)
 summary.observe(0.12)
 
+histogram.observe(0.2, api: 'twitter')
+
 # http://localhost:12345/metrics now returns all your metrics
 
 ```
 
+#### Custom quantiles and buckets
+
+You can also choose custom quantiles for summaries and custom buckets for histograms.
+
+```ruby
+
+summary = PrometheusExporter::Metric::Summary.new("load_time", "time to load page", quantiles: [0.99, 0.75, 0.5, 0.25])
+histogram = PrometheusExporter::Metric::Histogram.new("api_time", "time to call api", buckets: [0.1, 0.5, 1])
+
+```
+
 ### Multi process mode
 
 In some cases (for example, unicorn or puma clusters) you may want to aggregate metrics across multiple processes.
@@ -211,6 +228,20 @@ Configure your HTTP server / load balancer to add a header `X-Request-Start: t=<
 
 Hint: we aim to be API-compatible with the big APM solutions, so if you've got requests queueing time configured for them, it should be expected to also work with `prometheus_exporter`.
 
+### Puma metrics
+
+The puma metrics are using the `Puma.stats` method and hence need to be started after the
+workers has been booted and from a Puma thread otherwise the metrics won't be accessible.
+The easiest way to gather this metrics is to put the following in your `puma.rb` config:
+
+```ruby
+# puma.rb config
+after_worker_boot do
+  require 'prometheus_exporter/instrumentation'
+  PrometheusExporter::Instrumentation::Puma.start
+end
+```
+
 ### Custom type collectors
 
 In some cases you may have custom metrics you want to ship the collector in a batch. In this case you may still be interested in the base collector behavior, but would like to add your own special messages.

data/lib/prometheus_exporter/instrumentation/puma.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+# collects stats from puma
+module PrometheusExporter::Instrumentation
+  class Puma
+    def self.start(client: nil, frequency: 30)
+      puma_collector = new
+      client ||= PrometheusExporter::Client.default
+      Thread.new do
+        while true
+          begin
+            metric = puma_collector.collect
+            client.send_json metric
+          rescue => e
+            STDERR.puts("Prometheus Exporter Failed To Collect Puma Stats #{e}")
+          ensure
+            sleep frequency
+          end
+        end
+      end
+    end
+
+    def collect
+      metric = {}
+      metric[:type] = "puma"
+      collect_puma_stats(metric)
+      metric
+    end
+
+    def collect_puma_stats(metric)
+      stats = JSON.parse(::Puma.stats)
+
+      if stats.key? 'workers'
+        metric[:phase] = stats["phase"]
+        metric[:workers_total] = stats["workers"]
+        metric[:booted_workers_total] = stats["booted_workers"]
+        metric[:old_workers_total] = stats["old_workers"]
+
+        stats["worker_status"].each do |worker|
+          next if worker["last_status"].empty?
+          collect_worker_status(metric, worker["last_status"])
+        end
+      else
+        collect_worker_status(metric, stats)
+      end
+    end
+
+    private
+
+    def collect_worker_status(metric, status)
+      metric[:request_backlog_total] ||= 0
+      metric[:running_threads_total] ||= 0
+      metric[:thread_pool_capacity_total] ||= 0
+      metric[:max_threads_total] ||= 0
+
+      metric[:request_backlog_total] += status["backlog"]
+      metric[:running_threads_total] += status["running"]
+      metric[:thread_pool_capacity_total] += status["pool_capacity"]
+      metric[:max_threads_total] += status["max_threads"]
+    end
+  end
+end

data/lib/prometheus_exporter/instrumentation/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PrometheusExporter::Instrumentation
   class Sidekiq
 
@@ -13,10 +15,15 @@ module PrometheusExporter::Instrumentation
       result
     ensure
       duration = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start
+      class_name = if worker.class.to_s == 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'
+                     msg['wrapped']
+                   else
+                     worker.class.to_s
+                   end
 
       @client.send_json(
         type: "sidekiq",
-        name: worker.class.to_s,
+        name: class_name,
         success: success,
         duration: duration
       )

data/lib/prometheus_exporter/instrumentation.rb

@@ -3,3 +3,4 @@ require_relative "instrumentation/method_profiler"
 require_relative "instrumentation/sidekiq"
 require_relative "instrumentation/delayed_job"
 require_relative "instrumentation/global"
+require_relative "instrumentation/puma"

data/lib/prometheus_exporter/metric/histogram.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+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
+
+    def initialize(name, help, opts = {})
+      super(name, help)
+      @buckets = (opts[:buckets] || DEFAULT_BUCKETS).sort.reverse
+      @sums = {}
+      @counts = {}
+      @observations = {}
+    end
+
+    def type
+      "histogram"
+    end
+
+    def metric_text
+      text = +""
+      first = true
+      @observations.each do |labels, buckets|
+        text << "\n" unless first
+        first = false
+        count = @counts[labels]
+        sum = @sums[labels]
+        text << "#{prefix(@name)}_bucket#{labels_text(with_bucket(labels, "+Inf"))} #{count}\n"
+        @buckets.each do |bucket|
+          value = @observations[labels][bucket]
+          text << "#{prefix(@name)}_bucket#{labels_text(with_bucket(labels, bucket.to_s))} #{value}\n"
+        end
+        text << "#{prefix(@name)}_count#{labels_text(labels)} #{count}\n"
+        text << "#{prefix(@name)}_sum#{labels_text(labels)} #{sum}"
+      end
+      text
+    end
+
+    def observe(value, labels = nil)
+      labels ||= {}
+      buckets = ensure_histogram(labels)
+
+      value = value.to_f
+      @sums[labels] += value
+      @counts[labels] += 1
+
+      fill_buckets(value, buckets)
+    end
+
+    def ensure_histogram(labels)
+      @sums[labels] ||= 0.0
+      @counts[labels] ||= 0
+      buckets = @observations[labels]
+      if buckets.nil?
+        buckets = @buckets.map{|b| [b, 0]}.to_h
+        @observations[labels] = buckets
+      end
+      buckets
+    end
+
+    def fill_buckets(value, buckets)
+      @buckets.each do |b|
+        break if value > b
+        buckets[b] += 1
+      end
+    end
+
+    def with_bucket(labels, bucket)
+      labels.merge({"le" => bucket})
+    end
+
+  end
+end

data/lib/prometheus_exporter/metric/summary.rb

@@ -3,18 +3,19 @@
 module PrometheusExporter::Metric
   class Summary < Base
 
-    QUANTILES = [0.99, 0.9, 0.5, 0.1, 0.01]
+    DEFAULT_QUANTILES = [0.99, 0.9, 0.5, 0.1, 0.01]
     ROTATE_AGE = 120
 
     attr_reader :estimators, :count, :total
 
-    def initialize(name, help)
-      super
+    def initialize(name, help, opts = {})
+      super(name, help)
       @buffers = [{}, {}]
       @last_rotated = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       @current_buffer = 0
       @counts = {}
       @sums = {}
+      @quantiles = opts[:quantiles] || DEFAULT_QUANTILES
     end
 
     def type
@@ -27,7 +28,7 @@ module PrometheusExporter::Metric
       result = {}
 
       if length > 0
-        QUANTILES.each do |quantile|
+        @quantiles.each do |quantile|
           result[quantile] = sorted[(length * quantile).ceil - 1]
         end
       end
@@ -48,7 +49,7 @@ module PrometheusExporter::Metric
     end
 
     def metric_text
-      text = String.new
+      text = +""
       first = true
       calculate_all_quantiles.each do |labels, quantiles|
         text << "\n" unless first

data/lib/prometheus_exporter/metric.rb

@@ -1,4 +1,5 @@
 require_relative "metric/base"
 require_relative "metric/counter"
 require_relative "metric/gauge"
+require_relative "metric/histogram"
 require_relative "metric/summary"

data/lib/prometheus_exporter/server/collector.rb

@@ -30,6 +30,7 @@ module PrometheusExporter::Server
       register_collector(ProcessCollector.new)
       register_collector(SidekiqCollector.new)
       register_collector(DelayedJobCollector.new)
+      register_collector(PumaCollector.new)
     end
 
     def register_collector(collector)
@@ -85,6 +86,8 @@ module PrometheusExporter::Server
           PrometheusExporter::Metric::Counter.new(name, help)
         when "summary"
           PrometheusExporter::Metric::Summary.new(name, help)
+        when "histogram"
+          PrometheusExporter::Metric::Histogram.new(name, help)
         end
 
       if metric

data/lib/prometheus_exporter/server/puma_collector.rb

@@ -0,0 +1,48 @@
+module PrometheusExporter::Server
+  class PumaCollector < TypeCollector
+    PUMA_GAUGES = {
+      workers_total: "Number of puma workers.",
+      booted_workers_total: "Number of puma workers booted.",
+      old_workers_total: "Number of old puma workers.",
+      running_threads_total: "Number of puma threads currently running.",
+      request_backlog_total: "Number of requests waiting to be processed by a puma thread.",
+      thread_pool_capacity_total: "Number of puma threads available at current scale.",
+      max_threads_total: "Number of puma threads at available at max scale.",
+    }
+
+    def initialize
+      @puma_metrics = []
+    end
+
+    def type
+      "puma"
+    end
+
+    def metrics
+      return [] if @puma_metrics.length == 0
+
+      metrics = {}
+
+      @puma_metrics.map do |m|
+        labels = {}
+        if m["phase"]
+          labels.merge(phase: m["phase"])
+        end
+
+        PUMA_GAUGES.map do |k, help|
+          k = k.to_s
+          if v = m[k]
+            g = metrics[k] ||= PrometheusExporter::Metric::Gauge.new("puma_#{k}", help)
+            g.observe(v, labels)
+          end
+        end
+      end
+
+      metrics.values
+    end
+
+    def collect(obj)
+      @puma_metrics << obj
+    end
+  end
+end

data/lib/prometheus_exporter/server.rb

@@ -8,3 +8,4 @@ require_relative "server/collector_base"
 require_relative "server/collector"
 require_relative "server/web_server"
 require_relative "server/runner"
+require_relative "server/puma_collector"

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/prometheus_exporter.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
   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 "minitest-stub-const", "~> 0.6"
   spec.required_ruby_version = '>= 2.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Prometheus metric collector and exporter for Ruby
 email:
 - sam.saffron@gmail.com
@@ -151,11 +165,13 @@ files:
 - lib/prometheus_exporter/instrumentation/global.rb
 - lib/prometheus_exporter/instrumentation/method_profiler.rb
 - lib/prometheus_exporter/instrumentation/process.rb
+- lib/prometheus_exporter/instrumentation/puma.rb
 - lib/prometheus_exporter/instrumentation/sidekiq.rb
 - lib/prometheus_exporter/metric.rb
 - lib/prometheus_exporter/metric/base.rb
 - lib/prometheus_exporter/metric/counter.rb
 - lib/prometheus_exporter/metric/gauge.rb
+- lib/prometheus_exporter/metric/histogram.rb
 - lib/prometheus_exporter/metric/summary.rb
 - lib/prometheus_exporter/middleware.rb
 - lib/prometheus_exporter/server.rb
@@ -163,6 +179,7 @@ files:
 - lib/prometheus_exporter/server/collector_base.rb
 - lib/prometheus_exporter/server/delayed_job_collector.rb
 - lib/prometheus_exporter/server/process_collector.rb
+- lib/prometheus_exporter/server/puma_collector.rb
 - lib/prometheus_exporter/server/runner.rb
 - lib/prometheus_exporter/server/sidekiq_collector.rb
 - lib/prometheus_exporter/server/type_collector.rb