Class: ActiveSupport::LogSubscriber

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

Overview

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
    def sql(event)
      "#{event.payload[:name]} (#{event.duration}) #{event.payload[:sql]}"
    end
  end
end

And it's finally registered as:

ActiveRecord::LogSubscriber.attach_to :active_record

Since we need to know all instance methods before attaching the log subscriber, the line above should be called after your ActiveRecord::LogSubscriber definition.

After configured, whenever a “sql.active_record” notification is published, it will properly dispatch the event (ActiveSupport::Notifications::Event) to the sql method.

Log subscriber also has some helpers to deal with logging and automatically flushes all logs when the request finishes (via action_dispatch.callback notification) in a Rails environment.

Defined Under Namespace

Modules: TestHelper

Constant Summary collapse

CLEAR =

Embed in a String to clear all previous ANSI sequences.

"\e[0m"
BOLD =
"\e[1m"
BLACK =

Colors

"\e[30m"
RED =
"\e[31m"
GREEN =
"\e[32m"
YELLOW =
"\e[33m"
BLUE =
"\e[34m"
MAGENTA =
"\e[35m"
CYAN =
"\e[36m"
WHITE =
"\e[37m"

Class Attribute Summary collapse

Attributes inherited from Subscriber

#patterns

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Subscriber

attach_to, #initialize, method_added, subscribers

Constructor Details

This class inherits a constructor from ActiveSupport::Subscriber

Class Attribute Details

.loggerObject


56
57
58
59
60
# File 'lib/active_support/log_subscriber.rb', line 56

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

Class Method Details

.flush_all!Object

Flush all log_subscribers' logger.


69
70
71
# File 'lib/active_support/log_subscriber.rb', line 69

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

.log_subscribersObject


64
65
66
# File 'lib/active_support/log_subscriber.rb', line 64

def log_subscribers
  subscribers
end

Instance Method Details

#finish(name, id, payload) ⇒ Object


82
83
84
85
86
# File 'lib/active_support/log_subscriber.rb', line 82

def finish(name, id, payload)
  super if logger
rescue Exception => e
  logger.error "Could not log #{name.inspect} event. #{e.class}: #{e.message} #{e.backtrace}"
end

#loggerObject


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

def logger
  LogSubscriber.logger
end

#start(name, id, payload) ⇒ Object


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

def start(name, id, payload)
  super if logger
end