prometheus_exporter 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e41c3872a56ccec50aa5442ede71eb37509761e1a53c065ff3b877f8ef3732a0
-  data.tar.gz: 921f95d6a0e28bc17b212fda81984d28327d31e364d9a8efc34718a32d2c4053
+  metadata.gz: 61f6c4ee8ed7b6a57307fc9c5af44f492375ce2e4c07a8995d0877e1142f95bb
+  data.tar.gz: fcfe58d17d6e6ec8e2e6c0421a78426b18822483958445bec239a9c4358cb0df
 SHA512:
-  metadata.gz: e208fd0be610e8a268c0a1dcf7559b07dbdf8745bff9cedf6fb04967d132d36d324b8d76c85cad19f74ec4e623eeb356f90c624f4918d7e264839d55eebb8815
-  data.tar.gz: e1d6287fa0ca432e59ad48be400e375f75448f539a56117f8fde8c9a32314af5ee37fdaf989229c8d1000115d802012082fc641d098426354b9eccef46622237
+  metadata.gz: a15eaf6626b0036228ffaccb6e8ea561cbf5d4eb9286973864a1eae473190b8375cf8a1431f307eef32f3815aad9a70bd9275c399b7daad0f77abf924dd14a2e
+  data.tar.gz: 7cb71d3a29cc23b709b11a9cdb0a46452c9b538b84ee6b50b6711d26fe032db6a420e8d2f3494dc4024cd70304d6a35a3af0c4814ea49c810869003672292648

data/README.md

@@ -14,6 +14,7 @@ To learn more see [Instrumenting Rails with Prometheus](https://samsaffron.com/a
     * [Per-process stats](#per-process-stats)
     * [Sidekiq metrics](#sidekiq-metrics)
     * [Delayed Job plugin](#delayed-job-plugin)
+    * [Hutch metrics](#hutch-message-processing-tracer)
   * [Puma metrics](#puma-metrics)
   * [Custom type collectors](#custom-type-collectors)
   * [Multi process mode with custom collector](#multi-process-mode-with-custom-collector)
@@ -218,6 +219,17 @@ unless Rails.env == "test"
 end
 ```
 
+#### Hutch Message Processing Tracer
+
+Capture [Hutch](https://github.com/gocardless/hutch) metrics (how many jobs ran? how many failed? how long did they take?)
+
+```ruby
+unless Rails.env == "test"
+  require 'prometheus_exporter/instrumentation'
+  Hutch::Config.set(:tracer, PrometheusExporter::Instrumentation::Hutch)
+end
+```
+
 #### Instrumenting Request Queueing Time
 
 Request Queueing is defined as the time it takes for a request to reach your application (instrumented by this `prometheus_exporter`) from farther upstream (as your load balancer). A high queueing time usually means that your backend cannot handle all the incoming requests in time, so they queue up (= you should see if you need to add more capacity).

data/lib/prometheus_exporter/instrumentation.rb

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

data/lib/prometheus_exporter/instrumentation/hutch.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module PrometheusExporter::Instrumentation
+  class Hutch
+    def initialize(klass)
+      @klass = klass
+      @client = PrometheusExporter::Client.default
+    end
+
+    def handle(message)
+      success = false
+      start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      result = @klass.process(message)
+      success = true
+      result
+    ensure
+      duration = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start
+      @client.send_json(
+        type: "hutch",
+        name: @klass.class.to_s,
+        success: success,
+        duration: duration
+      )
+    end
+  end
+end

data/lib/prometheus_exporter/middleware.rb

@@ -19,6 +19,11 @@ class PrometheusExporter::Middleware
           :exec, :async_exec, :exec_prepared, :send_query_prepared, :query
         ], :sql)
       end
+      if defined? Mysql2::Client
+        MethodProfiler.patch(Mysql2::Client, [:query], :sql)
+        MethodProfiler.patch(Mysql2::Statement, [:execute], :sql)
+        MethodProfiler.patch(Mysql2::Result, [:each], :sql)
+      end
     end
   end
 

data/lib/prometheus_exporter/server.rb

@@ -9,3 +9,4 @@ require_relative "server/collector"
 require_relative "server/web_server"
 require_relative "server/runner"
 require_relative "server/puma_collector"
+require_relative "server/hutch_collector"

data/lib/prometheus_exporter/server/collector.rb

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

data/lib/prometheus_exporter/server/hutch_collector.rb

@@ -0,0 +1,43 @@
+module PrometheusExporter::Server
+  class HutchCollector < TypeCollector
+
+    def type
+      "hutch"
+    end
+
+    def collect(obj)
+      default_labels = { job_name: obj['name'] }
+      custom_labels = obj['custom_labels']
+      labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
+
+      ensure_hutch_metrics
+      @hutch_job_duration_seconds.observe(obj["duration"], labels)
+      @hutch_jobs_total.observe(1, labels)
+      @hutch_failed_jobs_total.observe(1, labels) if !obj["success"]
+    end
+
+    def metrics
+      if @hutch_jobs_total
+        [@hutch_job_duration_seconds, @hutch_jobs_total, @hutch_failed_jobs_total]
+      else
+        []
+      end
+    end
+
+    protected
+
+    def ensure_hutch_metrics
+      if !@hutch_jobs_total
+
+        @hutch_job_duration_seconds = PrometheusExporter::Metric::Counter.new(
+          "hutch_job_duration_seconds", "Total time spent in hutch jobs.")
+
+        @hutch_jobs_total = PrometheusExporter::Metric::Counter.new(
+          "hutch_jobs_total", "Total number of hutch jobs executed.")
+
+        @hutch_failed_jobs_total = PrometheusExporter::Metric::Counter.new(
+          "hutch_failed_jobs_total", "Total number failed hutch jobs executed.")
+      end
+    end
+  end
+end

data/lib/prometheus_exporter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,6 +163,7 @@ files:
 - lib/prometheus_exporter/instrumentation.rb
 - lib/prometheus_exporter/instrumentation/delayed_job.rb
 - lib/prometheus_exporter/instrumentation/global.rb
+- lib/prometheus_exporter/instrumentation/hutch.rb
 - lib/prometheus_exporter/instrumentation/method_profiler.rb
 - lib/prometheus_exporter/instrumentation/process.rb
 - lib/prometheus_exporter/instrumentation/puma.rb
@@ -178,6 +179,7 @@ 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/hutch_collector.rb
 - lib/prometheus_exporter/server/process_collector.rb
 - lib/prometheus_exporter/server/puma_collector.rb
 - lib/prometheus_exporter/server/runner.rb