OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/lib/open_project/logging/sentry_logger.rb

90 lines
2.5 KiB

module OpenProject
module Logging
class SentryLogger
class << self
##
# Capture a message to sentry
def log(message, log_context = {})
Sentry.configure_scope do |sentry_scope|
build_sentry_context(sentry_scope, log_context)
Sentry.capture_message(message, level: sentry_level(log_context[:level]))
end
end
##
# Whether sentry logging is enabled?
def enabled?
sentry_dsn.present?
end
##
# Sentry logging DSN
def sentry_dsn
@sentry_dsn ||= OpenProject::Configuration.sentry_dsn.presence || ENV["SENTRY_DSN"].presence
end
##
# The active set of callback handlers
def scope_extenders
@scope_extenders ||= []
end
##
# Register a new context builder callback
def register_scope(&block)
scope_extenders << block
end
private
##
# Build the sentry warning level from context
#
# Sentry uses "warning" as the warn level
# and is consistent with rails otherwise
def sentry_level(level)
return 'warning' if level.to_s == 'warn'
level
end
##
# Build the sentry context from the openproject logging context
def build_sentry_context(sentry_scope, log_context)
if (user = log_context[:current_user])
sentry_scope.set_user id: user.id, email: user.mail, username: user.login.presence || 'unknown'
sentry_scope.set_tags 'user.locale': user.language.presence || Setting.default_language
end
if (params = log_context[:params])
sentry_scope.set_context 'params', filter_params(params)
end
if (rack_env = log_context[:request]&.env)
sentry_scope.set_rack_env(rack_env)
end
if (ref = log_context[:reference])
sentry_scope.set_fingerprint [ref]
end
if (extra = log_context[:extra])
sentry_scope.set_extras extra
end
# Collect additional data to send
scope_extenders.each do |builder|
builder.call(sentry_scope, log_context)
end
end
def filter_params(params)
f = ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
f.filter params
rescue => e
{ filter_failed: e.message }
end
end
end
end
end