exception_handling 3.0.1 → 3.1.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a29a9092ff7f9301ec3b6bbf825a7d25bc5279fbec1a984c13e90afa95b9200b
-  data.tar.gz: 69b933ecd257feddbfe6f4a74deb8548d263eab94f9e768aa0a93a939d493dee
+  metadata.gz: 31594865f3096183f28bd10c1310bbca3df0170b97b09f51dd1231f02736e50f
+  data.tar.gz: 0b638eff8f75896da524b9c1ced003e72e95b5576c0dcba7db0e1e2c8f80b5e8
 SHA512:
-  metadata.gz: c966ab01531b3a51698a0247b8f80e703d7b77416b818b112f47024645b61f140f2c0abad685bb5188811f6a8f1862b3db8c8d1cf2bf5d568ee698b7c171b117
-  data.tar.gz: 042cc68f1c5ee3bba682cc9362f096f7979520e2ba60763a7628de2d9ff9fcbbc38bde0b73b6450bd949bb945b57844e352e306ffc7d425cee45e10282b85f20
+  metadata.gz: 5300573e63bd5d9039676ab35b4299812d0a870f60eb63b6039546df8eecdc92d30931537e96a4105295968b87183746d46abeaaa67cdd47d94bd347d8b7631b
+  data.tar.gz: 444bde3024de65b88ea660392c22dd624298c362e96a2af8ad4a94fd3f6513d7ed6f32709cdc9244cd8532410529cd0b923f9cb4086e7faf2e2c11a571116bf0

data/CHANGELOG.md

@@ -4,9 +4,13 @@ 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).
 
-## [3.0.1] - 2024-03-07
+## [3.1.0] - Unreleased
+### Added
+- Add interface for tagging exceptions sent to honeybadger with values from the log context.
+  - `ExceptionHandling.add_honeybadger_tag_from_log_context`
+
 ### Changed
-- Allow newer versions of the `psych` gem to be used to avoid conflicts with the default version pulled in by ruby 3.2+
+- Require ruby version 2.7 or greater
 
 ## [3.0.0] - 2024-03-01
 ### Added

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 
 gem 'activesupport'
 gem 'appraisal', '~> 2.2'
+gem 'gem-release'
 gem 'honeybadger', '~> 4.11'
 gem 'pry'
 gem 'pry-byebug'

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    exception_handling (3.0.1)
+    exception_handling (3.1.0.pre.2)
       activesupport (>= 5.2)
       contextual_logger (~> 1.0)
       escalate (~> 0.3)
       invoca-utils (~> 0.3)
-      psych (>= 3.2)
+      psych (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    appraisal (2.2.0)
+    appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
@@ -30,17 +30,17 @@ GEM
       json
     diff-lcs (1.5.0)
     escalate (0.3.0)
+    gem-release (2.2.2)
     honeybadger (4.11.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.5.1)
       activesupport (>= 5.0)
-    jaro_winkler (1.5.3)
     json (2.7.1)
     method_source (1.0.0)
     minitest (5.15.0)
     parallel (1.17.0)
-    parser (2.6.3.0)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     power_assert (1.2.0)
     pry (0.14.2)
@@ -49,15 +49,16 @@ GEM
     pry-byebug (3.8.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    psych (5.1.2)
-      stringio
+    psych (3.3.4)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     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-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -66,18 +67,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
-    rspec_junit_formatter (0.4.1)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.89.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    stringio (3.1.0)
-    test-unit (3.3.6)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.13.0)
+    test-unit (3.6.1)
       power_assert
     thor (1.0.1)
     thread_safe (0.3.6)
@@ -93,6 +97,7 @@ DEPENDENCIES
   activesupport
   appraisal (~> 2.2)
   exception_handling!
+  gem-release
   honeybadger (~> 4.11)
   pry
   pry-byebug

data/README.md

@@ -36,6 +36,7 @@ ExceptionHandling.logger                  = Rails.logger
 ExceptionHandling.filter_list_filename    = "#{Rails.root}/config/exception_filters.yml"
 ExceptionHandling.environment             = Rails.env
 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
@@ -72,7 +73,7 @@ log_error(ex, "A specific error occurred.", honeybadger_tags: ["critical", "sequ
 
 **Note**: Manual tags will be merged with any automatic tags.
 
-#### Automatically Tagging Exceptions (`honeybadger_auto_tagger=`)
+#### Automatically Tagging Exceptions via Proc (`honeybadger_auto_tagger=`)
 
 Configure exception handling so that you can automatically apply multiple tags to exceptions sent to honeybadger.
 
@@ -90,6 +91,34 @@ Example to disable auto-tagging:
 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

@@ -19,10 +19,11 @@ Gem::Specification.new do |spec|
     "source_code_uri"   => "https://github.com/Invoca/exception_handling",
     "allowed_push_host" => "https://rubygems.org"
   }
+  spec.required_ruby_version = '>= 2.7'
 
   spec.add_dependency 'activesupport',     '>= 5.2'
   spec.add_dependency 'contextual_logger', '~> 1.0'
   spec.add_dependency 'escalate',          '~> 0.3'
   spec.add_dependency 'invoca-utils',      '~> 0.3'
-  spec.add_dependency 'psych',             '>= 3.2'
+  spec.add_dependency 'psych',             '~> 3.0'
 end

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '3.0.1'
+  VERSION = '3.1.0.pre.2'
 end

data/lib/exception_handling.rb

@@ -28,6 +28,8 @@ module ExceptionHandling # never included
   AUTHENTICATION_HEADERS = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION', 'REDIRECT_X_HTTP_AUTHORIZATION'].freeze
   HONEYBADGER_STATUSES   = [:success, :failure, :skipped].freeze
 
+  @honeybadger_log_context_tags = {}
+
   class << self
 
     #
@@ -78,6 +80,7 @@ module ExceptionHandling # never included
 
     attr_reader :filter_list_filename
     attr_reader :honeybadger_auto_tagger
+    attr_reader :honeybadger_log_context_tags
 
     @filter_list_filename = "./config/exception_filters.yml"
 
@@ -98,6 +101,21 @@ module ExceptionHandling # never included
     end
     # rubocop:enable Style/TrivialAccessors
 
+    # @param tag_name [String]
+    # @param path [Array<String>]
+    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) && path.all? { _1.is_a?(String) }) or raise ArgumentError, "path must be an Array<String>, #{path.inspect}"
+      if @honeybadger_log_context_tags.key?(tag_name)
+        log_warning("Overwriting existing tag path for #{tag_name.inspect} 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 = {}
+    end
+
     #
     # internal settings (don't set directly)
     #
@@ -217,7 +235,7 @@ module ExceptionHandling # never included
 
       # 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 = (honeybadger_auto_tags(exception) + 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,
@@ -231,18 +249,6 @@ module ExceptionHandling # never included
       :failure
     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
-
     #
     # Check if Honeybadger defined.
     #
@@ -346,6 +352,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,9 +107,10 @@ describe ExceptionHandling do
   class SmtpClientErrbackStub < SmtpClientStub
   end
 
-  before(:each) do
+  before 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
@@ -1029,6 +1030,117 @@ describe ExceptionHandling do
         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 path doesn't contain only strings" do
+        let(:path) { [:sample, :path] }
+
+        it "raises an argument error" do
+          expect { add_hb_tag }.to raise_error(ArgumentError, /path must be an Array<String>/)
+        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 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 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 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
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0.pre.2
 platform: ruby
 authors:
 - Invoca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,16 +70,16 @@ dependencies:
   name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
 description: Exception handling logger
 email:
 - development@invoca.com
@@ -139,12 +139,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: