Add support for sentry_extra_data in exceptions
This allows exceptions to advertise their support for sentry and provide structured data.
This commit is contained in:
parent
d4a5e3fd87
commit
2cbcab4679
|
@ -39,9 +39,14 @@ module Gitlab
|
||||||
# development and test. If you need development and test to behave
|
# development and test. If you need development and test to behave
|
||||||
# just the same as production you can use this instead of
|
# just the same as production you can use this instead of
|
||||||
# track_exception.
|
# track_exception.
|
||||||
|
#
|
||||||
|
# If the exception implements the method `sentry_extra_data` and that method
|
||||||
|
# returns a Hash, then the return value of that method will be merged into
|
||||||
|
# `extra`. Exceptions can use this mechanism to provide structured data
|
||||||
|
# to sentry in addition to their message and back-trace.
|
||||||
def self.track_acceptable_exception(exception, issue_url: nil, extra: {})
|
def self.track_acceptable_exception(exception, issue_url: nil, extra: {})
|
||||||
if enabled?
|
if enabled?
|
||||||
extra[:issue_url] = issue_url if issue_url
|
extra = build_extra_data(exception, issue_url, extra)
|
||||||
context # Make sure we've set everything we know in the context
|
context # Make sure we've set everything we know in the context
|
||||||
|
|
||||||
Raven.capture_exception(exception, tags: default_tags, extra: extra)
|
Raven.capture_exception(exception, tags: default_tags, extra: extra)
|
||||||
|
@ -58,5 +63,15 @@ module Gitlab
|
||||||
locale: I18n.locale
|
locale: I18n.locale
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def self.build_extra_data(exception, issue_url, extra)
|
||||||
|
exception.try(:sentry_extra_data)&.tap do |data|
|
||||||
|
extra.merge!(data) if data.is_a?(Hash)
|
||||||
|
end
|
||||||
|
|
||||||
|
extra.merge({ issue_url: issue_url }.compact)
|
||||||
|
end
|
||||||
|
|
||||||
|
private_class_method :build_extra_data
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -65,6 +65,7 @@ describe Gitlab::Sentry do
|
||||||
|
|
||||||
context '.track_acceptable_exception' do
|
context '.track_acceptable_exception' do
|
||||||
let(:exception) { RuntimeError.new('boom') }
|
let(:exception) { RuntimeError.new('boom') }
|
||||||
|
let(:issue_url) { 'http://gitlab.com/gitlab-org/gitlab-ce/issues/1' }
|
||||||
|
|
||||||
before do
|
before do
|
||||||
allow(described_class).to receive(:enabled?).and_return(true)
|
allow(described_class).to receive(:enabled?).and_return(true)
|
||||||
|
@ -74,7 +75,7 @@ describe Gitlab::Sentry do
|
||||||
it 'calls Raven.capture_exception' do
|
it 'calls Raven.capture_exception' do
|
||||||
expected_extras = {
|
expected_extras = {
|
||||||
some_other_info: 'info',
|
some_other_info: 'info',
|
||||||
issue_url: 'http://gitlab.com/gitlab-org/gitlab-ce/issues/1'
|
issue_url: issue_url
|
||||||
}
|
}
|
||||||
|
|
||||||
expected_tags = {
|
expected_tags = {
|
||||||
|
@ -88,9 +89,33 @@ describe Gitlab::Sentry do
|
||||||
|
|
||||||
described_class.track_acceptable_exception(
|
described_class.track_acceptable_exception(
|
||||||
exception,
|
exception,
|
||||||
issue_url: 'http://gitlab.com/gitlab-org/gitlab-ce/issues/1',
|
issue_url: issue_url,
|
||||||
extra: { some_other_info: 'info' }
|
extra: { some_other_info: 'info' }
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
context 'the exception implements :sentry_extra_data' do
|
||||||
|
let(:extra_info) { { event: 'explosion', size: :massive } }
|
||||||
|
let(:exception) { double(message: 'bang!', sentry_extra_data: extra_info) }
|
||||||
|
|
||||||
|
it 'includes the extra data from the exception in the tracking information' do
|
||||||
|
expect(Raven).to receive(:capture_exception)
|
||||||
|
.with(exception, a_hash_including(extra: a_hash_including(extra_info)))
|
||||||
|
|
||||||
|
described_class.track_acceptable_exception(exception)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'the exception implements :sentry_extra_data, which returns nil' do
|
||||||
|
let(:exception) { double(message: 'bang!', sentry_extra_data: nil) }
|
||||||
|
|
||||||
|
it 'just includes the other extra info' do
|
||||||
|
extra_info = { issue_url: issue_url }
|
||||||
|
expect(Raven).to receive(:capture_exception)
|
||||||
|
.with(exception, a_hash_including(extra: a_hash_including(extra_info)))
|
||||||
|
|
||||||
|
described_class.track_acceptable_exception(exception, extra_info)
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue