honeybadger 5.10.2 → 5.11.0

data/lib/honeybadger/plugins/sidekiq.rb

@@ -1,3 +1,4 @@
+require 'honeybadger/instrumentation_helper'
 require 'honeybadger/plugin'
 require 'honeybadger/ruby'
 
@@ -11,7 +12,58 @@ module Honeybadger
         end
       end
 
-      Plugin.register do
+      class ServerMiddlewareInstrumentation
+        include Honeybadger::InstrumentationHelper
+
+        def call(worker, msg, queue, &block)
+          if msg["wrapped"]
+            context = {
+              jid: msg["jid"],
+              worker: msg["wrapped"],
+              queue: queue
+            }
+          else
+            context = {
+              jid: msg["jid"],
+              worker: msg["class"],
+              queue: queue
+            }
+          end
+
+          begin
+            duration = Honeybadger.instrumentation.monotonic_timer { block.call }[0]
+            status = 'success'
+          rescue Exception => e
+            status = 'failure'
+            raise
+          ensure
+            context.merge!(duration: duration, status: status)
+            Honeybadger.event('perform.sidekiq', context)
+
+            metric_source 'sidekiq'
+            histogram 'perform', { bins: [30, 60, 120, 300, 1800, 3600, 21_600] }.merge(context.slice(:worker, :queue, :duration))
+          end
+        end
+      end
+
+      class ClientMiddlewareInstrumentation
+        include Honeybadger::InstrumentationHelper
+
+        def call(worker, msg, queue, _redis)
+          context = {
+            worker: msg["wrapped"] || msg["class"],
+            queue: queue
+          }
+
+          Honeybadger.event('enqueue.sidekiq', context)
+
+          yield
+        end
+      end
+
+      Plugin.register :sidekiq do
+        leader_checker = nil
+
         requirement { defined?(::Sidekiq) }
 
         execution do
@@ -71,6 +123,81 @@ module Honeybadger
               }
             end
           end
+
+          if config.load_plugin_insights?(:sidekiq)
+            require "sidekiq"
+            require "sidekiq/api"
+            require "sidekiq/component"
+
+            class SidekiqClusterCollectionChecker
+              include ::Sidekiq::Component
+              def initialize(config)
+                @config = config
+              end
+
+              def collect?
+                return true unless defined?(::Sidekiq::Enterprise)
+                leader?
+              end
+            end
+
+            ::Sidekiq.configure_server do |config|
+              config.server_middleware { |chain| chain.add(ServerMiddlewareInstrumentation) }
+              config.client_middleware { |chain| chain.add(ClientMiddlewareInstrumentation) }
+              config.on(:startup) do
+                leader_checker = SidekiqClusterCollectionChecker.new(config)
+              end
+            end
+
+            ::Sidekiq.configure_client do |config|
+              config.client_middleware { |chain| chain.add(ClientMiddlewareInstrumentation) }
+            end
+          end
+        end
+
+        collect do
+          if config.cluster_collection?(:sidekiq) && (leader_checker.nil? || leader_checker.collect?)
+            metric_source 'sidekiq'
+
+            stats = ::Sidekiq::Stats.new
+
+            gauge 'active_workers', ->{ stats.workers_size }
+            gauge 'active_processes', ->{ stats.processes_size }
+            gauge 'jobs_processed', ->{ stats.processed }
+            gauge 'jobs_failed', ->{ stats.failed }
+            gauge 'jobs_scheduled', ->{ stats.scheduled_size }
+            gauge 'jobs_enqueued', ->{ stats.enqueued }
+            gauge 'jobs_dead', ->{ stats.dead_size }
+            gauge 'jobs_retry', ->{ stats.retry_size }
+
+            ::Sidekiq::Queue.all.each do |queue|
+              gauge 'queue_latency', { queue: queue.name }, ->{ (queue.latency * 1000).ceil }
+              gauge 'queue_depth', { queue: queue.name }, ->{ queue.size }
+            end
+
+            Hash.new(0).tap do |busy_counts|
+              ::Sidekiq::Workers.new.each do |_pid, _tid, work|
+                payload = work.respond_to?(:payload) ? work.payload : work["payload"]
+                payload = JSON.parse(payload) if payload.is_a?(String)
+                busy_counts[payload["queue"]] += 1
+              end
+            end.each do |queue_name, busy_count|
+              gauge 'queue_busy', { queue: queue_name }, ->{ busy_count }
+            end
+
+            processes = ::Sidekiq::ProcessSet.new.to_enum(:each).to_a
+            gauge 'capacity', ->{ processes.map { |process| process["concurrency"] }.sum }
+
+            process_utilizations = processes.map do |process|
+              next unless process["concurrency"].to_f > 0
+              process["busy"] / process["concurrency"].to_f
+            end.compact
+
+            if process_utilizations.any?
+              utilization = process_utilizations.sum / process_utilizations.length.to_f
+              gauge 'utilization', ->{ utilization }
+            end
+          end
         end
       end
     end

data/lib/honeybadger/plugins/solid_queue.rb

@@ -0,0 +1,27 @@
+module Honeybadger
+  module Plugins
+    module SolidQueue
+      Plugin.register :solid_queue do
+        requirement { defined?(::SolidQueue) }
+
+        collect do
+          if config.cluster_collection?(:solid_queue)
+            metric_source 'solid_queue'
+
+            gauge 'jobs_in_progress', ->{ ::SolidQueue::ClaimedExecution.count }
+            gauge 'jobs_blocked', ->{ ::SolidQueue::BlockedExecution.count }
+            gauge 'jobs_failed', ->{ ::SolidQueue::FailedExecution.count }
+            gauge 'jobs_scheduled', ->{ ::SolidQueue::ScheduledExecution.count }
+            gauge 'jobs_processed', ->{ ::SolidQueue::Job.where.not(finished_at: nil).count }
+            gauge 'active_workers', ->{ ::SolidQueue::Process.where(kind: "Worker").count }
+            gauge 'active_dispatchers', ->{ ::SolidQueue::Process.where(kind: "Dispatcher").count }
+
+            ::SolidQueue::Queue.all.each do |queue|
+              gauge 'queue_depth', { queue: queue.name }, ->{ queue.size }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/plugins/system.rb

@@ -0,0 +1,16 @@
+require 'honeybadger/util/stats'
+require 'honeybadger/plugin'
+
+module Honeybadger
+  module Plugins
+    module System
+      Plugin.register :system do
+        requirement { Util::Stats::HAS_MEM || Util::Stats::HAS_LOAD }
+
+        collect do
+          Honeybadger.event('report.system', Util::Stats.all)
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/registry.rb

@@ -0,0 +1,32 @@
+module Honeybadger
+  class Registry
+    def initialize
+      @mutex = Mutex.new
+      @metrics = Hash.new
+    end
+
+    def register(metric)
+      @mutex.synchronize do
+        @metrics[metric.signature] = metric
+      end
+    end
+
+    def get(metric_type, name, attributes)
+      @mutex.synchronize do
+        @metrics[Honeybadger::Metric.signature(metric_type, name, attributes)]
+      end
+    end
+
+    def flush
+      @mutex.synchronize do
+        @metrics = Hash.new
+      end
+    end
+
+    def metrics
+      @mutex.synchronize do
+        @metrics.values
+      end
+    end
+  end
+end

data/lib/honeybadger/registry_execution.rb

@@ -0,0 +1,28 @@
+module Honeybadger
+  class RegistryExecution
+    def initialize(registry, config, options)
+      @registry = registry
+      @config = config
+      @options = options
+      @interval = config[:'insights.registry_flush_interval'] || options.fetch(:interval, 60)
+      @end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) + @interval
+    end
+
+    def tick
+      @end_time - ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+    end
+
+    def reset
+      @end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) + @interval
+      @registry.flush
+    end
+
+    def call
+      @registry.metrics.each do |metric|
+        metric.event_payloads.each do |payload|
+          Honeybadger.event(payload.merge(interval: @interval))
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/singleton.rb

@@ -39,6 +39,14 @@ module Honeybadger
   def_delegator :'Honeybadger::Agent.instance', :clear!
   def_delegator :'Honeybadger::Agent.instance', :track_deployment
   def_delegator :'Honeybadger::Agent.instance', :event
+  def_delegator :'Honeybadger::Agent.instance', :collect
+  def_delegator :'Honeybadger::Agent.instance', :registry
+  def_delegator :'Honeybadger::Agent.instance', :instrumentation
+  def_delegator :'Honeybadger::Agent.instance', :time
+  def_delegator :'Honeybadger::Agent.instance', :histogram
+  def_delegator :'Honeybadger::Agent.instance', :gauge
+  def_delegator :'Honeybadger::Agent.instance', :increment_counter
+  def_delegator :'Honeybadger::Agent.instance', :decrement_counter
 
   # @!macro [attach] def_delegator
   #   @!method $2(...)

data/lib/honeybadger/timer.rb

@@ -0,0 +1,6 @@
+require 'honeybadger/gauge'
+
+module Honeybadger
+  class Timer < Gauge
+  end
+end

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # The current String Honeybadger version.
-  VERSION = '5.10.2'.freeze
+  VERSION = '5.11.0'.freeze
 end

data/lib/puma/plugin/honeybadger.rb

@@ -0,0 +1,43 @@
+require 'honeybadger/instrumentation_helper'
+
+module Honeybadger
+  class PumaPlugin
+    include Honeybadger::InstrumentationHelper
+
+    STATS_KEYS = %i(pool_capacity max_threads requests_count backlog running).freeze
+
+    ::Puma::Plugin.create do
+      def start(launcher)
+        puma_plugin = ::Honeybadger::PumaPlugin.new
+        in_background do
+          loop do
+            puma_plugin.record
+            sleep 1
+          end
+        end
+      end
+    end
+
+    def record
+      metric_source 'puma'
+
+      stats = ::Puma.stats rescue {}
+      stats = stats.is_a?(Hash) ? stats : JSON.parse(stats, symbolize_names: true)
+
+      if stats[:worker_status].is_a?(Array)
+        stats[:worker_status].each do |worker_data|
+          context = { worker: worker_data[:index] }
+          record_puma_stats(worker_data[:last_status], context)
+        end
+      else
+        record_puma_stats(stats)
+      end
+    end
+
+    def record_puma_stats(stats, context={})
+      STATS_KEYS.each do |stat|
+        gauge stat, context, ->{ stats[stat] } if stats[stat]
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.10.2
+  version: 5.11.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -55,16 +55,25 @@ files:
 - lib/honeybadger/const.rb
 - lib/honeybadger/context_manager.rb
 - lib/honeybadger/conversions.rb
+- lib/honeybadger/counter.rb
 - lib/honeybadger/events_worker.rb
+- lib/honeybadger/gauge.rb
+- lib/honeybadger/histogram.rb
 - lib/honeybadger/init/hanami.rb
 - lib/honeybadger/init/rails.rb
 - lib/honeybadger/init/rake.rb
 - lib/honeybadger/init/ruby.rb
 - lib/honeybadger/init/sinatra.rb
+- lib/honeybadger/instrumentation.rb
+- lib/honeybadger/instrumentation_helper.rb
 - lib/honeybadger/logging.rb
+- lib/honeybadger/metric.rb
+- lib/honeybadger/metrics_worker.rb
 - lib/honeybadger/notice.rb
+- lib/honeybadger/notification_subscriber.rb
 - lib/honeybadger/plugin.rb
 - lib/honeybadger/plugins/active_job.rb
+- lib/honeybadger/plugins/autotuner.rb
 - lib/honeybadger/plugins/breadcrumbs.rb
 - lib/honeybadger/plugins/delayed_job.rb
 - lib/honeybadger/plugins/delayed_job/plugin.rb
@@ -72,21 +81,27 @@ files:
 - lib/honeybadger/plugins/karafka.rb
 - lib/honeybadger/plugins/lambda.rb
 - lib/honeybadger/plugins/local_variables.rb
+- lib/honeybadger/plugins/net_http.rb
 - lib/honeybadger/plugins/passenger.rb
 - lib/honeybadger/plugins/rails.rb
 - lib/honeybadger/plugins/resque.rb
 - lib/honeybadger/plugins/shoryuken.rb
 - lib/honeybadger/plugins/sidekiq.rb
+- lib/honeybadger/plugins/solid_queue.rb
 - lib/honeybadger/plugins/sucker_punch.rb
+- lib/honeybadger/plugins/system.rb
 - lib/honeybadger/plugins/thor.rb
 - lib/honeybadger/plugins/warden.rb
 - lib/honeybadger/rack/error_notifier.rb
 - lib/honeybadger/rack/user_feedback.rb
 - lib/honeybadger/rack/user_informer.rb
+- lib/honeybadger/registry.rb
+- lib/honeybadger/registry_execution.rb
 - lib/honeybadger/ruby.rb
 - lib/honeybadger/singleton.rb
 - lib/honeybadger/tasks.rb
 - lib/honeybadger/templates/feedback_form.erb
+- lib/honeybadger/timer.rb
 - lib/honeybadger/util/http.rb
 - lib/honeybadger/util/lambda.rb
 - lib/honeybadger/util/request_hash.rb
@@ -97,6 +112,7 @@ files:
 - lib/honeybadger/util/stats.rb
 - lib/honeybadger/version.rb
 - lib/honeybadger/worker.rb
+- lib/puma/plugin/honeybadger.rb
 - resources/ca-bundle.crt
 - vendor/capistrano-honeybadger/lib/capistrano/honeybadger.rb
 - vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap