mirror of https://github.com/docusealco/docuseal
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.
246 lines
7.3 KiB
246 lines
7.3 KiB
# frozen_string_literal: true
|
|
|
|
require 'lograge/version'
|
|
require 'lograge/formatters/helpers/method_and_path'
|
|
require 'lograge/formatters/cee'
|
|
require 'lograge/formatters/json'
|
|
require 'lograge/formatters/graylog2'
|
|
require 'lograge/formatters/key_value'
|
|
require 'lograge/formatters/key_value_deep'
|
|
require 'lograge/formatters/l2met'
|
|
require 'lograge/formatters/lines'
|
|
require 'lograge/formatters/logstash'
|
|
require 'lograge/formatters/ltsv'
|
|
require 'lograge/formatters/raw'
|
|
require 'lograge/log_subscribers/base'
|
|
require 'lograge/log_subscribers/action_cable'
|
|
require 'lograge/log_subscribers/action_controller'
|
|
require 'lograge/silent_logger'
|
|
require 'lograge/ordered_options'
|
|
require 'active_support'
|
|
require 'active_support/core_ext/module/attribute_accessors'
|
|
require 'active_support/core_ext/string/inflections'
|
|
|
|
# rubocop:disable Metrics/ModuleLength
|
|
module Lograge
|
|
module_function
|
|
|
|
mattr_accessor :logger, :application, :ignore_tests
|
|
|
|
# Custom options that will be appended to log line
|
|
#
|
|
# Currently supported formats are:
|
|
# - Hash
|
|
# - Any object that responds to call and returns a hash
|
|
#
|
|
mattr_writer :custom_options
|
|
self.custom_options = nil
|
|
|
|
def custom_options(event)
|
|
if @@custom_options.respond_to?(:call)
|
|
@@custom_options.call(event)
|
|
else
|
|
@@custom_options
|
|
end
|
|
end
|
|
|
|
# Before format allows you to change the structure of the output.
|
|
# You've to pass in something callable
|
|
#
|
|
mattr_writer :before_format
|
|
self.before_format = nil
|
|
|
|
def before_format(data, payload)
|
|
result = nil
|
|
result = @@before_format.call(data, payload) if @@before_format
|
|
result || data
|
|
end
|
|
|
|
# Set conditions for events that should be ignored
|
|
#
|
|
# Currently supported formats are:
|
|
# - A single string representing a controller action, e.g. 'UsersController#sign_in'
|
|
# - An array of strings representing controller actions
|
|
# - An object that responds to call with an event argument and returns
|
|
# true iff the event should be ignored.
|
|
#
|
|
# The action ignores are given to 'ignore_actions'. The callable ignores
|
|
# are given to 'ignore'. Both methods can be called multiple times, which
|
|
# just adds more ignore conditions to a list that is checked before logging.
|
|
|
|
def ignore_actions(actions)
|
|
ignore(lambda do |event|
|
|
params = event.payload
|
|
Array(actions).include?("#{controller_field(params)}##{params[:action]}")
|
|
end)
|
|
end
|
|
|
|
def controller_field(params)
|
|
params[:controller] || params[:channel_class] || params[:connection_class]
|
|
end
|
|
|
|
def ignore_tests
|
|
@ignore_tests ||= []
|
|
end
|
|
|
|
def ignore(test)
|
|
ignore_tests.push(test) if test
|
|
end
|
|
|
|
def ignore_nothing
|
|
@ignore_tests = []
|
|
end
|
|
|
|
def ignore?(event)
|
|
ignore_tests.any? { |ignore_test| ignore_test.call(event) }
|
|
end
|
|
|
|
# Loglines are emitted with this log level
|
|
mattr_accessor :log_level
|
|
self.log_level = :info
|
|
|
|
# The emitted log format
|
|
#
|
|
# Currently supported formats are>
|
|
# - :lograge - The custom tense lograge format
|
|
# - :logstash - JSON formatted as a Logstash Event.
|
|
mattr_accessor :formatter
|
|
|
|
def remove_existing_log_subscriptions
|
|
ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
|
|
case subscriber
|
|
when ActionView::LogSubscriber
|
|
unsubscribe(:action_view, subscriber)
|
|
when ActionController::LogSubscriber
|
|
unsubscribe(:action_controller, subscriber)
|
|
end
|
|
end
|
|
end
|
|
|
|
def unsubscribe(component, subscriber)
|
|
events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
|
|
events.each do |event|
|
|
Lograge.notification_listeners_for("#{event}.#{component}").each do |listener|
|
|
ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate') == subscriber
|
|
end
|
|
end
|
|
end
|
|
|
|
def setup(app)
|
|
self.application = app
|
|
disable_rack_cache_verbose_output
|
|
keep_original_rails_log
|
|
|
|
attach_to_action_controller
|
|
attach_to_action_cable if defined?(ActionCable)
|
|
|
|
set_lograge_log_options
|
|
setup_custom_payload
|
|
support_deprecated_config # TODO: Remove with version 1.0
|
|
set_formatter
|
|
set_ignores
|
|
end
|
|
|
|
def set_ignores
|
|
Lograge.ignore_actions(lograge_config.ignore_actions)
|
|
Lograge.ignore(lograge_config.ignore_custom)
|
|
end
|
|
|
|
def set_formatter
|
|
Lograge.formatter = lograge_config.formatter || Lograge::Formatters::KeyValue.new
|
|
end
|
|
|
|
def attach_to_action_controller
|
|
Lograge::LogSubscribers::ActionController.attach_to :action_controller
|
|
end
|
|
|
|
def attach_to_action_cable
|
|
require 'lograge/rails_ext/action_cable/channel/base'
|
|
require 'lograge/rails_ext/action_cable/connection/base'
|
|
|
|
Lograge::LogSubscribers::ActionCable.attach_to :action_cable
|
|
end
|
|
|
|
def setup_custom_payload
|
|
return unless lograge_config.custom_payload_method.respond_to?(:call)
|
|
|
|
base_classes = Array(lograge_config.base_controller_class)
|
|
base_classes.map! { |klass| klass.try(:constantize) }
|
|
base_classes << ActionController::Base if base_classes.empty?
|
|
|
|
base_classes.each do |base_class|
|
|
extend_base_class(base_class)
|
|
end
|
|
end
|
|
|
|
def extend_base_class(klass)
|
|
append_payload_method = klass.instance_method(:append_info_to_payload)
|
|
custom_payload_method = lograge_config.custom_payload_method
|
|
|
|
klass.send(:define_method, :append_info_to_payload) do |payload|
|
|
append_payload_method.bind(self).call(payload)
|
|
payload[:custom_payload] = custom_payload_method.call(self)
|
|
end
|
|
end
|
|
|
|
def set_lograge_log_options
|
|
Lograge.logger = lograge_config.logger
|
|
Lograge.custom_options = lograge_config.custom_options
|
|
Lograge.before_format = lograge_config.before_format
|
|
Lograge.log_level = lograge_config.log_level || :info
|
|
end
|
|
|
|
def disable_rack_cache_verbose_output
|
|
application.config.action_dispatch.rack_cache[:verbose] = false if rack_cache_hashlike?(application)
|
|
end
|
|
|
|
def keep_original_rails_log
|
|
return if lograge_config.keep_original_rails_log
|
|
|
|
require 'lograge/rails_ext/rack/logger'
|
|
|
|
require 'lograge/rails_ext/action_cable/server/base' if defined?(ActionCable)
|
|
|
|
Lograge.remove_existing_log_subscriptions
|
|
end
|
|
|
|
def rack_cache_hashlike?(app)
|
|
app.config.action_dispatch.rack_cache&.respond_to?(:[]=)
|
|
end
|
|
private_class_method :rack_cache_hashlike?
|
|
|
|
# TODO: Remove with version 1.0
|
|
|
|
def support_deprecated_config
|
|
return unless lograge_config.log_format
|
|
|
|
legacy_log_format = lograge_config.log_format
|
|
warning = 'config.lograge.log_format is deprecated. Use config.lograge.formatter instead.'
|
|
deprecator.warn(warning, caller)
|
|
legacy_log_format = :key_value if legacy_log_format == :lograge
|
|
lograge_config.formatter = "Lograge::Formatters::#{legacy_log_format.to_s.classify}".constantize.new
|
|
end
|
|
|
|
def lograge_config
|
|
application.config.lograge
|
|
end
|
|
|
|
def deprecator
|
|
@deprecator ||= ActiveSupport::Deprecation.new('1.0', 'Lograge')
|
|
end
|
|
|
|
if ::ActiveSupport::VERSION::MAJOR >= 8 ||
|
|
(::ActiveSupport::VERSION::MAJOR >= 7 && ::ActiveSupport::VERSION::MINOR >= 1)
|
|
def notification_listeners_for(name)
|
|
ActiveSupport::Notifications.notifier.all_listeners_for(name)
|
|
end
|
|
else
|
|
def notification_listeners_for(name)
|
|
ActiveSupport::Notifications.notifier.listeners_for(name)
|
|
end
|
|
end
|
|
end
|
|
# rubocop:enable Metrics/ModuleLength
|
|
|
|
require 'lograge/railtie' if defined?(Rails)
|