module Lograge
rubocop:disable ModuleLength
Constants
- VERSION
Public Instance Methods
attach_to_action_controller()
click to toggle source
# File lib/lograge.rb, line 141 def attach_to_action_controller Lograge::RequestLogSubscriber.attach_to :action_controller end
before_format(data, payload)
click to toggle source
# File lib/lograge.rb, line 45 def before_format(data, payload) result = nil result = @@before_format.call(data, payload) if @@before_format result || data end
custom_options(event)
click to toggle source
# File lib/lograge.rb, line 31 def custom_options(event) if @@custom_options.respond_to?(:call) @@custom_options.call(event) else @@custom_options end end
disable_rack_cache_verbose_output()
click to toggle source
# File lib/lograge.rb, line 176 def disable_rack_cache_verbose_output application.config.action_dispatch.rack_cache[:verbose] = false if rack_cache_hashlike?(application) end
extend_base_controller_class(klass)
click to toggle source
# File lib/lograge.rb, line 159 def extend_base_controller_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
ignore(test)
click to toggle source
# File lib/lograge.rb, line 74 def ignore(test) ignore_tests.push(test) if test end
ignore?(event)
click to toggle source
# File lib/lograge.rb, line 82 def ignore?(event) ignore_tests.any? { |ignore_test| ignore_test.call(event) } end
ignore_actions(actions)
click to toggle source
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.
# File lib/lograge.rb, line 63 def ignore_actions(actions) ignore(lambda do |event| params = event.payload Array(actions).include?("#{params[:controller]}##{params[:action]}") end) end
ignore_nothing()
click to toggle source
# File lib/lograge.rb, line 78 def ignore_nothing @ignore_tests = [] end
ignore_tests()
click to toggle source
# File lib/lograge.rb, line 70 def ignore_tests @ignore_tests ||= [] end
keep_original_rails_log()
click to toggle source
# File lib/lograge.rb, line 180 def keep_original_rails_log return if lograge_config.keep_original_rails_log require 'lograge/rails_ext/rack/logger' Lograge.remove_existing_log_subscriptions end
lograge_config()
click to toggle source
# File lib/lograge.rb, line 204 def lograge_config application.config.lograge end
rack_cache_hashlike?(app)
click to toggle source
# File lib/lograge.rb, line 187 def rack_cache_hashlike?(app) app.config.action_dispatch.rack_cache && app.config.action_dispatch.rack_cache.respond_to?(:[]=) end
remove_existing_log_subscriptions()
click to toggle source
# File lib/lograge.rb, line 97 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
set_formatter()
click to toggle source
# File lib/lograge.rb, line 137 def set_formatter Lograge.formatter = lograge_config.formatter || Lograge::Formatters::KeyValue.new end
set_ignores()
click to toggle source
# File lib/lograge.rb, line 132 def set_ignores Lograge.ignore_actions(lograge_config.ignore_actions) Lograge.ignore(lograge_config.ignore_custom) end
set_lograge_log_options()
click to toggle source
# File lib/lograge.rb, line 169 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
setup(app)
click to toggle source
# File lib/lograge.rb, line 119 def setup(app) self.application = app disable_rack_cache_verbose_output keep_original_rails_log attach_to_action_controller set_lograge_log_options setup_custom_payload support_deprecated_config # TODO: Remove with version 1.0 set_formatter set_ignores end
setup_custom_payload()
click to toggle source
# File lib/lograge.rb, line 145 def setup_custom_payload return unless lograge_config.custom_payload_method.respond_to?(:call) base_controller_classes = Array(lograge_config.base_controller_class) base_controller_classes.map! { |klass| klass.try(:constantize) } if base_controller_classes.empty? base_controller_classes << ActionController::Base end base_controller_classes.each do |base_controller_class| extend_base_controller_class(base_controller_class) end end
support_deprecated_config()
click to toggle source
TODO: Remove with version 1.0
# File lib/lograge.rb, line 194 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.' ActiveSupport::Deprecation.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
unsubscribe(component, subscriber)
click to toggle source
# File lib/lograge.rb, line 108 def unsubscribe(component, subscriber) events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' } events.each do |event| ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener| if listener.instance_variable_get('@delegate') == subscriber ActiveSupport::Notifications.unsubscribe listener end end end end