Class: ActiveSupport::LogSubscriber

Inherits:
Subscriber show all
Defined in:
lib/active_support/log_subscriber.rb,
lib/active_support/log_subscriber/test_helper.rb

Overview

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.

Defined Under Namespace

Modules: TestHelper

Constant Summary collapse

CLEAR =

Embed in a String to clear all previous ANSI sequences.

ActiveSupport::Deprecation::DeprecatedObjectProxy.new("\e[0m", "CLEAR is deprecated! Use MODES[:clear] instead.", ActiveSupport.deprecator)
BOLD = 
ActiveSupport::Deprecation::DeprecatedObjectProxy.new("\e[1m", "BOLD is deprecated! Use MODES[:bold] instead.", ActiveSupport.deprecator)
MODES =

ANSI sequence modes

{
  clear:     0,
  bold:      1,
  italic:    3,
  underline: 4,
}
BLACK =

ANSI sequence colors

"\e[30m"
RED = 
"\e[31m"
GREEN = 
"\e[32m"
YELLOW = 
"\e[33m"
BLUE = 
"\e[34m"
MAGENTA = 
"\e[35m"
CYAN = 
"\e[36m"
WHITE = 
"\e[37m"
LEVEL_CHECKS = 
{
  debug: -> (logger) { !logger.debug? },
  info: -> (logger) { !logger.info? },
  error: -> (logger) { !logger.error? },
}

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes inherited from Subscriber

#patterns

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Subscriber

detach_from, method_added, subscribers

Constructor Details

#initialize ⇒ LogSubscriber

Returns a new instance of LogSubscriber.



137
138
139
140
 
# File 'lib/active_support/log_subscriber.rb', line 137

def initialize
  super
  @event_levels = {}
end

Class Attribute Details

.logger ⇒ Object 



97
98
99
100
101
 
# File 'lib/active_support/log_subscriber.rb', line 97

def logger
  @logger ||= if defined?(Rails) && Rails.respond_to?(:logger)
    Rails.logger
  end
end

Instance Attribute Details

#event_levels=(value) ⇒ Object (writeonly)

:nodoc:



162
163
164
 
# File 'lib/active_support/log_subscriber.rb', line 162

def event_levels=(value)
  @event_levels = value
end

Class Method Details

.attach_to ⇒ Object

:nodoc:



103
104
105
106
107
 
# File 'lib/active_support/log_subscriber.rb', line 103

def attach_to(...) # :nodoc:
  result = super
  set_event_levels
  result
end

.flush_all! ⇒ Object

Flush all log_subscribers’ logger.



116
117
118
 
# File 'lib/active_support/log_subscriber.rb', line 116

def flush_all!
  logger.flush if logger.respond_to?(:flush)
end

.log_subscribers ⇒ Object 



111
112
113
 
# File 'lib/active_support/log_subscriber.rb', line 111

def log_subscribers
  subscribers
end

Instance Method Details

#call(event) ⇒ Object 



150
151
152
153
154
 
# File 'lib/active_support/log_subscriber.rb', line 150

def call(event)
  super if logger
rescue => e
  log_exception(event.name, e)
end

#logger ⇒ Object 



142
143
144
 
# File 'lib/active_support/log_subscriber.rb', line 142

def logger
  LogSubscriber.logger
end

#publish_event(event) ⇒ Object 



156
157
158
159
160
 
# File 'lib/active_support/log_subscriber.rb', line 156

def publish_event(event)
  super if logger
rescue => e
  log_exception(event.name, e)
end

#silenced?(event) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/active_support/log_subscriber.rb', line 146

def silenced?(event)
  logger.nil? || @event_levels[event]&.call(logger)
end