Merge branch 'bvl-add-corrilation-id-to-all-exception' into 'master'

Add correlation id to all sentry errors

Closes #61699

See merge request gitlab-org/gitlab-ce!28253

3 files changed, 15 insertions, 10 deletions

diff --git a/lib/gitlab/sentry.rb b/lib/gitlab/sentry.rb
index 356e6445e0e..72c44114001 100644
--- a/lib/gitlab/sentry.rb
+++ b/lib/gitlab/sentry.rb
@@ -10,7 +10,7 @@ module Gitlab
     def self.context(current_user = nil)
       return unless enabled?
 
-      Raven.tags_context(locale: I18n.locale)
+      Raven.tags_context(default_tags)
 
       if current_user
         Raven.user_context(
@@ -44,16 +44,19 @@ module Gitlab
         extra[:issue_url] = issue_url if issue_url
         context # Make sure we've set everything we know in the context
 
-        tags = {
-          Labkit::Correlation::CorrelationId::LOG_KEY.to_sym => Labkit::Correlation::CorrelationId.current_id
-        }
-
-        Raven.capture_exception(exception, tags: tags, extra: extra)
+        Raven.capture_exception(exception, tags: default_tags, extra: extra)
       end
     end
 
     def self.should_raise_for_dev?
       Rails.env.development? || Rails.env.test?
     end
+
+    def self.default_tags
+      {
+        Labkit::Correlation::CorrelationId::LOG_KEY.to_sym => Labkit::Correlation::CorrelationId.current_id,
+        locale: I18n.locale
+      }
+    end
   end
 end
diff --git a/spec/lib/gitlab/sentry_spec.rb b/spec/lib/gitlab/sentry_spec.rb
index ae522a588ee..af8b059b984 100644
--- a/spec/lib/gitlab/sentry_spec.rb
+++ b/spec/lib/gitlab/sentry_spec.rb
@@ -2,12 +2,15 @@ require 'spec_helper'
 
 describe Gitlab::Sentry do
   describe '.context' do
-    it 'adds the locale to the tags' do
+    it 'adds the expected tags' do
       expect(described_class).to receive(:enabled?).and_return(true)
+      allow(Labkit::Correlation::CorrelationId).to receive(:current_id).and_return('cid')
 
       described_class.context(nil)
 
       expect(Raven.tags_context[:locale].to_s).to eq(I18n.locale.to_s)
+      expect(Raven.tags_context[Labkit::Correlation::CorrelationId::LOG_KEY.to_sym].to_s)
+        .to eq('cid')
     end
   end
 
diff --git a/spec/requests/api/helpers_spec.rb b/spec/requests/api/helpers_spec.rb
index 25a312cb734..ed907841bd8 100644
--- a/spec/requests/api/helpers_spec.rb
+++ b/spec/requests/api/helpers_spec.rb
@@ -247,9 +247,8 @@ describe API::Helpers do
       exception = RuntimeError.new('test error')
       allow(exception).to receive(:backtrace).and_return(caller)
 
-      expect(Raven).to receive(:capture_exception).with(exception, tags: {
-        correlation_id: 'new-correlation-id'
-      }, extra: {})
+      expect(Raven).to receive(:capture_exception).with(exception, tags:
+        a_hash_including(correlation_id: 'new-correlation-id'), extra: {})
 
       Labkit::Correlation::CorrelationId.use_id('new-correlation-id') do
         handle_api_exception(exception)