exception_handling 2.15.0 → 2.17.0.pre.tstarck.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14ca7f66e702ec2ae46aa9f7b7669cd8f8136b9305c0683b76339faafc87558a
-  data.tar.gz: db7863d32347f5f859971222f2b215b0f84a8c7604eb0326cfd9b656910cd9ff
+  metadata.gz: 4074e67f0ede6cb73665a058c3cd09b02e7518e0fb4d0860d0ce4378aa4023b6
+  data.tar.gz: e2d3726622a44753b679de1f645d3bbf40780c8d8829f46e7803661a7f583100
 SHA512:
-  metadata.gz: 3274bf4d7f67fb83aa2d71633572d19c14c99e3c40746de20e20efea1ff570a0d49f5163efd74c60ce0167af3495ad259d2950bc198c28a219ff6b30dadf551b
-  data.tar.gz: 858ce36039ecfbd5a79a22c0a56f9accff534e7b7e27e288509ffd9d34feca3ccd0983a092f6d536e554dce8d4312cb877df5f3a6729305aed8828ed0fe36d8a
+  metadata.gz: aa6b1574ba37ac1aee58bfb3bbfc9c15a083d255fa031c1b61dc205dad06c7a1bbee62c6fc6a1e5d24d341f88fa01806cef133cba8beb9f1ad34f0278dbe2848
+  data.tar.gz: e1f4e2e4dc2ff78d948a31eabc2091d7c853f117f2f03c300ee90b4d2b362d59dfe89590d5ae3f8b2949d40e40a09d60ed418786c4dbee9180fb188b590296b9

data/.github/workflows/pipeline.yml

@@ -8,25 +8,21 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', 3.1]
+        ruby: [2.7, '3.0', 3.1, 3.2, 3.3]
         gemfile:
         - Gemfile
         - gemfiles/rails_5.gemfile
         - gemfiles/rails_6.gemfile
         - gemfiles/rails_7.gemfile
         exclude:
-        - gemfile: Gemfile
-          ruby: 2.5
-        - gemfile: gemfiles/rails_7.gemfile
-          ruby: 2.5
-        - gemfile: Gemfile
-          ruby: 2.6
-        - gemfile: gemfiles/rails_7.gemfile
-          ruby: 2.6
         - gemfile: gemfiles/rails_5.gemfile
           ruby: '3.0'
         - gemfile: gemfiles/rails_5.gemfile
           ruby: 3.1
+        - gemfile: gemfiles/rails_5.gemfile
+          ruby: 3.2
+        - gemfile: gemfiles/rails_5.gemfile
+          ruby: 3.3
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     steps:
@@ -34,7 +30,7 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-        bundler: 2.2.29
+        bundler: 2.3.26
         bundler-cache: true
     - name: Unit tests
       run: bundle exec rspec

data/CHANGELOG.md

@@ -4,6 +4,23 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 **Note:** this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.17.0] - Unreleased
+### Added
+- Add interface for tagging exceptions sent to honeybadger with values from the log context.
+  - `ExceptionHandling.add_honeybadger_tag_from_log_context`
+- Added Ruby 3.2 and 3.3 to the CI test matrix
+
+### Changed
+- Require ruby version 2.7 or greater
+
+### Removed
+- Removed Ruby versions 2.5 and 2.6 from the CI test matrix.
+
+
+## [2.16.0] - 2023-05-01
+### Added
+- Add interface for automatically adding honeybadger tags `ExceptionHandling.honeybadger_auto_tagger=`
+
 ## [2.15.0] - 2023-03-07
 ### Added
 - Added support for ActionMailer 7.x
@@ -109,6 +126,7 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
+[2.16.0]: https://github.com/Invoca/exception_handling/compare/v2.15.0...v2.16.0
 [2.15.0]: https://github.com/Invoca/exception_handling/compare/v2.14.0...v2.15.0
 [2.14.0]: https://github.com/Invoca/exception_handling/compare/v2.13.0...v2.14.0
 [2.13.0]: https://github.com/Invoca/exception_handling/compare/v2.12.0...v2.13.0

data/Gemfile

