honeybadger 5.27.4 → 5.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 792e12e3901c164ddd146d74d0c1db7dc1978f2ea4804c7e8c35ccee9e864906
-  data.tar.gz: 92cb3e3455e09a2a9f708f645f22b06599626b5e0fe5e858362969b31133f65a
+  metadata.gz: 60e0469389628b0aac4876a067dcdd195b7ac92e46545c1efe4abaf60b85bfeb
+  data.tar.gz: 6829c83ceab8d7e1e731beeca047d427eff33713968b3dc71643562a66a05e36
 SHA512:
-  metadata.gz: f26123e1ccd7cfc7ed146a4e31b99ec2b835cfd9825ad9dd8813941a0b781765e26007de5c38f4761628859d10d9d44f881f864c561648afe873e477e0b4cc10
-  data.tar.gz: bcd09b18473e8d4839c68e54d7862fdf27a3bce4b01fc05b638a76e500eb55fd04be3b9268334ffa27e4737b002b383709bf6dda077801203704527007b4d19c
+  metadata.gz: 2aaa649a67f0757ddc75a8f951b3c44e2d03e4b55725fdd858f90108f01e1036a3f6b1f19c167194e871e37d62bc6081c24d93200f65a321a6fc918dd37aaa84
+  data.tar.gz: 29569d4d2a230d9b1c83bfac13d1b945cd36092a9b5b45fdcbcec85d2d03308af436864f745c9d6383fb8ed30c432b334c4c4d33520c955cfbaed4b2e9ed24e0

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # Change Log
 
 
+## [5.29.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.28.0...v5.29.0) (2025-06-27)
+
+
+### Features
+
+* add event context ([#700](https://github.com/honeybadger-io/honeybadger-ruby/issues/700)) ([36abc18](https://github.com/honeybadger-io/honeybadger-ruby/commit/36abc1826a62954b83b11b10d7e91d41f3052524))
+* exclude insights from rake tasks config ([#697](https://github.com/honeybadger-io/honeybadger-ruby/issues/697)) ([118034c](https://github.com/honeybadger-io/honeybadger-ruby/commit/118034c8395dd79fada9979f9f519ded8e81234a))
+
+
+### Bug Fixes
+
+* avoid database connections during asset precompilation ([#695](https://github.com/honeybadger-io/honeybadger-ruby/issues/695)) ([14ae485](https://github.com/honeybadger-io/honeybadger-ruby/commit/14ae4858da865cb6f95d16e1a12faf3ecc2caedd))
+
+## [5.28.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.27.4...v5.28.0) (2025-05-02)
+
+
+### Features
+
+* add sampling ([#689](https://github.com/honeybadger-io/honeybadger-ruby/issues/689)) ([0692ab0](https://github.com/honeybadger-io/honeybadger-ruby/commit/0692ab07d33843dc2612c36713b0f126ecba6b35))
+
+
 ## [5.27.4](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.27.3...v5.27.4) (2025-04-30)
 
 

data/lib/honeybadger/agent.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'zlib'
 
 require 'honeybadger/version'
 require 'honeybadger/config'
@@ -412,6 +413,7 @@ module Honeybadger
       extra_payload = {}.tap do |p|
         p[:request_id] = context_manager.get_request_id if context_manager.get_request_id
         p[:hostname] = config[:hostname].to_s if config[:'events.attach_hostname']
+        p.update(context_manager.get_event_context || {})
       end
 
       event = Event.new(event_type, extra_payload.merge(payload))
@@ -434,9 +436,61 @@ module Honeybadger
 
       return if event.halted?
 
+      return unless sample_event?(event)
+
+      strip_metadata(event)
+
       events_worker.push(event.as_json)
     end
 
+    # Save event-specific context for the current request.
+    #
+    # @example
+    #   Honeybadger.event_context({user_id: current_user.id})
+    #
+    #   # Inside a Rails controller:
+    #   before_action do
+    #     Honeybadger.event_context({user_id: current_user.id})
+    #   end
+    #
+    #   # Explicit conversion
+    #   class User < ActiveRecord::Base
+    #     def to_honeybadger_context
+    #       { user_id: id, user_email: email }
+    #     end
+    #   end
+    #
+    #   user = User.first
+    #   Honeybadger.event_context(user)
+    #
+    #   # Clearing event context:
+    #   Honeybadger.clear_event_context
+    #
+    # @param [Hash] context A Hash of data which will be sent to Honeybadger
+    #   when an event occurs. If the object responds to +#to_honeybadger_context+,
+    #   the return value of that method will be used (explicit conversion). Can
+    #   include any key/value, but a few keys have a special meaning in
+    #   Honeybadger.
+    #
+    # @return [Object, self] value of the block if passed, otherwise self
+    def event_context(context = nil, &block)
+      block_result = context_manager.set_event_context(context, &block) unless context.nil?
+      return block_result if block_given?
+
+      self
+    end
+
+    # Get event-specific context for the current request.
+    #
+    # @example
+    #   Honeybadger.event_context({my_data: 'my value'})
+    #   Honeybadger.get_event_context # => {my_data: 'my value'}
+    #
+    # @return [Hash, nil]
+    def get_event_context
+      context_manager.get_event_context
+    end
+
     # @api private
     def collect(collector)
       return unless config.insights_enabled?
@@ -570,6 +624,26 @@ module Honeybadger
 
     private
 
+    def strip_metadata(event)
+      event.delete(:_hb)
+    end
+
+    def sample_event?(event)
+      # Always send metrics events
+      return true if event[:event_type] == "metric.hb"
+
+      sample_rate = config[:'events.sample_rate']
+      sample_rate = event.dig(:_hb, :sample_rate) if event.dig(:_hb, :sample_rate).is_a?(Numeric)
+
+      return true if sample_rate >= 100
+
+      if event[:request_id] # Send all events for a given request
+        Zlib.crc32(event[:request_id].to_s) % 100 < sample_rate
+      else # Otherwise just take a random sample
+        rand(100) < sample_rate
+      end
+    end
+
     def validate_notify_opts!(opts)
       return if opts.has_key?(:exception)
       return if opts.has_key?(:error_message)

data/lib/honeybadger/config/defaults.rb

@@ -129,6 +129,11 @@ module Honeybadger
         default: nil,
         type: Array
       },
+      :'events.sample_rate' => {
+        description: 'Percentage of events to send to the API (0-100). A value of 0 means no events are sent, 100 means all events are sent.',
+        default: 100,
+        type: Integer
+      },
       plugins: {
         description: 'An optional list of plugins to load. Default is to load all plugins.',
         default: nil,
@@ -492,6 +497,11 @@ module Honeybadger
         default: 60,
         type: Integer
       },
+      :'insights.exclude_rake_tasks' => {
+        description: "List of Rake tasks to exclude from Insights instrumentation.",
+        default: ['assets:precompile'],
+        type: Array
+      },
       :'puma.insights.events' => {
         description: 'Enable automatic event capturing for Puma stats.',
         default: true,

data/lib/honeybadger/config.rb

@@ -289,7 +289,18 @@ module Honeybadger
     end
 
     def insights_enabled?
-      public? && !!self[:'insights.enabled']
+      return false unless public?
+      return false if insights_exclude_for_rake_tasks?
+      !!self[:'insights.enabled']
+    end
+
+    def insights_exclude_for_rake_tasks?
+      return false unless defined?(Rake) && Rake.application&.top_level_tasks
+
+      current_tasks = Array(Rake.application.top_level_tasks)
+      excluded_tasks = Array(self[:'insights.exclude_rake_tasks'])
+
+      (current_tasks & excluded_tasks).any?
     end
 
     def cluster_collection?(name)

data/lib/honeybadger/context_manager.rb

@@ -53,6 +53,52 @@ module Honeybadger
       end
     end
 
+    def clear_context
+      @mutex.synchronize do
+        @global_context = nil
+        @local_context = nil
+      end
+    end
+
+    def set_event_context(hash, &block)
+      local = block_given?
+      @mutex.synchronize do
+        @global_event_context ||= {}
+        @local_event_context ||= []
+
+        new_context = Context(hash)
+
+        if local
+          @local_event_context << new_context
+        else
+          @global_event_context.update(new_context)
+        end
+      end
+
+      if local
+        begin
+          yield
+        ensure
+          @mutex.synchronize { @local_event_context&.pop }
+        end
+      end
+    end
+
+    def get_event_context
+      @mutex.synchronize do
+        return @global_event_context unless @local_event_context
+
+        @global_event_context.merge(@local_event_context.inject({}, :merge))
+      end
+    end
+
+    def clear_event_context
+      @mutex.synchronize do
+        @global_event_context = nil
+        @local_event_context = nil
+      end
+    end
+
     def set_rack_env(env)
       @mutex.synchronize { @rack_env = env }
     end
@@ -77,6 +123,8 @@ module Honeybadger
       @mutex.synchronize do
         @global_context = nil
         @local_context = nil
+        @global_event_context = nil
+        @local_event_context = nil
         @rack_env = nil
         @request_id = nil
       end

data/lib/honeybadger/event.rb

@@ -15,7 +15,7 @@ module Honeybadger
     # The payload data of the event
     attr_reader :payload
 
-    def_delegators :payload, :dig, :[], :[]=
+    def_delegators :payload, :dig, :[], :[]=, :delete
 
     # @api private
     def initialize(event_type_or_payload, payload={})

data/lib/honeybadger/plugins/solid_queue.rb

@@ -3,6 +3,7 @@ module Honeybadger
     module SolidQueue
       Plugin.register :solid_queue do
         requirement { config.load_plugin_insights?(:solid_queue) && defined?(::SolidQueue) }
+        requirement { defined?(ActiveRecord::Base) && ActiveRecord::Base.connected? }
 
         collect_solid_queue_stats = -> do
           data = {}
@@ -26,9 +27,9 @@ module Honeybadger
         end
 
         collect do
-          stats = collect_solid_queue_stats.call
-
           if config.cluster_collection?(:solid_queue)
+            stats = collect_solid_queue_stats.call
+
             if Honeybadger.config.load_plugin_insights_events?(:solid_queue)
               Honeybadger.event('stats.solid_queue', stats.except(:stats).merge(stats[:stats]))
             end

data/lib/honeybadger/singleton.rb

@@ -27,8 +27,10 @@ module Honeybadger
   #     @see Agent#$2
   def_delegator :'Honeybadger::Agent.instance', :check_in
   def_delegator :'Honeybadger::Agent.instance', :context
+  def_delegator :'Honeybadger::Agent.instance', :event_context
   def_delegator :'Honeybadger::Agent.instance', :configure
   def_delegator :'Honeybadger::Agent.instance', :get_context
+  def_delegator :'Honeybadger::Agent.instance', :get_event_context
   def_delegator :'Honeybadger::Agent.instance', :flush
   def_delegator :'Honeybadger::Agent.instance', :stop
   def_delegator :'Honeybadger::Agent.instance', :exception_filter

data/lib/honeybadger/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.27.4
+  version: 5.29.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger