prometheus_exporter 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88f0f450fbf76e51d739c1f9abc7cea62e2651dd366c5e9bd38df9464ebf797e
-  data.tar.gz: a89f2e00749002ba9323a6741cc682fb9bd2df051dd96cd68c9c9fd6e51d73d6
+  metadata.gz: d78846839afaebda3169dbf21569a55a692884872508f751544d791f75f3c993
+  data.tar.gz: aa70c3578a9fa9b7a15bcc032981d21d49344e0c313c874346ee96e962894c9f
 SHA512:
-  metadata.gz: 32922666245bacfd8d608a4a08c255ef8103f70c7ba31974ed3c2685cc261b05df25d17e2c0bc38c50d67a576388d98ae9150b204a0385d3d516f298b77aa6e4
-  data.tar.gz: 360d70c6f3c03e31158a43f26fccee61ec25717a2b4f021ff46902b447f864533e543083d5dc675bdab0f47df93288f3f7f60157145fbea5a1e1062d6981e4fa
+  metadata.gz: cc029080ef384bd5f9adff56491ee1a1ba9bb601ee81009c4685fca76a22ab2e20440f4bc1e5f67bcba7f0ec9f703ffbb0ac0f9b08c86c91bdee6a47c7bcdeb4
+  data.tar.gz: f5fc713effa23e04599272a4dcfe51091927e3b281ed6e930306d4f200ff591dea70f0c9762b1e372300168cee1dcec82427ed407c4633c8300230fd8d551030

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.4.8 - 10-04-2019
+
+- Feature: added helpers for instrumenting unicorn using raindrops
+
 0.4.7 - 08-04-2019
 
 - Fix: collector was not escaping " \ and \n correctly. This could lead

data/README.md

@@ -16,6 +16,7 @@ To learn more see [Instrumenting Rails with Prometheus](https://samsaffron.com/a
     * [Delayed Job plugin](#delayed-job-plugin)
     * [Hutch metrics](#hutch-message-processing-tracer)
   * [Puma metrics](#puma-metrics)
+  * [Unicorn metrics](#unicorn-metrics)
   * [Custom type collectors](#custom-type-collectors)
   * [Multi process mode with custom collector](#multi-process-mode-with-custom-collector)
   * [GraphQL support](#graphql-support)
@@ -158,6 +159,7 @@ gem 'prometheus_exporter'
 ```
 
 In an initializer:
+
 ```ruby
 unless Rails.env == "test"
   require 'prometheus_exporter/middleware'
@@ -275,6 +277,21 @@ after_worker_boot do
 end
 ```
 
+### Unicorn process metrics
+
+In order to gather metrics from unicorn processes, we use `rainbows`, which exposes `Rainbows::Linux.tcp_listener_stats` to gather information about active workers and queued requests. To start monitoring your unicorn processes, you'll need to know both the path to unicorn PID file and the listen address (`pid_file` and `listen` in your unicorn config file)
+
+Then, run `prometheus_exporter` with `--unicorn-master` and `--unicorn-listen-address` options:
+
+```bash
+prometheus_exporter --unicorn-master /var/run/unicorn.pid --unicorn-listen-address 127.0.0.1:3000
+
+# alternatively, if you're using unix sockets:
+prometheus_exporter --unicorn-master /var/run/unicorn.pid --unicorn-listen-address /var/run/unicorn.sock
+```
+
+Note: You must install the `raindrops` gem in your `Gemfile` or locally.
+
 ### 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.
@@ -313,7 +330,6 @@ PrometheusExporter::Client.default.send_json(type: "person", age: 40)
 
 To load the custom collector run:
 
-
 ```
 $ bundle exec prometheus_exporter -a person_collector.rb
 ```

data/bin/prometheus_exporter

@@ -37,6 +37,13 @@ def run
       options[:verbose] = true
     end
 
+    opt.on('--unicorn-listen-address ADDRESS', String, '(optional) Address where unicorn listens on (unix or TCP address)') do |o|
+      options[:unicorn_listen_address] = o
+    end
+
+    opt.on('--unicorn-master PID_FILE', String, '(optional) PID file of unicorn master process to monitor unicorn') do |o|
+      options[:unicorn_pid_file] = o
+    end
   end.parse!
 
   if custom_collector_filename

data/lib/prometheus_exporter/instrumentation/unicorn.rb

@@ -0,0 +1,68 @@
+begin
+  require 'raindrops'
+rescue LoadError
+  # No raindrops available, dont do anything
+end
+
+module PrometheusExporter::Instrumentation
+  # collects stats from unicorn
+  class Unicorn
+    def self.start(pid_file:, listener_address:, client:, frequency: 30)
+      unicorn_collector = new(pid_file: pid_file, listener_address: listener_address)
+      client ||= PrometheusExporter::Client.default
+      Thread.new do
+        loop do
+          metric = unicorn_collector.collect
+          client.send_json metric
+        rescue StandardError => e
+          STDERR.puts("Prometheus Exporter Failed To Collect Unicorn Stats #{e}")
+        ensure
+          sleep frequency
+        end
+      end
+    end
+
+    def initialize(pid_file:, listener_address:)
+      @pid_file = pid_file
+      @listener_address = listener_address
+      @tcp = listener_address =~ /\A.+:\d+\z/
+    end
+
+    def collect
+      metric = {}
+      metric[:type] = 'unicorn'
+      collect_unicorn_stats(metric)
+      metric
+    end
+
+    def collect_unicorn_stats(metric)
+      stats = listener_address_stats
+
+      metric[:active_workers_total] = stats.active
+      metric[:request_backlog_total] = stats.queued
+      metric[:workers_total] = worker_process_count
+    end
+
+    private
+
+    def worker_process_count
+      return nil unless File.exist?(@pid_file)
+      pid = File.read(@pid_file)
+
+      return nil unless pid && pid.to_i > 0
+
+      # find all processes whose parent is the unicorn master
+      # but we're actually only interested in the number of processes (= lines of output)
+      result = `ps --no-header -o pid --ppid #{pid}`
+      result.lines.count
+    end
+
+    def listener_address_stats
+      if @tcp
+        Raindrops::Linux.tcp_listener_stats(@listener_address)[@listener_address]
+      else
+        Raindrops::Linux.unix_listener_stats(@listener_address)[@listener_address]
+      end
+    end
+  end
+end

data/lib/prometheus_exporter/instrumentation.rb

@@ -4,3 +4,4 @@ require_relative "instrumentation/sidekiq"
 require_relative "instrumentation/delayed_job"
 require_relative "instrumentation/puma"
 require_relative "instrumentation/hutch"
+require_relative "instrumentation/unicorn"

data/lib/prometheus_exporter/server/collector.rb

@@ -16,6 +16,7 @@ module PrometheusExporter::Server
       register_collector(DelayedJobCollector.new)
       register_collector(PumaCollector.new)
       register_collector(HutchCollector.new)
+      register_collector(UnicornCollector.new)
     end
 
     def register_collector(collector)

data/lib/prometheus_exporter/server/runner.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'prometheus_exporter/client'
+require_relative '../instrumentation/unicorn'
 
 module PrometheusExporter::Server
   class RunnerException < StandardError; end;
@@ -20,6 +22,15 @@ module PrometheusExporter::Server
         raise WrongInheritance, 'Collector class must be inherited from PrometheusExporter::Server::CollectorBase'
       end
 
+      if unicorn_listen_address && unicorn_pid_file
+        local_client = PrometheusExporter::LocalClient.new(collector: collector)
+        PrometheusExporter::Instrumentation::Unicorn.start(
+          pid_file: unicorn_pid_file,
+          listener_address: unicorn_listen_address,
+          client: local_client
+        )
+      end
+
       server = server_class.new port: port, collector: collector, timeout: timeout, verbose: verbose
       server.start
     end
@@ -81,6 +92,8 @@ module PrometheusExporter::Server
       @server_class || PrometheusExporter::Server::WebServer
     end
 
+    attr_accessor :unicorn_listen_address, :unicorn_pid_file
+
     def collector
       @_collector ||= collector_class.new
     end

data/lib/prometheus_exporter/server/unicorn_collector.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# custom type collector for prometheus_exporter for handling the metrics sent from
+# PrometheusExporter::Instrumentation::Unicorn
+class PrometheusExporter::Server::UnicornCollector < PrometheusExporter::Server::TypeCollector
+  UNICORN_GAUGES = {
+    workers_total: 'Number of unicorn workers.',
+    active_workers_total: 'Number of active unicorn workers',
+    request_backlog_total: 'Number of requests waiting to be processed by a unicorn worker.'
+  }.freeze
+
+  def initialize
+    @unicorn_metrics = []
+  end
+
+  def type
+    'unicorn'
+  end
+
+  def metrics
+    return [] if @unicorn_metrics.length.zero?
+
+    metrics = {}
+
+    @unicorn_metrics.map do |m|
+      UNICORN_GAUGES.map do |k, help|
+        k = k.to_s
+        if (v = m[k])
+          g = metrics[k] ||= PrometheusExporter::Metric::Gauge.new("unicorn_#{k}", help)
+          g.observe(v)
+        end
+      end
+    end
+
+    metrics.values
+  end
+
+  def collect(obj)
+    @unicorn_metrics << obj
+  end
+end

data/lib/prometheus_exporter/server.rb

@@ -10,3 +10,4 @@ require_relative "server/web_server"
 require_relative "server/runner"
 require_relative "server/puma_collector"
 require_relative "server/hutch_collector"
+require_relative "server/unicorn_collector"

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,7 @@ files:
 - lib/prometheus_exporter/instrumentation/process.rb
 - lib/prometheus_exporter/instrumentation/puma.rb
 - lib/prometheus_exporter/instrumentation/sidekiq.rb
+- lib/prometheus_exporter/instrumentation/unicorn.rb
 - lib/prometheus_exporter/metric.rb
 - lib/prometheus_exporter/metric/base.rb
 - lib/prometheus_exporter/metric/counter.rb
@@ -184,6 +185,7 @@ files:
 - lib/prometheus_exporter/server/runner.rb
 - lib/prometheus_exporter/server/sidekiq_collector.rb
 - lib/prometheus_exporter/server/type_collector.rb
+- lib/prometheus_exporter/server/unicorn_collector.rb
 - lib/prometheus_exporter/server/web_collector.rb
 - lib/prometheus_exporter/server/web_server.rb
 - lib/prometheus_exporter/version.rb