Module Logging
In: lib/logging/logger.rb
lib/logging/color_scheme.rb
lib/logging/layout.rb
lib/logging/diagnostic_context.rb
lib/logging/log_event.rb
lib/logging/repository.rb
lib/logging/rails_compat.rb
lib/logging/appenders.rb
lib/logging/layouts.rb
lib/logging/proxy.rb
lib/logging/root_logger.rb
lib/logging/appender.rb
lib/logging.rb

Methods

Classes and Modules

Module Logging::Appenders
Module Logging::Config
Module Logging::Layouts
Module Logging::MappedDiagnosticContext
Module Logging::NestedDiagnosticContext
Module Logging::RailsCompat
Module Logging::Stats
Class Logging::Appender
Class Logging::ColorScheme
Class Logging::Layout
Class Logging::Logger
Class Logging::Proxy
Class Logging::Repository
Class Logging::RootLogger

Constants

LogEvent = Struct.new( :logger, :level, :data, :time, :file, :line, :method ) { # :stopdoc: # Regular expression used to parse out caller information # # * $1 == filename # * $2 == line number # * $3 == method name (might be nil) CALLER_RGXP = %r/([-\.\/\(\)\w]+):(\d+)(?::in `(\w+)')?/o   This class defines a logging event.
CALLER_INDEX = ((defined? JRUBY_VERSION and JRUBY_VERSION > '1.6') or (defined? RUBY_ENGINE and RUBY_ENGINE[%r/^rbx/i])) ? 1 : 2   CALLER_INDEX = 2

Public Class methods

Access to the appenders.

Without any arguments, returns the global exception backtrace logging value. When set to true backtraces will be written to the logs; when set to false backtraces will be suppressed.

When an argument is given the global exception backtrace setting will be changed. Value values are "on", :on<tt> and true to turn on backtraces and <tt>"off", :off and false to turn off backtraces.

Public: Convenience method that will clear both the Mapped Diagnostic Context and the Nested Diagnostic Context of the current thread. If the `all` flag passed to this method is true, then the diagnostic contexts for every thread in the application will be cleared.

all - Boolean flag used to clear the context of every Thread (default is false)

Returns the Logging module.

Returns the color scheme identified by the given name. If there is no color scheme nil is returned.

If color scheme options are supplied then a new color scheme is created. Any existing color scheme with the given name will be replaced by the new color scheme.

Configures the Logging framework using the configuration information found in the given file. The file extension should be either ’.yaml’ or ’.yml’ (XML configuration is not yet supported).

Consolidate all loggers under the given namespace. All child loggers in the namespace will use the "consolidated" namespace logger instead of creating a new logger for each class or module.

If the "root" logger name is passed to this method then all loggers will consolidate to the root logger. In other words, only the root logger will be created, and it will be used by all classes and modules in the application.

Example

   Logging.consolidate( 'Foo' )

   foo = Logging.logger['Foo']
   bar = Logging.logger['Foo::Bar']
   baz = Logging.logger['Baz']

   foo.object_id == bar.object_id    #=> true
   foo.object_id == baz.object_id    #=> false

Defines the default obj_format method to use when converting objects into string representations for logging. obj_format can be one of :string, :inspect, or :yaml. These formatting commands map to the following object methods

  • :string => to_s
  • :inspect => inspect
  • :yaml => to_yaml
  • :json => MultiJson.encode(obj)

An ArgumentError is raised if anything other than +:string+, +:inspect+, +:yaml+ is passed to this method.

Add a "logger" method to the including context. If included from Object or Kernel, the logger method will be available to all objects.

Optionally, a method name can be given and that will be used to provided access to the logger:

   include Logging.globally( :log )
   log.info "Just using a shorter method name"

If you prefer to use the shorter "log" to access the logger.

Example

  include Logging.globally

  class Foo
    logger.debug "Loading the Foo class"
    def initialize
      logger.info "Creating some new foo"
    end
  end

  logger.fatal "End of example"

Defines the levels available to the loggers. The levels is an array of strings and symbols. Each element in the array is downcased and converted to a symbol; these symbols are used to create the logging methods in the loggers.

The first element in the array is the lowest logging level. Setting the logging level to this value will enable all log messages. The last element in the array is the highest logging level. Setting the logging level to this value will disable all log messages except this highest level.

This method should be invoked only once to configure the logging levels. It is automatically invoked with the default logging levels when the first logger is created.

The levels "all" and "off" are reserved and will be ignored if passed to this method.

Example:

   Logging.init :debug, :info, :warn, :error, :fatal
   log = Logging::Logger['my logger']
   log.level = :warn
   log.warn 'Danger! Danger! Will Robinson'
   log.info 'Just FYI'                        # => not logged

or

   Logging.init %w(DEBUG INFO NOTICE WARNING ERR CRIT ALERT EMERG)
   log = Logging::Logger['syslog']
   log.level = :notice
   log.warning 'This is your first warning'
   log.info 'Just FYI'                        # => not logged

Access to the layouts.

Returns the library path for the module. If any arguments are given, they will be joined to the end of the library path using File.join.

This convenience method returns a Logger instance configured to behave similarly to a core Ruby Logger instance.

The device is the logging destination. This can be a filename (String) or an IO object (STDERR, STDOUT, an open File, etc.). The age is the number of old log files to keep or the frequency of rotation (daily, weekly, or monthly). The size is the maximum logfile size and is only used when age is a number.

Using the same device twice will result in the same Logger instance being returned. For example, if a Logger is created using STDOUT then the same Logger instance will be returned the next time STDOUT is used. A new Logger instance can be obtained by closing the previous logger instance.

   log1 = Logging.logger(STDOUT)
   log2 = Logging.logger(STDOUT)
   log1.object_id == log2.object_id  #=> true

   log1.close
   log2 = Logging.logger(STDOUT)
   log1.object_id == log2.object_id  #=> false

The format of the log messages can be changed using a few optional parameters. The :pattern can be used to change the log message format. The :date_pattern can be used to change how timestamps are formatted.

   log = Logging.logger(STDOUT,
             :pattern => "[%d] %-5l : %m\n",
             :date_pattern => "%Y-%m-%d %H:%M:%S.%s")

See the documentation for the Logging::Layouts::Pattern class for a full description of the :pattern and :date_pattern formatting strings.

Public: Accessor method for getting the current Thread‘s MappedDiagnosticContext.

Returns MappedDiagnosticContext

Public: Accessor method for getting the current Thread‘s NestedDiagnosticContext.

Returns NestedDiagnosticContext

Creates a new log event with the given logger name, numeric level, array of data from the user to be logged, and boolean trace flag. If the trace flag is set to true then Kernel::caller will be invoked to get the execution trace of the logging method.

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.

Reopen all appenders. This method should be called immediately after a fork to ensure no conflict with file descriptors and calls to fcntl or flock.

This method is used to show the configuration of the logging framework. The information is written to the given io stream (defaulting to stdout). Normally the configuration is dumped starting with the root logger, but any logger name can be given.

Each line contains information for a single logger and it‘s appenders. A child logger is indented two spaces from it‘s parent logger. Each line contains the logger name, level, additivity, and trace settings. Here is a brief example:

   root  ...........................   *info      -T
     LoggerA  ......................    info  +A  -T
       LoggerA::LoggerB  ...........    info  +A  -T
       LoggerA::LoggerC  ...........  *debug  +A  -T
     LoggerD  ......................   *warn  -A  +T

The lines can be deciphered as follows:

   1) name       - the name of the logger

   2) level      - the logger level; if it is preceded by an
                   asterisk then the level was explicitly set for that
                   logger (as opposed to being inherited from the parent
                   logger)

   3) additivity - a "+A" shows the logger is additive, and log events
                   will be passed up to the parent logger; "-A" shows
                   that the logger will *not* pass log events up to the
                   parent logger

   4) trace      - a "+T" shows that the logger will include trace
                   information in generated log events (this includes
                   filename and line number of the log message; "-T"
                   shows that the logger does not include trace
                   information in the log events)

If a logger has appenders then they are listed, one per line, immediately below the logger. Appender lines are pre-pended with a single dash:

   root  ...........................   *info      -T
   - <Appenders::Stdout:0x8b02a4 name="stdout">
     LoggerA  ......................    info  +A  -T
       LoggerA::LoggerB  ...........    info  +A  -T
       LoggerA::LoggerC  ...........  *debug  +A  -T
     LoggerD  ......................   *warn  -A  +T
     - <Appenders::Stderr:0x8b04ca name="stderr">

We can see in this configuration dump that all the loggers will append to stdout via the Stdout appender configured in the root logger. All the loggers are additive, and so their generated log events will be passed up to the root logger.

The exception in this configuration is LoggerD. Its additivity is set to false. It uses its own appender to send messages to stderr.

Returns the version string for the library.

[Validate]