honeybadger 5.13.1 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f0e76e4da63a4398fcb71cc8fb153f5a854cd13a0d163924adc41473460401
-  data.tar.gz: f8adacb9335c3d42f3fa2991eb05453551cb546b1d439e504fff32d5c41703b5
+  metadata.gz: 60300a5d8ccaecda5eeff8887f76c5c54dba5c4610539c4ff8865d1355a5c124
+  data.tar.gz: d057c93fc1a8d24f6fdb4a952d5b56cf8dbf0f3ee07466eaad38d3be2efcad13
 SHA512:
-  metadata.gz: e5022f0122bb51b147f6014e25f204250906b33c4e0e25c9699302e8e8a1bc97bad41497546f93c2d8cb9442de53d207309003699dfc55ae6190e14c2b110cff
-  data.tar.gz: dc28062240092dd136fb22ccd54b45882e850a6982f13225924606ff4e7805451e12a9516a9deba75ee83c71d0f2fcae400c70df2be191d8d5b1b402c8a71365
+  metadata.gz: 06cdba44a37870e7b2e51414efb9ac48f5e3dc8015403a7b40e3a12520f0d037ab77f90205ea85f610de2d9bee11b6b6d5bf63fcbfce6a8d296ef8d1aeec7af9
+  data.tar.gz: 6538734d781bd200445e9ac603baf2fbd3b91a0e723112cb79d7468a56baaadc38921fdd75dfd4bde8ad25a67e911e3c56020dcff54f49414066abd68c83dc9a

data/CHANGELOG.md

@@ -1,6 +1,55 @@
 # Change Log
 
 