@@ -4,6 +4,9 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'actionmailer', '~> 6.0'
+gem 'actionpack', '~> 6.0'
+gem 'activesupport', '~> 6.0'
 gem 'appraisal', '~> 2.2'
 gem 'honeybadger', '~> 4.11'
 gem 'pry'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_handling (2.15.0)
+    exception_handling (2.17.0.pre.tstarck.1)
       actionmailer (>= 5.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
@@ -15,135 +15,158 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.4.7)
-      actionpack (= 6.0.4.7)
-      actionview (= 6.0.4.7)
-      activejob (= 6.0.4.7)
+    actionmailer (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      actionview (= 6.1.7.6)
+      activejob (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.4.7)
-      actionview (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.7.6)
+      actionview (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.4.7)
-      activesupport (= 6.0.4.7)
+    actionview (6.1.7.6)
+      activesupport (= 6.1.7.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.4.7)
-      activesupport (= 6.0.4.7)
+    activejob (6.1.7.6)
+      activesupport (= 6.1.7.6)
       globalid (>= 0.3.6)
-    activesupport (6.0.4.7)
+    activesupport (6.1.7.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    appraisal (2.2.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
-    ast (2.4.0)
+    ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.10)
-    contextual_logger (1.1.1)
-      activesupport
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    contextual_logger (1.3.0)
+      activesupport (< 7.1)
       json
     crass (1.0.6)
-    diff-lcs (1.5.0)
-    erubi (1.10.0)
+    date (3.3.4)
+    diff-lcs (1.5.1)
+    erubi (1.12.0)
     escalate (0.3.0)
     eventmachine (1.2.7)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    honeybadger (4.11.0)
-    i18n (1.10.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    honeybadger (4.12.2)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.5.1)
       activesupport (>= 5.0)
-    jaro_winkler (1.5.3)
-    json (2.6.3)
-    loofah (2.15.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.2)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.15.0)
-    net-protocol (0.2.1)
+      net-imap
+      net-pop
+      net-smtp
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.22.2)
+    net-imap (0.4.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
       timeout
-    net-smtp (0.3.3)
+    net-smtp (0.4.0.1)
       net-protocol
-    nokogiri (1.13.3)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.5)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    power_assert (1.2.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.8.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    power_assert (2.0.3)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.10)
+      pry (>= 0.13, < 0.15)
     psych (3.3.4)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    test-unit (3.3.6)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    test-unit (3.6.1)
       power_assert
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    timeout (0.3.2)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.5.4)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionmailer (~> 6.0)
+  actionpack (~> 6.0)
+  activesupport (~> 6.0)
   appraisal (~> 2.2)
   exception_handling!
   honeybadger (~> 4.11)
@@ -156,4 +179,4 @@ DEPENDENCIES
   test-unit
 
 BUNDLED WITH
-   2.2.29
+   2.3.22

data/README.md

@@ -25,24 +25,27 @@ Or install it yourself as:
 Add some code to initialize the settings in your application.
 For example:
 
-    require "exception_handling"
-
-    # required
-    ExceptionHandling.server_name             = Cluster['server_name']
-    ExceptionHandling.sender_address          = %("Exceptions" <exceptions@example.com>)
-    ExceptionHandling.exception_recipients    = ['exceptions@example.com']
-    ExceptionHandling.logger                  = Rails.logger
-
-    # optional
-    ExceptionHandling.escalation_recipients   = ['escalation@example.com']
-    ExceptionHandling.filter_list_filename    = "#{Rails.root}/config/exception_filters.yml"
-    ExceptionHandling.email_environment       = Rails.env
-    ExceptionHandling.eventmachine_safe       = false
-    ExceptionHandling.eventmachine_synchrony  = false
-    ExceptionHandling.sensu_host              = "127.0.0.1"
-    ExceptionHandling.sensu_port              = 3030
-    ExceptionHandling.sensu_prefix            = ""
-
+```ruby
+require "exception_handling"
+
+# required
+ExceptionHandling.server_name             = Cluster['server_name']
+ExceptionHandling.sender_address          = %("Exceptions" <exceptions@example.com>)
+ExceptionHandling.exception_recipients    = ['exceptions@example.com']
+ExceptionHandling.logger                  = Rails.logger
+
+# optional
+ExceptionHandling.escalation_recipients   = ['escalation@example.com']
+ExceptionHandling.filter_list_filename    = "#{Rails.root}/config/exception_filters.yml"
+ExceptionHandling.email_environment       = Rails.env
+ExceptionHandling.eventmachine_safe       = false
+ExceptionHandling.eventmachine_synchrony  = false
+ExceptionHandling.sensu_host              = "127.0.0.1"
+ExceptionHandling.sensu_port              = 3030
+ExceptionHandling.sensu_prefix            = ""
+ExceptionHandling.honeybadger_auto_tagger = ->(exception) { [] } # See "Automatically Tagging Exceptions" section below for examples
+ExceptionHandling.add_honeybadger_tag_from_log_context("tag-name", path: ["path", "in", "log", "context"])
+```
 
 ## Usage
 
@@ -62,6 +65,68 @@ Then call any method available in the `ExceptionHandling::Methods` mixin:
       flash.now['error'] = "A specific error occurred. Support has been notified."
     end
 
+### Tagging Exceptions in Honeybadger
+
+⚠️ Honeybadger differentiates tags by spaces and/or commas, so you should **not** include spaces or commas in your tags.
+
+⚠️ Tags are case-sensitive.
+
+#### Manually Tagging Exceptions
+
+Add `:honeybadger_tags` to your `log_context` usage with an array of strings.
+
+```ruby
+log_error(ex, "A specific error occurred.", honeybadger_tags: ["critical", "sequoia"])
+```
+
+**Note**: Manual tags will be merged with any automatic tags.
+
+#### Automatically Tagging Exceptions via Proc (`honeybadger_auto_tagger=`)
+
+Configure exception handling so that you can automatically apply multiple tags to exceptions sent to honeybadger.
+
+The Proc must accept an `exception` argument that will be the exception in question and must always return an array of strings (the array can be empty).
+
+Example to enable auto-tagging:
+```ruby
+ExceptionHandling.honeybadger_auto_tagger = ->(exception) do
+  exception.message.match?(/fire/) ? ["high-urgency", "danger"] : ["low-urgency"]
+end
+```
+
+Example to disable auto-tagging:
+```ruby
+ExceptionHandling.honeybadger_auto_tagger = nil
+```
+
+#### Automatically Tagging Exceptions from Log Context (`add_honeybadger_tag_from_log_context`)
+
+Add a tag to exceptions sent to honeybadger based on a value in the log context.
+
+To configure this, use the `add_honeybadger_tag_from_log_context` method.
+```ruby
+ExceptionHandling.add_honeybadger_tag_from_log_context("kubernetes_context", path: ["kubernetes", "context"])
+```
+
+This will add a tag to the exception if the log context contains a value at the specified path: "kubernetes" => { "context" => "value" }.
+
+For example:
+```ruby
+ExceptionHandling.logger.with_context("kubernetes" => { "context" => "local" }) do
+  log_error(ex, "A specific error occurred.")
+end
+```
+
+This will add the following tag to the exception sent to honeybadger:
+```
+kubernetes_context:local
+```
+
+To clear all automated tagging from the log context, use the `clear_honeybadger_tags_from_log_context` method.
+```ruby
+ExceptionHandling.clear_honeybadger_tags_from_log_context
+```
+
 ## Custom Hooks
 
 ### custom_data_hook

data/exception_handling.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
     "allowed_push_host" => "https://rubygems.org"
   }
 
+  spec.required_ruby_version = '>= 2.7.0'
+
   spec.add_dependency 'actionmailer',      '>= 5.2'
   spec.add_dependency 'actionpack',        '>= 5.2'
   spec.add_dependency 'activesupport',     '>= 5.2'

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.15.0'
+  VERSION = '2.17.0.pre.tstarck.1'
 end

data/lib/exception_handling.rb

@@ -110,10 +110,12 @@ module ExceptionHandling # never included
     attr_accessor :sensu_host
     attr_accessor :sensu_port
     attr_accessor :sensu_prefix
+    attr_reader   :honeybadger_log_context_tags
 
     attr_reader :filter_list_filename
     attr_reader :eventmachine_safe
     attr_reader :eventmachine_synchrony
+    attr_reader :honeybadger_auto_tagger
 
     @filter_list_filename = "./config/exception_filters.yml"
     @email_environment = ""
@@ -154,6 +156,30 @@ module ExceptionHandling # never included
       @exception_catalog ||= ExceptionCatalog.new(@filter_list_filename)
     end
 
+    # rubocop:disable Style/TrivialAccessors
+    # @param value [Proc|nil] Proc that accepts 1 parameter that will be the exception object or nil to disable the auto-tagger.
+    #                         The proc is always expected to return an array of strings. The array can be empty.
+    def honeybadger_auto_tagger=(value)
+      @honeybadger_auto_tagger = value
+    end
+    # rubocop:enable Style/TrivialAccessors
+
+    # @param tag_name [String]
+    # @param path [Array]
+    def add_honeybadger_tag_from_log_context(tag_name, path:)
+      tag_name.is_a?(String) or raise ArgumentError, "tag_name must be a String, #{tag_name.inspect}"
+      path.is_a?(Array) or raise ArgumentError, "path must be an Array, #{path.inspect}"
+      @honeybadger_log_context_tags ||= {}
+      if @honeybadger_log_context_tags.key?(tag_name)
+        log_warning("Overwriting existing tag path for '#{tag_name}' from #{@honeybadger_log_context_tags[tag_name]} to #{path}")
+      end
+      @honeybadger_log_context_tags[tag_name] = path
+    end
+
+    def clear_honeybadger_tags_from_log_context
+      @honeybadger_log_context_tags = nil
+    end
+
     #
     # internal settings (don't set directly)
     #
@@ -270,9 +296,10 @@ module ExceptionHandling # never included
     def send_exception_to_honeybadger(exception_info)
       exception             = exception_info.exception
       exception_description = exception_info.exception_description
+
       # Note: Both commas and spaces are treated as delimiters for the :tags string. Space-delimiters are not officially documented.
       # https://github.com/honeybadger-io/honeybadger-ruby/pull/422
-      tags = exception_info.honeybadger_tags.join(' ')
+      tags = tags_for_honeybadger(exception_info).join(' ')
       response = Honeybadger.notify(error_class: exception_description ? exception_description.filter_name : exception.class.name,
                                     error_message: exception.message.to_s,
                                     exception:     exception,
@@ -434,6 +461,41 @@ module ExceptionHandling # never included
 
     private
 
+    # @param exception_info [ExceptionInfo]
+    #
+    # @return [Array<String>]
+    def tags_for_honeybadger(exception_info)
+      (
+        honeybadger_auto_tags(exception_info.exception) +
+        exception_info.honeybadger_tags +
+        honeybadger_tags_from_log_context(exception_info.honeybadger_context_data)
+      ).uniq
+    end
+
+    # @param exception [Exception]
+    #
+    # @return [Array<String>]
+    def honeybadger_auto_tags(exception)
+      @honeybadger_auto_tagger&.call(exception) || []
+    rescue => ex
+      traces = ex.backtrace.join("\n")
+      message = "Unable to execute honeybadger_auto_tags callback. #{ExceptionHandling.encode_utf8(ex.message.to_s)} #{traces}\n"
+      ExceptionHandling.log_info(message)
+      []
+    end
+
+    def honeybadger_tags_from_log_context(honeybadger_context_data)
+      if @honeybadger_log_context_tags
+        @honeybadger_log_context_tags.map do |tag_name, tag_path|
+          if (value_from_log_context = honeybadger_context_data.dig(:log_context, *tag_path))
+            "#{tag_name}:#{value_from_log_context}"
+          end
+        end.compact
+      else
+        []
+      end
+    end
+
     def execute_custom_log_error_callback(exception_data, exception, treat_like_warning, external_notification_results)
       if ExceptionHandling.post_log_error_hook
         honeybadger_status = external_notification_results[:honeybadger_status] || :skipped

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'rspec/mocks'
 require 'rspec_junit_formatter'
 
 require 'pry'
+require 'pry-byebug'
 require 'honeybadger'
 require 'contextual_logger'
 
@@ -22,20 +23,28 @@ class LoggerStub
     clear
   end
 
-  def debug(message, log_context = {})
-    logged << { message: message, context: log_context, severity: 'DEBUG' }
+  def debug(message, **log_context)
+    super.tap do
+      logged << { message: message, context: log_context, severity: 'DEBUG' }
+    end
   end
 
-  def info(message, log_context = {})
-    logged << { message: message, context: log_context, severity: 'INFO' }
+  def info(message, **log_context)
+    super.tap do
+      logged << { message: message, context: log_context, severity: 'INFO' }
+    end
   end
 
-  def warn(message, log_context = {})
-    logged << { message: message, context: log_context, severity: 'WARN' }
+  def warn(message, **log_context)
+    super.tap do
+      logged << { message: message, context: log_context, severity: 'WARN' }
+    end
   end
 
-  def fatal(message, log_context = {})
-    logged << { message: message, context: log_context, severity: 'FATAL' }
+  def fatal(message, **log_context)
+    super.tap do
+      logged << { message: message, context: log_context, severity: 'FATAL' }
+    end
   end
 
   def clear

data/spec/unit/exception_handling_spec.rb

@@ -107,6 +107,12 @@ describe ExceptionHandling do
   class SmtpClientErrbackStub < SmtpClientStub
   end
 
+  before(:each) do
+    # Reset this for every test since they are applied to the class
+    ExceptionHandling.honeybadger_auto_tagger = nil
+    ExceptionHandling.clear_honeybadger_tags_from_log_context
+  end
+
   context "with warn and honeybadger notify stubbed" do
     before do
       allow(ExceptionHandling).to receive(:warn).with(any_args)
@@ -149,6 +155,14 @@ describe ExceptionHandling do
           expect(service_name: 'exception_handling').to eq(logged_excluding_reload_filter.last[:context])
         end
 
+        it "passes :honeybadger_tags in log context to honeybadger" do
+          expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "  , awesome  ,  totallytubular,  " }))
+          ExceptionHandling.log_error('This is an Error', 'This is the prefix context', honeybadger_tags: '  , awesome  ,  totallytubular,  ')
+
+          expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "    cool  neat" }))
+          ExceptionHandling.log_error('This is an Error', 'This is the prefix context', honeybadger_tags: ["  ", " cool ", "neat"])
+        end
+
         it "logs with Severity::FATAL" do
           ExceptionHandling.log_error('This is a Warning', service_name: 'exception_handling')
           expect('FATAL').to eq(logged_excluding_reload_filter.last[:severity])
@@ -1245,6 +1259,156 @@ describe ExceptionHandling do
         expect(logged_excluding_reload_filter.size).to eq(3)
       end
     end
+
+    context "#honeybadger_auto_tagger=" do
+      context "with proc that runs successfully" do
+        before do
+          ExceptionHandling.honeybadger_auto_tagger =
+            ->(exception) do
+              if exception.message =~ /donuts/
+                ['donut-error', 'high-urgency']
+              else
+                ['low-urgency']
+              end
+            end
+        end
+
+        context "without manually passed tags" do
+          let(:exception) { StandardError.new("We are out of chocolate milk") }
+
+          it "adds tags from autotagger" do
+            expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "low-urgency" }))
+            ExceptionHandling.log_error(exception, nil)
+          end
+        end
+
+        context "with manually passed tags" do
+          let(:exception) { StandardError.new("The donuts are burning") }
+
+          it "merges tags from autotagger with manually passed tags" do
+            expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "donut-error high-urgency upset-customers" }))
+            ExceptionHandling.log_error(exception, nil, honeybadger_tags: ["upset-customers"])
+          end
+        end
+      end
+    end
+
+    context "with proc that raises an exception" do
+      let(:exception) { StandardError.new("Something else occurred") }
+
+      before do
+        ExceptionHandling.honeybadger_auto_tagger = ->(_exception) { raise StandardError, "boom" }
+      end
+
+      it "logs a message and returns [] for the tags" do
+        expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "some-other-tag" }))
+        expect(ExceptionHandling).to receive(:log_info).with(/Unable to execute honeybadger_auto_tags callback. boom/)
+        ExceptionHandling.log_error(exception, nil, honeybadger_tags: ["some-other-tag"])
+      end
+    end
+
+    describe "#add_honeybadger_tag_from_log_context" do
+      subject(:add_hb_tag) { ExceptionHandling.add_honeybadger_tag_from_log_context(tag_name, path: path) }
+      let(:tag_name) { "sample-tag" }
+      let(:path) { ["sample", "path"] }
+
+      it "sets the honeybadger log context tags to the tag name and path" do
+        add_hb_tag
+        expect(ExceptionHandling.honeybadger_log_context_tags).to include("sample-tag" => ["sample", "path"])
+      end
+
+      context "when path is not an array" do
+        let(:path) { "not an array" }
+
+        it "raises an argument error" do
+          expect { add_hb_tag }.to raise_error(ArgumentError, /path must be an Array/)
+        end
+      end
+
+      context "when tag_name is not a string" do
+        let(:tag_name) { 1 }
+
+        it "raises an argument error" do
+          expect { add_hb_tag }.to raise_error(ArgumentError, /tag_name must be a String/)
+        end
+      end
+
+      context "when there already exists a tag with the same name" do
+        before(:each) do
+          ExceptionHandling.add_honeybadger_tag_from_log_context(tag_name, path: ["other", "path"])
+        end
+
+        it "overwrites the existing tag to the new one" do
+          add_hb_tag
+          expect(ExceptionHandling.honeybadger_log_context_tags).to include("sample-tag" => ["sample", "path"])
+        end
+
+        it "logs a warning" do
+          expect(ExceptionHandling.logger).to receive(:warn).with(/Overwriting existing tag path for 'sample-tag'/, **{})
+          add_hb_tag
+        end
+      end
+    end
+
+    describe "honey badger tags" do
+      context "with log context tags" do
+        before(:each) do
+          ExceptionHandling.add_honeybadger_tag_from_log_context("kubernetes_context", path: ["kubernetes", "context"])
+        end
+
+        context "when error is logged within a log context that matches the path" do
+          it "notifies honeybadger with the tags from the log context" do
+            ExceptionHandling.logger.with_context("kubernetes" => { "context" => "local" }) do
+              expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "kubernetes_context:local" }))
+              ExceptionHandling.log_error(StandardError.new("Error"), nil)
+            end
+          end
+        end
+
+        context "when error is logged within a log context that doesn't match the path" do
+          it "does not specify any tags in the honeybadger notify" do
+            ExceptionHandling.logger.with_context("kubernetes" => { "pod" => "frontend-abc" }) do
+              expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "" }))
+              ExceptionHandling.log_error(StandardError.new("Error"), nil)
+            end
+          end
+        end
+
+        context "when error is logged outside of a log context block" do
+          it "does not specify any tags in the honeybadger notify" do
+            expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "" }))
+            ExceptionHandling.log_error(StandardError.new("Error"), nil)
+          end
+        end
+      end
+
+      context "with all different honeybadger tagging" do
+        subject(:log_error) { ExceptionHandling.log_error(StandardError.new("Error"), nil, honeybadger_tags: inline_tags) }
+        let(:inline_tags) { ["inline-tag"] }
+        before(:each) do
+          ExceptionHandling.honeybadger_auto_tagger = ->(_exception) { ["auto-tag"] }
+          ExceptionHandling.add_honeybadger_tag_from_log_context("log-context", path: ["inside", "context"])
+        end
+
+        it "combines all the tags from different sources" do
+          expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "auto-tag inline-tag log-context:tag" }))
+          ExceptionHandling.logger.with_context("inside" => { "context" => "tag" }) do
+            log_error
+          end
+        end
+
+        context "when there are duplicate tags" do
+          let(:inline_tags) { ["auto-tag"] }
+
+          it "notifies honeybadger with the set of tags" do
+            expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "auto-tag log-context:tag" }))
+            ExceptionHandling.logger.with_context("inside" => { "context" => "tag" }) do
+              log_error
+            end
+          end
+        end
+      end
+    end
   end
 
   context "ExceptionHandling < 3.0 " do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.17.0.pre.tstarck.1
 platform: ruby
 authors:
 - Invoca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -204,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.