Active Support Log Subscriber
ActiveSupport::LogSubscriber
is an object set to consume ActiveSupport::Notifications
with the sole purpose of logging them. The log subscriber dispatches notifications to a registered object based on its given namespace.
An example would be Active Record log subscriber responsible for logging queries:
module ActiveRecord
class LogSubscriber < ActiveSupport::LogSubscriber
attach_to :active_record
def sql(event)
info "#{event.payload[:name]} (#{event.duration}) #{event.payload[:sql]}"
end
end
end
ActiveRecord::LogSubscriber.logger
must be set as well, but it is assigned automatically in a Rails environment.
After configured, whenever a "sql.active_record"
notification is published, it will properly dispatch the event (ActiveSupport::Notifications::Event
) to the sql
method.
Being an ActiveSupport::Notifications
consumer, ActiveSupport::LogSubscriber
exposes a simple interface to check if instrumented code raises an exception. It is common to log a different message in case of an error, and this can be achieved by extending the previous example:
module ActiveRecord
class LogSubscriber < ActiveSupport::LogSubscriber
def sql(event)
exception = event.payload[:exception]
if exception
exception_object = event.payload[:exception_object]
error "[ERROR] #{event.payload[:name]}: #{exception.join(', ')} " \
"(#{exception_object.backtrace.first})"
else
# standard logger code
end
end
end
end
ActiveSupport::LogSubscriber
also has some helpers to deal with logging. For example, ActiveSupport::LogSubscriber.flush_all!
will ensure that all logs are flushed, and it is called in Rails::Rack::Logger
after a request finishes.
- C
- F
- L
- N
- P
- S
Constants
BLACK | = | "\e[30m" |
ANSI sequence colors |
||
BLUE | = | "\e[34m" |
BOLD | = | ActiveSupport::Deprecation::DeprecatedObjectProxy.new("\e[1m", "BOLD is deprecated! Use MODES[:bold] instead.", ActiveSupport.deprecator) |
CLEAR | = | ActiveSupport::Deprecation::DeprecatedObjectProxy.new("\e[0m", "CLEAR is deprecated! Use MODES[:clear] instead.", ActiveSupport.deprecator) |
Embed in a |
||
CYAN | = | "\e[36m" |
GREEN | = | "\e[32m" |
LEVEL_CHECKS | = | { debug: -> (logger) { !logger.debug? }, info: -> (logger) { !logger.info? }, error: -> (logger) { !logger.error? }, } |
MAGENTA | = | "\e[35m" |
MODES | = | { clear: 0, bold: 1, italic: 3, underline: 4, } |
ANSI sequence modes |
||
RED | = | "\e[31m" |
WHITE | = | "\e[37m" |
YELLOW | = | "\e[33m" |
Attributes
[W] | logger |
Class Public methods
flush_all!() Link
Flush all log_subscribers
‘ logger.
log_subscribers() Link
logger() Link
new() Link
Instance Public methods
call(event) Link
logger() Link
publish_event(event) Link
silenced?(event) Link
Instance Private methods
color(text, color, mode_options = {}) Link
Set color by using a symbol or one of the defined constants. Set modes by specifying bold, italic, or underline options. Inspired by Highline, this method will automatically clear formatting at the end of the returned String
.
# File activesupport/lib/active_support/log_subscriber.rb, line 175 def color(text, color, mode_options = {}) # :doc: return text unless colorize_logging color = self.class.const_get(color.upcase) if color.is_a?(Symbol) mode = mode_from(mode_options) clear = "\e[#{MODES[:clear]}m" "#{mode}#{color}#{text}#{clear}" end