feat: add aggregated metrics for rails and more (#630)

* feat: add aggregated metrics for rails and more

This adds aggregated metrics for the following plugins:

* rails
* net_http
* sidekiq

Similar to the Karafka plugin, there is now more configuration:

* `rails.insights.events`
* `rails.insights.metrics`
* `sidekiq.insights.events`
* `sidekiq.insights.metrics`
* `net_http.insights.events`
* `net_http.insights.metrics`

Other miscellaneous changes:
* Switch Sidekiq histogram metric to gauge instead.
* Send totals so we can get proper averages across events.

Author: roelbondoc

lib/honeybadger/config/defaults.rb

@@ -32,6 +32,7 @@ class Boolean; end
                       'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
 
     IGNORE_EVENTS_DEFAULT = [
+      { event_type: 'metric.hb', metric_name: 'duration.sql.active_record', query: /^(begin|commit)( transaction)?$/i },
       { event_type: 'sql.active_record', query: /^(begin|commit)( transaction)?$/i },
       { event_type: 'sql.active_record', query: /(solid_queue|good_job)/i },
       { event_type: 'sql.active_record', name: /^GoodJob/ },
@@ -363,6 +364,36 @@ class Boolean; end
         default: 60,
         type: Integer
       },
+      :'sidekiq.insights.enabled' => {
+        description: 'Enable automatic data collection for Sidekiq.',
+        default: true,
+        type: Boolean
+      },
+      :'sidekiq.insights.events' => {
+        description: 'Enable automatic event capturing for Sidekiq.',
+        default: true,
+        type: Boolean
+      },
+      :'sidekiq.insights.metrics' => {
+        description: 'Enable automatic metric data collection for Sidekiq.',
+        default: false,
+        type: Boolean
+      },
+      :'rails.insights.enabled' => {
+        description: 'Enable automatic data collection for Ruby on Rails.',
+        default: true,
+        type: Boolean
+      },
+      :'rails.insights.events' => {
+        description: 'Enable automatic event capturing for Ruby on Rails.',
+        default: true,
+        type: Boolean
+      },
+      :'rails.insights.metrics' => {
+        description: 'Enable automatic metric data collection for Ruby on Rails.',
+        default: false,
+        type: Boolean
+      },
       :'karafka.insights.enabled' => {
         description: 'Enable automatic data collection for Karafka.',
         default: true,
@@ -375,14 +406,24 @@ class Boolean; end
       },
       :'karafka.insights.metrics' => {
         description: 'Enable automatic metric data collection for Karafka.',
-        default: true,
+        default: false,
         type: Boolean
       },
       :'net_http.insights.enabled' => {
         description: 'Allow automatic instrumentation of Net::HTTP requests.',
         default: true,
         type: Boolean
       },
+      :'net_http.insights.events' => {
+        description: 'Enable automatic event capturing for Net::HTTP requests.',
+        default: true,
+        type: Boolean
+      },
+      :'net_http.insights.metrics' => {
+        description: 'Enable automatic metric data collection for Net::HTTP requests.',
+        default: false,
+        type: Boolean
+      },
       :'net_http.insights.full_url' => {
         description: 'Record the full request url during instrumentation.',
         default: false,

lib/honeybadger/gauge.rb

@@ -19,6 +19,7 @@ def record(value)
     def payloads
       [
         {
+          total: @total,
           min: @min,
           max: @max,
           avg: @avg,

lib/honeybadger/histogram.rb

@@ -34,6 +34,7 @@ def bins
 
     def payloads
       [{
+        total: @total,
         min: @min,
         max: @max,
         avg: @avg,

lib/honeybadger/instrumentation.rb

@@ -134,7 +134,7 @@ def gauge(name, *args)
       elsif block_given?
         value = yield
       else
-        value = attributes.delete(:value)
+        value = attributes.delete(:duration) || attributes.delete(:value)
       end
 
       Honeybadger::Gauge.register(registry, name, attributes).tap do |gauge|

lib/honeybadger/notification_subscriber.rb

@@ -3,6 +3,8 @@
 
 module Honeybadger
   class NotificationSubscriber
+    include Honeybadger::InstrumentationHelper
+
     def start(name, id, payload)
       @start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
     end
@@ -21,7 +23,29 @@ def finish(name, id, payload)
     end
 
     def record(name, payload)
-      Honeybadger.event(name, payload)
+      if Honeybadger.config.load_plugin_insights_events?(:rails)
+        Honeybadger.event(name, payload)
+      end
+
+      if Honeybadger.config.load_plugin_insights_metrics?(:rails)
+        metric_source 'rails'
+        record_metrics(name, payload)
+      end
+    end
+
+    def record_metrics(name, payload)
+      case name
+      when 'sql.active_record'
+        gauge('duration.sql.active_record', value: payload[:duration], **payload.slice(:query))
+      when 'process_action.action_controller'
+        gauge('duration.process_action.action_controller', value: payload[:duration], **payload.slice(:method, :controller, :action, :format, :status))
+        gauge('db_runtime.process_action.action_controller', value: payload[:db_runtime], **payload.slice(:method, :controller, :action, :format, :status))
+        gauge('view_runtime.process_action.action_controller', value: payload[:view_runtime], **payload.slice(:method, :controller, :action, :format, :status))
+      when 'perform.active_job'
+        gauge('duration.perform.active_job', value: payload[:duration], **payload.slice(:job_class, :queue_name))
+      when /^cache_.*.active_support$/
+        gauge("duration.#{name}", value: payload[:duration], **payload.slice(:store, :key))
+      end
     end
 
     def process?(event, payload)
@@ -109,22 +133,6 @@ def format_payload(payload)
     end
   end
 
-  class ActiveJobMetricsSubscriber < NotificationSubscriber
-    include Honeybadger::InstrumentationHelper
-
-    def format_payload(payload)
-      {
-        job_class: payload[:job].class.to_s,
-        queue_name: payload[:job].queue_name
-      }
-    end
-
-    def record(name, payload)
-      metric_source 'active_job'
-      histogram name, { bins: [30, 60, 120, 300, 1800, 3600, 21_600] }.merge(payload)
-    end
-  end
-
   class ActionMailerSubscriber < NotificationSubscriber
   end
 

lib/honeybadger/plugins/active_job.rb

@@ -55,7 +55,6 @@ def context(job) # rubocop:disable Metrics/MethodLength
 
           if config.load_plugin_insights?(:active_job)
             ::ActiveSupport::Notifications.subscribe(/(enqueue_at|enqueue|enqueue_retry|enqueue_all|perform|retry_stopped|discard)\.active_job/, Honeybadger::ActiveJobSubscriber.new)
-            ::ActiveSupport::Notifications.subscribe('perform.active_job', Honeybadger::ActiveJobMetricsSubscriber.new)
           end
         end
       end

lib/honeybadger/plugins/net_http.rb

@@ -7,6 +7,12 @@ module Honeybadger
   module Plugins
     module Net
       module HTTP
+        @@hb_config = ::Honeybadger.config
+
+        def self.set_hb_config(config)
+          @@hb_config = config
+        end
+
         def request(request_data, body = nil, &block)
           return super unless started?
           return super if hb?
@@ -18,19 +24,26 @@ def request(request_data, body = nil, &block)
               status: response_data.code.to_i
             }.merge(parsed_uri_data(request_data))
 
-            Honeybadger.event('request.net_http', context)
+            if @@hb_config.load_plugin_insights_events?(:net_http)
+              Honeybadger.event('request.net_http', context)
+            end
+
+            if @@hb_config.load_plugin_insights_metrics?(:net_http)
+              context.delete(:url)
+              Honeybadger.gauge('duration.request', context.merge(metric_source: 'net_http'))
+            end
           end[1] # return the response data only
         end
 
         def hb?
-          address.to_s[/#{Honeybadger.config[:'connection.host'].to_s}/]
+          address.to_s[/#{@@hb_config[:'connection.host'].to_s}/]
         end
 
         def parsed_uri_data(request_data)
           uri = request_data.uri || build_uri(request_data)
           {}.tap do |uri_data|
             uri_data[:host] = uri.host
-            uri_data[:url] = uri.to_s if Honeybadger.config[:'net_http.insights.full_url']
+            uri_data[:url] = uri.to_s if @@hb_config[:'net_http.insights.full_url']
           end
         end
 
@@ -43,6 +56,7 @@ def build_uri(request_data)
           requirement { config.load_plugin_insights?(:net_http) }
 
           execution do
+            Honeybadger::Plugins::Net::HTTP.set_hb_config(config)
             ::Net::HTTP.send(:prepend, Honeybadger::Plugins::Net::HTTP)
           end
         end

lib/honeybadger/plugins/sidekiq.rb

@@ -38,10 +38,14 @@ def call(worker, msg, queue, &block)
             raise
           ensure
             context.merge!(duration: duration, status: status)
-            Honeybadger.event('perform.sidekiq', context)
+            if Honeybadger.config.load_plugin_insights_events?(:sidekiq)
+              Honeybadger.event('perform.sidekiq', context)
+            end
 
-            metric_source 'sidekiq'
-            histogram 'perform', { bins: [30, 60, 120, 300, 1800, 3600, 21_600] }.merge(context.slice(:worker, :queue, :duration))
+            if Honeybadger.config.load_plugin_insights_metrics?(:sidekiq)
+              metric_source 'sidekiq'
+              gauge 'perform', context.slice(:worker, :queue, :duration)
+            end
           end
         end
       end
@@ -55,7 +59,9 @@ def call(worker, msg, queue, _redis)
             queue: queue
           }
 
-          Honeybadger.event('enqueue.sidekiq', context)
+          if Honeybadger.config.load_plugin_insights_events?(:sidekiq)
+            Honeybadger.event('enqueue.sidekiq', context)
+          end
 
           yield
         end

spec/unit/honeybadger/gauge_spec.rb

@@ -10,6 +10,6 @@
 
     before { metric.record(1) }
 
-    it { should eq [{ avg: 1.0, latest: 1, max: 1, min: 1 }] }
+    it { should eq [{ total: 1, avg: 1.0, latest: 1, max: 1, min: 1 }] }
   end
 end

spec/unit/honeybadger/histogram_spec.rb

@@ -13,6 +13,7 @@
     it do
       should eq [
         {
+          total: 1,
           avg: 1.0,
           latest: 1,
           max: 1,