debian-mirror-gitlab/lib/gitlab/sentry.rb

78 lines
2.4 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
2016-09-29 09:46:39 +05:30
module Gitlab
module Sentry
def self.enabled?
2019-02-15 15:39:39 +05:30
(Rails.env.production? || Rails.env.development?) &&
2019-09-30 21:07:59 +05:30
Gitlab.config.sentry.enabled
2016-09-29 09:46:39 +05:30
end
def self.context(current_user = nil)
2019-02-15 15:39:39 +05:30
return unless enabled?
2016-09-29 09:46:39 +05:30
2019-09-04 21:01:54 +05:30
Raven.tags_context(default_tags)
2018-03-17 18:26:18 +05:30
2016-09-29 09:46:39 +05:30
if current_user
Raven.user_context(
id: current_user.id,
email: current_user.email,
2017-09-10 17:25:29 +05:30
username: current_user.username
2016-09-29 09:46:39 +05:30
)
end
end
2018-10-15 14:42:47 +05:30
# This can be used for investigating exceptions that can be recovered from in
# code. The exception will still be raised in development and test
# environments.
#
# That way we can track down these exceptions with as much information as we
# need to resolve them.
#
# Provide an issue URL for follow up.
def self.track_exception(exception, issue_url: nil, extra: {})
2019-02-15 15:39:39 +05:30
track_acceptable_exception(exception, issue_url: issue_url, extra: extra)
raise exception if should_raise_for_dev?
end
# This should be used when you do not want to raise an exception in
# development and test. If you need development and test to behave
# just the same as production you can use this instead of
# track_exception.
2019-12-04 20:38:33 +05:30
#
# 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.
2019-02-15 15:39:39 +05:30
def self.track_acceptable_exception(exception, issue_url: nil, extra: {})
2018-10-15 14:42:47 +05:30
if enabled?
2019-12-04 20:38:33 +05:30
extra = build_extra_data(exception, issue_url, extra)
2018-10-15 14:42:47 +05:30
context # Make sure we've set everything we know in the context
2019-09-04 21:01:54 +05:30
Raven.capture_exception(exception, tags: default_tags, extra: extra)
2019-02-15 15:39:39 +05:30
end
2018-10-15 14:42:47 +05:30
end
2019-02-15 15:39:39 +05:30
def self.should_raise_for_dev?
2018-10-15 14:42:47 +05:30
Rails.env.development? || Rails.env.test?
end
2019-09-04 21:01:54 +05:30
def self.default_tags
{
Labkit::Correlation::CorrelationId::LOG_KEY.to_sym => Labkit::Correlation::CorrelationId.current_id,
locale: I18n.locale
}
end
2019-12-04 20:38:33 +05:30
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
2016-09-29 09:46:39 +05:30
end
end