feat: add request_id to notices (#619)

Closes #616

Author: stympy

lib/honeybadger/agent.rb

@@ -149,6 +149,7 @@ def notify(exception_or_opts = nil, opts = {}, **kwargs)
       opts[:rack_env] ||= context_manager.get_rack_env
       opts[:global_context] ||= context_manager.get_context
       opts[:breadcrumbs] ||= breadcrumbs.dup
+      opts[:request_id] ||= context_manager.get_request_id
 
       notice = Notice.new(config, opts)
 

lib/honeybadger/notice.rb

@@ -144,6 +144,9 @@ def tags=(tags)
     # Custom details data
     attr_accessor :details
 
+    # The ID of the request which caused this notice.
+    attr_accessor :request_id
+
     # The parsed exception backtrace. Lines in this backtrace that are from installed gems
     # have the base path for gem installs replaced by "[GEM_ROOT]", while those in the project
     # have "[PROJECT_ROOT]".
@@ -213,13 +216,14 @@ def initialize(config, opts = {})
       self.api_key = opts[:api_key] || config[:api_key]
       self.tags = construct_tags(opts[:tags]) | construct_tags(context[:tags])
 
-      self.url       = opts[:url]        || request_hash[:url]      || nil
-      self.action    = opts[:action]     || request_hash[:action]   || nil
-      self.component = opts[:controller] || opts[:component]        || request_hash[:component] || nil
-      self.params    = opts[:parameters] || opts[:params]           || request_hash[:params] || {}
-      self.session   = opts[:session]    || request_hash[:session]  || {}
-      self.cgi_data  = opts[:cgi_data]   || request_hash[:cgi_data] || {}
-      self.details   = opts[:details]    || {}
+      self.url        = opts[:url]        || request_hash[:url]      || nil
+      self.action     = opts[:action]     || request_hash[:action]   || nil
+      self.component  = opts[:controller] || opts[:component]        || request_hash[:component] || nil
+      self.params     = opts[:parameters] || opts[:params]           || request_hash[:params] || {}
+      self.session    = opts[:session]    || request_hash[:session]  || {}
+      self.cgi_data   = opts[:cgi_data]   || request_hash[:cgi_data] || {}
+      self.details    = opts[:details]    || {}
+      self.request_id = opts[:request_id] || nil
 
       self.session = opts[:session][:data] if opts[:session] && opts[:session][:data]
 
@@ -261,6 +265,9 @@ def as_json(*args)
           stats: stats,
           time: now,
           pid: pid
+        },
+        correlation_context: {
+          request_id: s(request_id)
         }
       }
     end

spec/unit/honeybadger/notice_spec.rb

@@ -93,6 +93,10 @@ def assert_array_starts_with(expected, actual)
     expect(notice.url).to eq url
   end
 
+  it "accepts a request_id" do
+    expect(build_notice(request_id: 'abc').request_id).to eq 'abc'
+  end
+
   it "sets the error class from an exception or hash" do
     assert_accepts_exception_attribute :error_class do |exception|
       exception.class.name
@@ -634,6 +638,10 @@ def exception.cause
       expect(metadata[:password]).to eq "[FILTERED]"
       expect(metadata[:deep]).to eq "[DEPTH]"
     end
+
+    it "includes the request_id" do
+      expect(build_notice(request_id: "abc").as_json[:correlation_context][:request_id]).to eq "abc"
+    end
   end
 
   describe 'public attributes' do