honeybadger 5.20.1 → 5.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae2f44eb9962db4e28c9dde0605afddce6d9f5e45a5edd4717df5ee29c3721f7
-  data.tar.gz: 1b8a54201362718397a65381a1acae5075d981e8ec456a83c88c738842fbd61a
+  metadata.gz: 40136d87c293fee9689b5f11926a15bc98c225f34f6a7b75e4fcd8ede1cacc5f
+  data.tar.gz: '028f8549e380de8c248013f0ed7846f5fea5018f71c8ac1e0bc310a72d695fdd'
 SHA512:
-  metadata.gz: 120f89c79192559358b22bc4b2834e511974f2021faf94001f8ac535cabd5ad4d544093381053ee056b824e47bcc3b2365e41bbf4828c4dfe77a7503f9baea16
-  data.tar.gz: 05d48ae81cc6e01c1ea0686d8f8a3c6d76c532afd8d286aa2920c8c19ba12cd0b2e56041837d77c3926c1c0f172c98504ccd647d7c70e86d86ad9272c88bec38
+  metadata.gz: 1404e62cbc7b74d49e3a3881791c5cada2ab820e447efb0c7d2c83994cd81d54b32ca614b52a9fc47606d368c65c950ab5159e7e9342e7214c9d891a132d12e6
+  data.tar.gz: 737dc2abee3fef27ecd93034e6914eb0a6439a6fdcb35e803ceeb2bb74161f0dd19b08fc1661ea78723b7ecd6a8b984c8a1f2733288c63d446ca1c68fa3b335f

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 
 
+## [5.22.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.21.0...v5.22.0) (2024-11-14)
+
+
+### Features
+
+* only allow for insights to be enabled when public ([#642](https://github.com/honeybadger-io/honeybadger-ruby/issues/642)) ([2d3ab26](https://github.com/honeybadger-io/honeybadger-ruby/commit/2d3ab26ca3673b5b01082d55737bf7907c02e799))
+
+## [5.21.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.20.1...v5.21.0) (2024-11-14)
+
+
+### Features
+
+* add event stats for sidekiq and sq ([#638](https://github.com/honeybadger-io/honeybadger-ruby/issues/638)) ([0d15bf5](https://github.com/honeybadger-io/honeybadger-ruby/commit/0d15bf543d4c425a2d9f6000d328dc0e71261647))
+* disable all workers in rails console ([#636](https://github.com/honeybadger-io/honeybadger-ruby/issues/636)) ([d0bcb42](https://github.com/honeybadger-io/honeybadger-ruby/commit/d0bcb4278ad84d02e3706766269582067bc76e29))
+* emit an event for karafka stats ([#637](https://github.com/honeybadger-io/honeybadger-ruby/issues/637)) ([e7e74b5](https://github.com/honeybadger-io/honeybadger-ruby/commit/e7e74b51324f7c718b1adc634cee4233d0c91813))
+
 ## [5.20.1](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.20.0...v5.20.1) (2024-11-13)
 
 

data/lib/honeybadger/agent.rb

@@ -377,6 +377,16 @@ module Honeybadger
       true
     end
 
+    # Stops the Honeybadger Insights related services.
+    #
+    # @example
+    #   Honeybadger.stop_insights # => nil
+    def stop_insights(force = false)
+      events_worker&.shutdown(force)
+      metrics_worker&.shutdown(force)
+      true
+    end
+
     # Sends event to events backend
     #
     # @example

data/lib/honeybadger/config/defaults.rb

@@ -344,6 +344,21 @@ module Honeybadger
         default: true,
         type: Boolean
       },
+      :'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
+      },
       :'sidekiq.insights.cluster_collection' => {
         description: 'Collect cluster based metrics for Sidekiq.',
         default: true,
@@ -351,34 +366,34 @@ module Honeybadger
       },
       :'sidekiq.insights.collection_interval' => {
         description: 'The frequency in which Sidekiq cluster metrics are sampled.',
-        default: 60,
+        default: 5,
         type: Integer
       },
-      :'solid_queue.insights.cluster_collection' => {
-        description: 'Collect cluster based metrics for SolidQueue.',
+      :'solid_queue.insights.enabled' => {
+        description: 'Enable automatic data collection for SolidQueue.',
         default: true,
         type: Boolean
       },
-      :'solid_queue.insights.collection_interval' => {
-        description: 'The frequency in which SolidQueue cluster metrics are sampled.',
-        default: 60,
-        type: Integer
-      },
-      :'sidekiq.insights.enabled' => {
-        description: 'Enable automatic data collection for Sidekiq.',
+      :'solid_queue.insights.events' => {
+        description: 'Enable automatic event capturing for SolidQueue.',
         default: true,
         type: Boolean
       },
-      :'sidekiq.insights.events' => {
-        description: 'Enable automatic event capturing for Sidekiq.',
-        default: true,
+      :'solid_queue.insights.metrics' => {
+        description: 'Enable automatic metric data collection for SolidQueue.',
+        default: false,
         type: Boolean
       },
-      :'sidekiq.insights.metrics' => {
-        description: 'Enable automatic metric data collection for Sidekiq.',
-        default: false,
+      :'solid_queue.insights.cluster_collection' => {
+        description: 'Collect cluster based metrics for SolidQueue.',
+        default: true,
         type: Boolean
       },
+      :'solid_queue.insights.collection_interval' => {
+        description: 'The frequency in which SolidQueue cluster metrics are sampled.',
+        default: 5,
+        type: Integer
+      },
       :'rails.insights.enabled' => {
         description: 'Enable automatic data collection for Ruby on Rails.',
         default: true,

data/lib/honeybadger/config.rb

@@ -289,7 +289,7 @@ module Honeybadger
     end
 
     def insights_enabled?
-      !!self[:'insights.enabled']
+      public? && !!self[:'insights.enabled']
     end
 
     def cluster_collection?(name)

data/lib/honeybadger/init/rails.rb

@@ -34,7 +34,10 @@ module Honeybadger
         end
 
         console do
-          Honeybadger::Agent.instance.config[:'insights.enabled'] = Honeybadger::Agent.instance.config[:'insights.console.enabled']
+          unless Honeybadger::Agent.instance.config[:'insights.enabled'] = Honeybadger::Agent.instance.config[:'insights.console.enabled']
+            Honeybadger::Agent.instance.config.logger.debug("Rails console detected, shutting down Honeybadger Insights workers.")
+            Honeybadger::Agent.instance.stop_insights
+          end
         end
       end
     end

data/lib/honeybadger/karafka.rb

@@ -70,6 +70,10 @@ module Honeybadger
       #
       # @param event [Karafka::Core::Monitoring::Event]
       def on_statistics_emitted(event)
+        if Honeybadger.config.load_plugin_insights_events?(:karafka)
+          Honeybadger.event("statistics_emitted.karafka", event.payload)
+        end
+
         return unless Honeybadger.config.load_plugin_insights_metrics?(:karafka)
 
         statistics = event[:statistics]
@@ -138,9 +142,7 @@ module Honeybadger
       def on_connection_listener_fetch_loop_received(event)
         time_taken = event[:time]
         messages_count = event[:messages_buffer].size
-
         consumer_group_id = event[:subscription_group].consumer_group.id
-
         extra_tags = { consumer_group: consumer_group_id }
 
         if Honeybadger.config.load_plugin_insights_metrics?(:karafka)
@@ -191,9 +193,10 @@ module Honeybadger
               #
               # @param event [Karafka::Core::Monitoring::Event]
               def on_consumer_#{after}(event)
-                tags = consumer_tags(event.payload[:caller])
-
-                increment_counter('consumer_#{name}', value: 1, **tags)
+                if Honeybadger.config.load_plugin_insights_metrics?(:karafka)
+                  tags = consumer_tags(event.payload[:caller])
+                  increment_counter('consumer_#{name}', value: 1, **tags)
+                end
               end
         RUBY
       end

data/lib/honeybadger/plugins/sidekiq.rb

@@ -167,47 +167,67 @@ module Honeybadger
           end
         end
 
+        collect_sidekiq_stats = -> do
+          stats = ::Sidekiq::Stats.new
+          data = stats.as_json
+          data[:queues] = {}
+
+          ::Sidekiq::Queue.all.each do |queue|
+            data[:queues][queue.name] ||= {}
+            data[:queues][queue.name][:latency] = (queue.latency * 1000).ceil
+            data[:queues][queue.name][:depth] = 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|
+            data[:queues][queue_name] ||= {}
+            data[:queues][queue_name][:busy] = busy_count
+          end
+
+          processes = ::Sidekiq::ProcessSet.new.to_enum(:each).to_a
+          data[: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
+            data[:utilization] = utilization
+          end
+
+          data
+        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
+            stats = collect_sidekiq_stats.call
 
-            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 }
+            if Honeybadger.config.load_plugin_insights_events?(:sidekiq)
+              Honeybadger.event('stats.sidekiq', stats.except('stats').merge(stats['stats']))
             end
 
-            processes = ::Sidekiq::ProcessSet.new.to_enum(:each).to_a
-            gauge 'capacity', ->{ processes.map { |process| process["concurrency"] }.sum }
+            if Honeybadger.config.load_plugin_insights_metrics?(:sidekiq)
+              metric_source 'sidekiq'
+
+              stats['stats'].each do |name, value|
+                gauge name, value: value
+              end
 
-            process_utilizations = processes.map do |process|
-              next unless process["concurrency"].to_f > 0
-              process["busy"] / process["concurrency"].to_f
-            end.compact
+              stats[:queues].each do |queue_name, data|
+                data.each do |key, value|
+                  gauge "queue_#{key}", queue: queue_name, value: value
+                end
+              end
 
-            if process_utilizations.any?
-              utilization = process_utilizations.sum / process_utilizations.length.to_f
-              gauge 'utilization', ->{ utilization }
+              gauge 'capacity', value: stats[:capacity] if stats[:capacity]
+              gauge 'utilization', value: stats[:utilization] if stats[:utilization]
             end
           end
         end

data/lib/honeybadger/plugins/solid_queue.rb

@@ -4,20 +4,46 @@ module Honeybadger
       Plugin.register :solid_queue do
         requirement { config.load_plugin_insights?(:solid_queue) && defined?(::SolidQueue) }
 
+        collect_solid_queue_stats = -> do
+          data = {}
+          data[:stats] = {
+            jobs_in_progress: ::SolidQueue::ClaimedExecution.count,
+            jobs_blocked: ::SolidQueue::BlockedExecution.count,
+            jobs_failed: ::SolidQueue::FailedExecution.count,
+            jobs_scheduled: ::SolidQueue::ScheduledExecution.count,
+            jobs_processed: ::SolidQueue::Job.where.not(finished_at: nil).count,
+            active_workers: ::SolidQueue::Process.where(kind: "Worker").count,
+            active_dispatchers: ::SolidQueue::Process.where(kind: "Dispatcher").count
+          }
+
+          data[:queues] = {}
+
+          ::SolidQueue::Queue.all.each do |queue|
+            data[:queues][queue.name] = { depth: queue.size }
+          end
+
+          data
+        end
+
         collect do
+          stats = collect_solid_queue_stats.call
+
           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 }
+            if Honeybadger.config.load_plugin_insights_events?(:solid_queue)
+              Honeybadger.event('stats.solid_queue', stats.except(:stats).merge(stats[:stats]))
+            end
+
+            if Honeybadger.config.load_plugin_insights_metrics?(:solid_queue)
+              metric_source 'solid_queue'
+              stats[:stats].each do |stat_name, value|
+                gauge stat_name, value: value
+              end
+
+              stats[:queues].each do |queue_name, data|
+                data.each do |key, value|
+                  gauge "queue_#{key}", queue: queue_name, value: value
+                end
+              end
             end
           end
         end

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.20.1
+  version: 5.22.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger