Module: Lograge

Defined in:
lib/lograge.rb,
lib/lograge/railtie.rb,
lib/lograge/version.rb,
lib/lograge/silent_logger.rb,
lib/lograge/formatters/cee.rb,
lib/lograge/formatters/raw.rb,
lib/lograge/formatters/json.rb,
lib/lograge/formatters/ltsv.rb,
lib/lograge/ordered_options.rb,
lib/lograge/formatters/l2met.rb,
lib/lograge/formatters/lines.rb,
lib/lograge/formatters/graylog2.rb,
lib/lograge/formatters/logstash.rb,
lib/lograge/formatters/key_value.rb,
lib/lograge/log_subscribers/base.rb,
lib/lograge/log_subscribers/action_cable.rb,
lib/lograge/log_subscribers/action_controller.rb,
lib/lograge/formatters/helpers/method_and_path.rb

Overview

rubocop:disable ModuleLength

Defined Under Namespace

Modules: Formatters, LogSubscribers Classes: OrderedOptions, Railtie, SilentLogger

Constant Summary collapse

VERSION = 
'0.11.1'.freeze

Class Method Summary collapse

Class Method Details

.attach_to_action_cable ⇒ Object 



155
156
157
158
159
160
 
# File 'lib/lograge.rb', line 155

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

.attach_to_action_controller ⇒ Object 



151
152
153
 
# File 'lib/lograge.rb', line 151

def attach_to_action_controller
  Lograge::LogSubscribers::ActionController.attach_to :action_controller
end

.before_format(data, payload) ⇒ Object 



49
50
51
52
53
 
# File 'lib/lograge.rb', line 49

def before_format(data, payload)
  result = nil
  result = @@before_format.call(data, payload) if @@before_format
  result || data
end

.controller_field(params) ⇒ Object 



74
75
76
 
# File 'lib/lograge.rb', line 74

def controller_field(params)
  params[:controller] || params[:channel_class] || params[:connection_class]
end

.custom_options(event) ⇒ Object 



35
36
37
38
39
40
41
 
# File 'lib/lograge.rb', line 35

def custom_options(event)
  if @@custom_options.respond_to?(:call)
    @@custom_options.call(event)
  else
    @@custom_options
  end
end

.disable_rack_cache_verbose_output ⇒ Object 



194
195
196
 
# File 'lib/lograge.rb', line 194

def disable_rack_cache_verbose_output
  application.config.action_dispatch.rack_cache[:verbose] = false if rack_cache_hashlike?(application)
end

.extend_base_class(klass) ⇒ Object 



177
178
179
180
181
182
183
184
185
 
# File 'lib/lograge.rb', line 177

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

.ignore(test) ⇒ Object 



82
83
84
 
# File 'lib/lograge.rb', line 82

def ignore(test)
  ignore_tests.push(test) if test
end

.ignore?(event) ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/lograge.rb', line 90

def ignore?(event)
  ignore_tests.any? { |ignore_test| ignore_test.call(event) }
end

.ignore_actions(actions) ⇒ Object

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.



67
68
69
70
71
72
 
# File 'lib/lograge.rb', line 67

def ignore_actions(actions)
  ignore(lambda do |event|
           params = event.payload
           Array(actions).include?("#{controller_field(params)}##{params[:action]}")
         end)
end

.ignore_nothing ⇒ Object 



86
87
88
 
# File 'lib/lograge.rb', line 86

def ignore_nothing
  @ignore_tests = []
end

.ignore_tests ⇒ Object 



78
79
80
 
# File 'lib/lograge.rb', line 78

def ignore_tests
  @ignore_tests ||= []
end

.keep_original_rails_log ⇒ Object 



198
199
200
201
202
203
204
205
206
 
# File 'lib/lograge.rb', line 198

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

.lograge_config ⇒ Object 



225
226
227
 
# File 'lib/lograge.rb', line 225

def lograge_config
  application.config.lograge
end

.remove_existing_log_subscriptions ⇒ Object 



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/lograge.rb', line 105

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 ⇒ Object 



147
148
149
 
# File 'lib/lograge.rb', line 147

def set_formatter
  Lograge.formatter = lograge_config.formatter || Lograge::Formatters::KeyValue.new
end

.set_ignores ⇒ Object 



142
143
144
145
 
# File 'lib/lograge.rb', line 142

def set_ignores
  Lograge.ignore_actions(lograge_config.ignore_actions)
  Lograge.ignore(lograge_config.ignore_custom)
end

.set_lograge_log_options ⇒ Object 



187
188
189
190
191
192
 
# File 'lib/lograge.rb', line 187

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) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/lograge.rb', line 127

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

.setup_custom_payload ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/lograge.rb', line 162

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) }
  if base_classes.empty?
    base_classes << ActionController::Base
    base_classes << ActionCable::Channel::Base if defined?(ActionCable)
  end

  base_classes.each do |base_class|
    extend_base_class(base_class)
  end
end

.support_deprecated_config ⇒ Object

TODO: Remove with version 1.0



215
216
217
218
219
220
221
222
223
 
# File 'lib/lograge.rb', line 215

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) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/lograge.rb', line 116

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