+## [5.15.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.14.2...v5.15.0) (2024-07-18)
+
+
+### Features
+
+* define default events to ignore, allow for override ([#570](https://github.com/honeybadger-io/honeybadger-ruby/issues/570)) ([a6f2177](https://github.com/honeybadger-io/honeybadger-ruby/commit/a6f2177eb69b75eafef235768187ccf6b3a538f0))
+
+## [5.14.2](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.14.1...v5.14.2) (2024-07-17)
+
+
+### Bug Fixes
+
+* add []= delegator ([#590](https://github.com/honeybadger-io/honeybadger-ruby/issues/590)) ([9f1d6b5](https://github.com/honeybadger-io/honeybadger-ruby/commit/9f1d6b55e88497c4c37659fdfaeaa163c7794672))
+* add event method for cli backend test ([#588](https://github.com/honeybadger-io/honeybadger-ruby/issues/588)) ([1e047bb](https://github.com/honeybadger-io/honeybadger-ruby/commit/1e047bbcd17db676b96dd78eb918475e3a52ab1b))
+
+## [5.14.1](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.14.0...v5.14.1) (2024-07-15)
+
+
+### Bug Fixes
+
+* do not serialize adapter object ([#586](https://github.com/honeybadger-io/honeybadger-ruby/issues/586)) ([f724ebf](https://github.com/honeybadger-io/honeybadger-ruby/commit/f724ebf0a2c3e2402c64448779cf7e6386de8b47))
+
+## [5.14.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.13.3...v5.14.0) (2024-07-11)
+
+
+### Features
+
+* add --host and --ui_host flags to install command ([#584](https://github.com/honeybadger-io/honeybadger-ruby/issues/584)) ([5f171ba](https://github.com/honeybadger-io/honeybadger-ruby/commit/5f171badc0602df76a87e4caa0e06c9959648376))
+* add ability to link to a custom domain after creating a notice ([#583](https://github.com/honeybadger-io/honeybadger-ruby/issues/583)) ([5b32b23](https://github.com/honeybadger-io/honeybadger-ruby/commit/5b32b231bb5562b3d97066e3a41f39de76b2f4a3))
+
+
+### Bug Fixes
+
+* squash warning about BigDecimal ([#578](https://github.com/honeybadger-io/honeybadger-ruby/issues/578)) ([47ff813](https://github.com/honeybadger-io/honeybadger-ruby/commit/47ff8130047b723b9d85be07b308c4883320eabb))
+
+## [5.13.3](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.13.2...v5.13.3) (2024-07-06)
+
+
+### Bug Fixes
+
+* disable insights when loading rails console ([#580](https://github.com/honeybadger-io/honeybadger-ruby/issues/580)) ([94844bd](https://github.com/honeybadger-io/honeybadger-ruby/commit/94844bd72922f27ecf40453ef7c901433067688b))
+
+## [5.13.2](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.13.1...v5.13.2) (2024-07-03)
+
+
+### Bug Fixes
+
+* buffer more and warn less ([#575](https://github.com/honeybadger-io/honeybadger-ruby/issues/575)) ([8e99e17](https://github.com/honeybadger-io/honeybadger-ruby/commit/8e99e17af65e8d0002e5e8204d5ded1cea891e86))
+
 ## [5.13.1](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.13.0...v5.13.1) (2024-07-01)
 
 

data/lib/honeybadger/agent.rb

@@ -404,7 +404,18 @@ module Honeybadger
         with_error_handling { hook.call(event) }
       end
 
-      return if config.ignored_events.any? { |check| event.event_type&.match?(check) }
+      return if config.ignored_events.any? do |check|
+        with_error_handling do
+          check.all? do |keys, value|
+            if keys == [:event_type]
+              event.event_type&.match?(value)
+            elsif event.dig(*keys)
+              event.dig(*keys).to_s.match?(value)
+            end
+          end
+        end
+      end
+
       return if event.halted?
 
       events_worker.push(event.as_json)

data/lib/honeybadger/backend/test.rb

@@ -13,6 +13,16 @@ module Honeybadger
         @notifications ||= Hash.new {|h,k| h[k] = [] }
       end
 
+      # The event list.
+      #
+      # @example
+      #   Test.events # => [{}, {}, ...]
+      #
+      # @return [Array<Hash>] List of event payloads.
+      def self.events
+        @events ||= []
+      end
+
       # @api public
       # The check in list.
       #
@@ -37,6 +47,11 @@ module Honeybadger
         super
       end
 
+      def event(payload)
+        events << payload
+        super
+      end
+
       def check_in(id)
         check_ins << id
         super

data/lib/honeybadger/cli/install.rb

@@ -78,6 +78,10 @@ debug: false
 insights:
   enabled: #{options["insights"]}
 CONFIG
+            if (connection = options.slice("host", "ui_host")).any?
+              file.puts("\n# Override hosts\nconnection:")
+              connection.each {|k,v| file.puts("  #{k}: '#{v}'") }
+            end
           end
         end
 

data/lib/honeybadger/cli/main.rb

@@ -49,6 +49,8 @@ WELCOME
 
       desc 'install API_KEY', 'Install Honeybadger into a new project'
       option :insights, type: :boolean, aliases: :'-i', default: false, desc: 'Enable Honeybadger Insights'
+      option :host, type: :string
+      option :ui_host, type: :string
       def install(api_key)
         Install.new(options, api_key).run
       rescue => e

data/lib/honeybadger/cli/test.rb

@@ -24,11 +24,21 @@ module Honeybadger
           @callings ||= Hash.new {|h,k| h[k] = [] }
         end
 
+        def self.events
+          @events ||= []
+        end
+
         def notify(feature, payload)
           response = @backend.notify(feature, payload)
           self.class.callings[feature] << [payload, response]
           response
         end
+
+        def event(payload)
+          response = @backend.event(payload)
+          self.class.events << [payload, response]
+          response
+        end
       end
 
       def initialize(options)

data/lib/honeybadger/config/defaults.rb

@@ -31,6 +31,12 @@ module Honeybadger
                       'Sinatra::NotFound',
                       'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
 
+    IGNORE_EVENTS_DEFAULT = [
+      { event_type: 'sql.active_record', query: /^(begin|commit)( transaction)?$/i },
+      { event_type: 'sql.active_record', query: /(solid_queue|good_job)/i },
+      { event_type: 'process_action.action_controller', controller: 'Rails::HealthController' }
+    ].freeze
+
     DEVELOPMENT_ENVIRONMENTS = ['development', 'test', 'cucumber'].map(&:freeze).freeze
 
     DEFAULT_PATHS = ['honeybadger.yml', 'config/honeybadger.yml', "#{ENV['HOME']}/honeybadger.yml"].map(&:freeze).freeze
@@ -93,7 +99,7 @@ module Honeybadger
       },
       :'events.max_queue_size' => {
         description: 'Maximum number of event for the event worker queue.',
-        default: 10000,
+        default: 100000,
         type: Integer
       },
       :'events.batch_size' => {
@@ -112,8 +118,13 @@ module Honeybadger
         type: Boolean
       },
       :'events.ignore' => {
-        description: 'A list of events to ignore. Use a string to specify exact matches, or regex for more flexibility.',
-        default: [],
+        description: 'A list of additional events to ignore. Use a hash to query nested payloads, match using a string or regex. Non-hash will match on the event_type.',
+        default: IGNORE_EVENTS_DEFAULT,
+        type: Array
+      },
+      :'events.ignore_only' => {
+        description: 'A list of events to ignore (overrides the default ignored events).',
+        default: nil,
         type: Array
       },
       plugins: {
@@ -166,6 +177,11 @@ module Honeybadger
         default: 'api.honeybadger.io'.freeze,
         type: String
       },
+      :'connection.ui_host' => {
+        description: 'The host to use when viewing data.',
+        default: 'app.honeybadger.io'.freeze,
+        type: String
+      },
       :'connection.port' => {
         description: 'The port to use when sending data.',
         default: nil,

data/lib/honeybadger/config.rb

@@ -192,10 +192,22 @@ module Honeybadger
       DEFAULTS[:'exceptions.ignore'] | Array(ignore)
     end
 
+    def raw_ignored_events
+      ignore_only = get(:'events.ignore_only')
+      return ignore_only if ignore_only
+      return DEFAULTS[:'events.ignore'] unless ignore = get(:'events.ignore')
+
+      DEFAULTS[:'events.ignore'] | Array(ignore)
+    end
+
     def ignored_events
-      self[:'events.ignore'].map do |check|
-        check.is_a?(String) ? /^#{check}$/ : check
-      end
+      @ignored_events ||= raw_ignored_events.map do |check|
+        if check.is_a?(String) || check.is_a?(Regexp)
+          { [:event_type] => check }
+        elsif check.is_a?(Hash)
+          flat_hash(check).transform_keys! { |key_array| key_array.map(&:to_sym) }
+        end
+      end.compact
     end
 
     def ca_bundle_path
@@ -455,5 +467,14 @@ module Honeybadger
         end
       end
     end
+
+    # Converts a nested hash into a single layer where keys become arrays:
+    # ex: > flat_hash({ :nested => { :hash => "value" }})
+    #     > { [:nested, :hash] => "value" }
+    def flat_hash(h,f=[],g={})
+      return g.update({ f=>h }) unless h.is_a? Hash
+      h.each { |k,r| flat_hash(r,f+[k],g) }
+      g
+    end
   end
 end

data/lib/honeybadger/event.rb

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

data/lib/honeybadger/events_worker.rb

@@ -39,13 +39,14 @@ module Honeybadger
       @pid = Process.pid
       @send_queue = []
       @last_sent = nil
+      @dropped_events = 0
     end
 
     def push(msg)
       return false unless start
 
       if queue.size >= config.events_max_queue_size
-        warn { sprintf('Unable to send event; reached max queue size of %s.', queue.size) }
+        @dropped_events += 1
         return false
       end
 
@@ -207,7 +208,12 @@ module Honeybadger
       send_now(mutex.synchronize { send_queue })
       mutex.synchronize do
         @last_sent = Time.now
+        debug { sprintf('Sending %s events', send_queue.length) }
         send_queue.clear
+        if @dropped_events > 0
+          warn { sprintf('Dropped %s messages due to exceeding max queue size of %s', @dropped_events, config.events_max_queue_size) }
+        end
+        @dropped_events = 0
       end
     end
 

data/lib/honeybadger/init/rails.rb

@@ -32,6 +32,10 @@ module Honeybadger
         config.after_initialize do
           Honeybadger.load_plugins!
         end
+
+        console do
+          Honeybadger::Agent.instance.config[:'insights.enabled'] = false unless Honeybadger::Agent.instance.config.env.has_key?(:'insights.enabled')
+        end
       end
     end
   end

data/lib/honeybadger/notification_subscriber.rb

@@ -66,7 +66,6 @@ module Honeybadger
 
     def process?(event, payload)
       return false if payload[:name] == "SCHEMA"
-      return false if payload[:sql]&.match?(/^(begin|commit)( transaction)?$/i)
       true
     end
   end
@@ -74,8 +73,10 @@ module Honeybadger
   class ActiveJobSubscriber < NotificationSubscriber
     def format_payload(payload)
       job = payload[:job]
-      payload.except(:job).merge({
-        job_class: job.class,
+      adapter = payload[:adapter]
+      payload.except(:job, :adapter).merge({
+        adapter_class: adapter.class.to_s,
+        job_class: job.class.to_s,
         job_id: job.job_id,
         queue_name: job.queue_name
       })
@@ -87,7 +88,7 @@ module Honeybadger
 
     def format_payload(payload)
       {
-        job_class: payload[:job].class,
+        job_class: payload[:job].class.to_s,
         queue_name: payload[:job].queue_name
       }
     end

data/lib/honeybadger/plugins/solid_queue.rb

@@ -2,7 +2,7 @@ module Honeybadger
   module Plugins
     module SolidQueue
       Plugin.register :solid_queue do
-        requirement { defined?(::SolidQueue) }
+        requirement { config.load_plugin_insights?(:solid_queue) && defined?(::SolidQueue) }
 
         collect do
           if config.cluster_collection?(:solid_queue)

data/lib/honeybadger/util/sanitizer.rb

@@ -1,4 +1,3 @@
-require 'bigdecimal'
 require 'set'
 
 require 'honeybadger/conversions'
@@ -21,7 +20,7 @@ module Honeybadger
       RECURSION = '[RECURSION]'.freeze
       TRUNCATED = '[TRUNCATED]'.freeze
 
-      IMMUTABLE = [NilClass, FalseClass, TrueClass, Symbol, Numeric, BigDecimal, Method].freeze
+      IMMUTABLE = [NilClass, FalseClass, TrueClass, Symbol, Numeric, Method].freeze
 
       MAX_STRING_SIZE = 65536
 

data/lib/honeybadger/version.rb

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

data/lib/honeybadger/worker.rb

@@ -226,10 +226,11 @@ module Honeybadger
       when 413
         warn { sprintf('Error report failed: Payload is too large. id=%s code=%s', msg.id, response.code) }
       when 201
+        host = config.get(:'connection.ui_host')
         if throttle = dec_throttle
-          info { sprintf('Success ⚡ https://app.honeybadger.io/notice/%s id=%s code=%s throttle=%s interval=%s', msg.id, msg.id, response.code, throttle, throttle_interval) }
+          info { sprintf('Success ⚡ https://%s/notice/%s id=%s code=%s throttle=%s interval=%s', host, msg.id, msg.id, response.code, throttle, throttle_interval) }
         else
-          info { sprintf('Success ⚡ https://app.honeybadger.io/notice/%s id=%s code=%s', msg.id, msg.id, response.code) }
+          info { sprintf('Success ⚡ https://%s/notice/%s id=%s code=%s', host, msg.id, msg.id, response.code) }
         end
       when :stubbed
         info { sprintf('Success ⚡ Development mode is enabled; this error will be reported if it occurs after you deploy your app. id=%s', msg.id) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.13.1
+  version: 5.15.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email: