exception_handling 2.13.0 → 2.14.0.pre.gk.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1125ae1526cff9890e52497ac1a8b8d93a62a481afa49a74709c5f286f53b912
-  data.tar.gz: 3f882364adfb48ee837fc178cb3adcb85ab6c43b90bde5e04f96aea07559efc6
+  metadata.gz: 9443856b4b95e8a7a4447797e52afc5f7278e10574e3f42b6b761f6d914b7a8f
+  data.tar.gz: de0790fced3ccdd7e6dbcff2ecd153f7cc9619bf729adf1b6322fd486ff004b4
 SHA512:
-  metadata.gz: efbe4b3c2843a4e07daf38a83606d504714b1bfa2dedc406070fc6a1e68a66ccf379cb459f5364c0c8c8ac43b9265474ab50d9dce7f31ec78de5791ff166c195
-  data.tar.gz: 1a69645d781332b9e7882921dbaded4d001c87ead47a40902b55e385c21e419ed48d9c3790cb38c38392a0fe2c872e05d003814bcd57b54e6cb27b38c3828772
+  metadata.gz: 8fd845247940506ce0ebc30ffe35a715454926e2a4b90b9f56c39bb6386c8267b06d8da911c57ee52327451ddb10ca16c3cfe63f0aeb9088423cc7211a737736
+  data.tar.gz: 888c7ab078a79727813d58656b1bba588e7c70c9482c21cc2e8bf95bed37e3bf228787be055dda3bc05d57e9c56915dc9ee3f6aba32d539d2e5e5633d3418ebc

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.14.0] - Unreleased
+### Added
+- Added support for plumbing tags through to honeybadger via the `honeybadger_tags` log context parameter
+
 ## [2.13.0] - 2022-09-15
 ### Added
 - Added an option for removing the 'exception_handling.' prefix from metric names in ExceptionHandling::default_metric_name
@@ -99,6 +103,7 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
+[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
 [2.12.0]: https://github.com/Invoca/exception_handling/compare/v2.11.3...v2.12.0
 [2.11.3]: https://github.com/Invoca/exception_handling/compare/v2.11.2...v2.11.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_handling (2.13.0)
+    exception_handling (2.14.0.pre.gk.1)
       actionmailer (>= 5.2, < 7.0)
       actionpack (>= 5.2, < 7.0)
       activesupport (>= 5.2, < 7.0)
@@ -52,12 +52,11 @@ GEM
     byebug (11.1.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.10)
-    contextual_logger (1.0.0)
+    contextual_logger (1.1.1)
       activesupport
       json
     crass (1.0.6)
     diff-lcs (1.5.0)
-    digest (3.1.0)
     erubi (1.10.0)
     escalate (0.3.0)
     eventmachine (1.2.7)
@@ -66,9 +65,10 @@ GEM
     honeybadger (4.11.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    invoca-utils (0.4.1)
+    invoca-utils (0.5.0)
+      activesupport (>= 5.0)
     jaro_winkler (1.5.3)
-    json (2.6.2)
+    json (2.6.3)
     loofah (2.15.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -78,12 +78,10 @@ GEM
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
     minitest (5.15.0)
-    net-protocol (0.1.3)
+    net-protocol (0.2.1)
       timeout
-    net-smtp (0.3.1)
-      digest
+    net-smtp (0.3.3)
       net-protocol
-      timeout
     nokogiri (1.13.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
@@ -97,7 +95,7 @@ GEM
     pry-byebug (3.8.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    psych (3.3.3)
+    psych (3.3.4)
     racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
@@ -136,7 +134,7 @@ GEM
       power_assert
     thor (1.0.1)
     thread_safe (0.3.6)
-    timeout (0.3.0)
+    timeout (0.3.2)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)

data/lib/exception_handling/exception_info.rb

@@ -49,7 +49,7 @@ module ExceptionHandling
     HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes,
                                     :user_details, :request, :session, :environment, :backtrace, :event_response, :log_context].freeze
 
-    attr_reader :exception, :controller, :exception_context, :timestamp
+    attr_reader :exception, :controller, :exception_context, :timestamp, :honeybadger_tags
 
     def initialize(exception, exception_context, timestamp, controller: nil, data_callback: nil, log_context: nil)
       @exception = exception
@@ -59,6 +59,7 @@ module ExceptionHandling
       @data_callback = data_callback
       # merge into the surrounding context just like ContextualLogger does when logging
       @merged_log_context = ExceptionHandling.logger.current_context_for_thread.deep_merge(log_context || {})
+      @honeybadger_tags = Array(@merged_log_context[:honeybadger_tags] || [])
     end
 
     def data

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.13.0'
+  VERSION = '2.14.0.pre.gk.1'
 end

data/lib/exception_handling.rb

@@ -270,11 +270,15 @@ 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(' ')
       response = Honeybadger.notify(error_class: exception_description ? exception_description.filter_name : exception.class.name,
                                     error_message: exception.message.to_s,
                                     exception:     exception,
                                     context:       exception_info.honeybadger_context_data,
-                                    controller:    exception_info.controller_name)
+                                    controller:    exception_info.controller_name,
+                                    tags:          tags)
       response ? :success : :failure
     rescue Exception => ex
       warn("ExceptionHandling.send_exception_to_honeybadger rescued exception while logging #{exception_info.exception_context}:\n#{exception.class}: #{exception.message}:\n#{ex.class}: #{ex.message}\n#{ex.backtrace.join("\n")}")

data/spec/unit/exception_handling/exception_info_spec.rb

@@ -44,6 +44,23 @@ module ExceptionHandling
           expect(exception_info.controller).to be_nil
         end
       end
+
+      context "honeybadger_tags" do
+        it "retrieved from log_context" do
+          exception_info = ExceptionInfo.new(@exception, "string context", @timestamp, log_context: { honeybadger_tags: ['Data-Services'] })
+          expect(exception_info.honeybadger_tags).to eq(['Data-Services'])
+        end
+
+        it "retrieved from log_context and normalized to array if a string" do
+          exception_info = ExceptionInfo.new(@exception, "string context", @timestamp, log_context: { honeybadger_tags: 'Data-Services' })
+          expect(exception_info.honeybadger_tags).to eq(['Data-Services'])
+        end
+
+        it "defaults to empty array if not given" do
+          exception_info = ExceptionInfo.new(@exception, "string context", @timestamp)
+          expect(exception_info.honeybadger_tags).to eq([])
+        end
+      end
     end
 
     context "data" do

data/spec/unit/exception_handling/sensu_spec.rb

@@ -6,7 +6,7 @@ module ExceptionHandling
   describe Sensu do
     context "#generate_event" do
       it "create an event" do
-        expect(ExceptionHandling::Sensu).to receive(:send_event).with(name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1)
+        expect(ExceptionHandling::Sensu).to receive(:send_event).with({ name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 })
 
         ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
       end
@@ -14,13 +14,13 @@ module ExceptionHandling
       it "add the sensu prefix" do
         ExceptionHandling.sensu_prefix = "cnn_"
 
-        expect(ExceptionHandling::Sensu).to receive(:send_event).with(name: "cnn_world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1)
+        expect(ExceptionHandling::Sensu).to receive(:send_event).with({ name: "cnn_world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 })
 
         ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
       end
 
       it "allow the level to be set to critical" do
-        expect(ExceptionHandling::Sensu).to receive(:send_event).with(name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 2)
+        expect(ExceptionHandling::Sensu).to receive(:send_event).with({ name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 2 })
 
         ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :critical)
       end

data/spec/unit/exception_handling_spec.rb

@@ -158,12 +158,8 @@ describe ExceptionHandling do
 
     context "#log_warning" do
       it "have empty array as a backtrace" do
-        expected_args = if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
-                          [ExceptionHandling::Warning, anything]
-                        else
-                          [ExceptionHandling::Warning]
-                        end
-        expect(ExceptionHandling).to receive(:log_error).with(*expected_args) do |error|
+        expect(ExceptionHandling).to receive(:log_error) do |error|
+          expect(error.class).to eq(ExceptionHandling::Warning)
           expect(error.backtrace).to eq([])
         end
         ExceptionHandling.log_warning('Now with empty array as a backtrace!')
@@ -727,7 +723,7 @@ describe ExceptionHandling do
               expect(Honeybadger).to receive(:notify).with(any_args) do |data|
                 honeybadger_data = data
               end
-              ExceptionHandling.logger.global_context = { service_name: "rails", region: "AWS-us-east-1" }
+              ExceptionHandling.logger.global_context = { service_name: "rails", region: "AWS-us-east-1", honeybadger_tags: ['Data-Services', 'web'] }
               log_context = { log_source: "gem/listen", service_name: "bin/console" }
               ExceptionHandling.log_error(@exception, @exception_context, @controller, **log_context) do |data|
                 data[:scm_revision] = "5b24eac37aaa91f5784901e9aabcead36fd9df82"
@@ -741,6 +737,7 @@ describe ExceptionHandling do
                 error_message: "Some Exception",
                 controller: "some_controller",
                 exception: @exception,
+                tags: "Data-Services web",
                 context: {
                   timestamp: Time.now.to_i,
                   error_class: "StandardError",
@@ -766,7 +763,7 @@ describe ExceptionHandling do
                     "spec/unit/exception_handling_spec.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
                   ],
                   event_response: "Event successfully received",
-                  log_context: { "service_name" => "bin/console", "region" => "AWS-us-east-1", "log_source" => "gem/listen" }
+                  log_context: { "service_name" => "bin/console", "region" => "AWS-us-east-1", "log_source" => "gem/listen", "honeybadger_tags" => ['Data-Services', 'web'] }
                 }
               }
               expect(honeybadger_data).to eq(expected_data)
@@ -791,6 +788,7 @@ describe ExceptionHandling do
                 error_message: "Some Exception",
                 controller: "some_controller",
                 exception: @exception,
+                tags: "",
                 context: {
                   timestamp: Time.now.to_i,
                   error_class: "StandardError",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0.pre.gk.1
 platform: ruby
 authors:
 - Invoca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -222,9 +222,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: