Module: Logsly::Logging182
- Extended by:
- LittlePlugger
- Defined in:
- lib/logsly/logging182.rb,
lib/logsly/logging182/proxy.rb,
lib/logsly/logging182/layout.rb,
lib/logsly/logging182/logger.rb,
lib/logsly/logging182/layouts.rb,
lib/logsly/logging182/appender.rb,
lib/logsly/logging182/appenders.rb,
lib/logsly/logging182/log_event.rb,
lib/logsly/logging182/repository.rb,
lib/logsly/logging182/root_logger.rb,
lib/logsly/logging182/color_scheme.rb,
lib/logsly/logging182/rails_compat.rb,
lib/logsly/logging182/diagnostic_context.rb
Overview
color_scheme.rb
Created by Jeremy Hinegardner on 2007-01-24 Copyright 2007. All rights reserved
This is Free Software. See LICENSE and COPYING for details
Defined Under Namespace
Modules: Appenders, Config, Layouts, MappedDiagnosticContext, NestedDiagnosticContext, Plugins, RailsCompat, Stats Classes: Appender, ColorScheme, Layout, LogEvent, Logger, Proxy, Repository, RootLogger
Constant Summary collapse
- LEVELS =
:stopdoc: LIBPATH = ::File.expand_path(‘..’, __FILE__) + ::File::SEPARATOR PATH = ::File.expand_path(‘../..’, __FILE__) + ::File::SEPARATOR
{}
- LNAMES =
[]
- DIAGNOSTIC_MUTEX =
Mutex.new
Class Method Summary collapse
-
.appenders ⇒ Object
Access to the appenders.
-
.backtrace(b = nil) ⇒ Object
call-seq: Logsly::Logging182.backtrace #=> true or false Logsly::Logging182.backtrace( value ) #=> true or false.
-
.clear_diagnostic_contexts(all = false) ⇒ Object
Public: Convenience method that will clear both the Mapped Diagnostic Context and the Nested Diagnostic Context of the current thread.
-
.color_scheme(name, opts = {}) ⇒ Object
Returns the color scheme identified by the given name.
-
.configure(*args, &block) ⇒ Object
call-seq: Logsly::Logging182.configure( filename ) Logsly::Logging182.configure { block }.
-
.consolidate(*args) ⇒ Object
call-seq: Logsly::Logging182.consolidate( ‘First::Name’, ‘Second::Name’, … ).
-
.format_as(f) ⇒ Object
call-seq: Logsly::Logging182.format_as( obj_format ).
-
.globally(name = :logger) ⇒ Object
call-seq: include Logsly::Logging182.globally include Logsly::Logging182.globally( :logger ).
-
.init(*args) ⇒ Object
call-seq: Logsly::Logging182.init( levels ).
-
.initialized? ⇒ Boolean
Return
true
if the Logsly::Logging182 framework is initialized. -
.layouts ⇒ Object
Access to the layouts.
-
.level_num(level) ⇒ Object
Convert the given level into a level number.
-
.levelify(level) ⇒ Object
:stopdoc: Convert the given level into a canonical form - a lowercase string.
-
.log_internal(level = 1, &block) ⇒ Object
Internal logging method for use by the framework.
-
.logger(*args) ⇒ Object
call-seq: Logsly::Logging182.logger( device, age = 7, size = 1048576 ) Logsly::Logging182.logger( device, age = ‘weekly’ ).
-
.mdc ⇒ Object
Public: Accessor method for getting the current Thread’s MappedDiagnosticContext.
-
.ndc ⇒ Object
Public: Accessor method for getting the current Thread’s NestedDiagnosticContext.
-
.reopen ⇒ Object
Reopen all appenders.
-
.reset ⇒ Object
Reset the Logsly::Logging182 framework to it’s uninitialized state.
-
.show_configuration(io = STDOUT, logger = 'root', indent = 0) ⇒ Object
call-seq: show_configuration( io = STDOUT, logger = ‘root’ ).
-
.shutdown(*args) ⇒ Object
Close all appenders.
Class Method Details
.appenders ⇒ Object
Access to the appenders.
159 160 161 |
# File 'lib/logsly/logging182.rb', line 159 def appenders ::Logsly::Logging182::Appenders end |
.backtrace(b = nil) ⇒ Object
call-seq:
Logsly::Logging182.backtrace #=> true or false
Logsly::Logging182.backtrace( value ) #=> true or false
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.
352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/logsly/logging182.rb', line 352 def backtrace( b = nil ) @backtrace = true unless defined? @backtrace return @backtrace if b.nil? @backtrace = case b when :on, 'on', true; true when :off, 'off', false; false else raise ArgumentError, "backtrace must be true or false" end end |
.clear_diagnostic_contexts(all = false) ⇒ Object
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 Logsly::Logging182 module.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/logsly/logging182/diagnostic_context.rb', line 261 def self.clear_diagnostic_contexts( all = false ) if all DIAGNOSTIC_MUTEX.synchronize { Thread.list.each { |thread| thread[MappedDiagnosticContext::NAME].clear if thread[MappedDiagnosticContext::NAME] thread[NestedDiagnosticContext::NAME].clear if thread[NestedDiagnosticContext::NAME] } } else MappedDiagnosticContext.clear NestedDiagnosticContext.clear end self end |
.color_scheme(name, opts = {}) ⇒ Object
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.
170 171 172 173 174 175 176 |
# File 'lib/logsly/logging182.rb', line 170 def color_scheme( name, opts = {} ) if opts.empty? ::Logsly::Logging182::ColorScheme[name] else ::Logsly::Logging182::ColorScheme.new(name, opts) end end |
.configure(*args, &block) ⇒ Object
call-seq:
Logsly::Logging182.configure( filename )
Logsly::Logging182.configure { block }
Configures the Logsly::Logging182 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).
39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/logsly/logging182.rb', line 39 def configure( *args, &block ) if block return ::Logsly::Logging182::Config::Configurator.process(&block) end filename = args.shift raise ArgumentError, 'a filename was not given' if filename.nil? case File.extname(filename) when '.yaml', '.yml' ::Logsly::Logging182::Config::YamlConfigurator.load(filename, *args) else raise ArgumentError, 'unknown configuration file format' end end |
.consolidate(*args) ⇒ Object
call-seq:
Logsly::Logging182.consolidate( 'First::Name', 'Second::Name', ... )
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
Logsly::Logging182.consolidate( 'Foo' )
foo = Logsly::Logging182.logger['Foo']
= Logsly::Logging182.logger['Foo::Bar']
baz = Logsly::Logging182.logger['Baz']
foo.object_id == .object_id #=> true
foo.object_id == baz.object_id #=> false
211 212 213 214 |
# File 'lib/logsly/logging182.rb', line 211 def consolidate( *args ) ::Logsly::Logging182::Repository.instance.add_master(*args) self end |
.format_as(f) ⇒ Object
call-seq:
Logsly::Logging182.format_as( obj_format )
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.
328 329 330 331 332 333 334 335 336 337 |
# File 'lib/logsly/logging182.rb', line 328 def format_as( f ) f = f.intern if f.instance_of? String unless [:string, :inspect, :yaml, :json].include? f raise ArgumentError, "unknown object format '#{f}'" end module_eval "OBJ_FORMAT = :#{f}", __FILE__, __LINE__ self end |
.globally(name = :logger) ⇒ Object
call-seq:
include Logsly::Logging182.globally
include Logsly::Logging182.globally( :logger )
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 Logsly::Logging182.globally( :log )
log.info "Just using a shorter method name"
If you prefer to use the shorter “log” to access the logger.
Example
include Logsly::Logging182.globally
class Foo
logger.debug "Loading the Foo class"
def initialize
logger.info "Creating some new foo"
end
end
logger.fatal "End of example"
244 245 246 247 248 |
# File 'lib/logsly/logging182.rb', line 244 def globally( name = :logger ) Module.new { eval "def #{name}() @_logging_logger ||= ::Logsly::Logging182::Logger[self] end" } end |
.init(*args) ⇒ Object
call-seq:
Logsly::Logging182.init( levels )
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:
Logsly::Logging182.init :debug, :info, :warn, :error, :fatal
log = Logsly::Logging182::Logger['my logger']
log.level = :warn
log.warn 'Danger! Danger! Will Robinson'
log.info 'Just FYI' # => not logged
or
Logsly::Logging182.init %w(DEBUG INFO NOTICE WARNING ERR CRIT ALERT EMERG)
log = Logsly::Logging182::Logger['syslog']
log.level = :notice
log.warning 'This is your first warning'
log.info 'Just FYI' # => not logged
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/logsly/logging182.rb', line 287 def init( *args ) args = %w(debug info warn error fatal) if args.empty? args.flatten! levels = LEVELS.clear names = LNAMES.clear id = 0 args.each do |lvl| lvl = levelify lvl unless levels.has_key?(lvl) or lvl == 'all' or lvl == 'off' levels[lvl] = id names[id] = lvl.upcase id += 1 end end longest = names.inject {|x,y| (x.length > y.length) ? x : y} longest = 'off' if longest.length < 3 module_eval "MAX_LEVEL_LENGTH = #{longest.length}", __FILE__, __LINE__ initialize_plugins levels.keys end |
.initialized? ⇒ Boolean
Return true
if the Logsly::Logging182 framework is initialized.
523 524 525 |
# File 'lib/logsly/logging182.rb', line 523 def initialized? const_defined? :MAX_LEVEL_LENGTH end |
.layouts ⇒ Object
Access to the layouts.
153 154 155 |
# File 'lib/logsly/logging182.rb', line 153 def layouts ::Logsly::Logging182::Layouts end |
.level_num(level) ⇒ Object
Convert the given level into a level number.
487 488 489 490 491 492 493 |
# File 'lib/logsly/logging182.rb', line 487 def level_num( level ) l = levelify(level) rescue level case l when 'all'; 0 when 'off'; LEVELS.length else begin; Integer(l); rescue ArgumentError; LEVELS[l] end end end |
.levelify(level) ⇒ Object
:stopdoc: Convert the given level into a canonical form - a lowercase string.
479 480 481 482 483 484 |
# File 'lib/logsly/logging182.rb', line 479 def levelify( level ) case level when String; level.downcase when Symbol; level.to_s.downcase else raise ArgumentError, "levels must be a String or Symbol" end end |
.log_internal(level = 1, &block) ⇒ Object
Internal logging method for use by the framework.
496 497 498 |
# File 'lib/logsly/logging182.rb', line 496 def log_internal( level = 1, &block ) ::Logsly::Logging182::Logger[::Logsly::Logging182].__send__(levelify(LNAMES[level]), &block) end |
.logger(*args) ⇒ Object
call-seq:
Logsly::Logging182.logger( device, age = 7, size = 1048576 )
Logsly::Logging182.logger( device, age = 'weekly' )
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 = Logsly::Logging182.logger(STDOUT)
log2 = Logsly::Logging182.logger(STDOUT)
log1.object_id == log2.object_id #=> true
log1.close
log2 = Logsly::Logging182.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 = Logsly::Logging182.logger(STDOUT,
:pattern => "[%d] %-5l : %m\n",
:date_pattern => "%Y-%m-%d %H:%M:%S.%s")
See the documentation for the Logsly::Logging182::Layouts::Pattern class for a full description of the :pattern and :date_pattern formatting strings.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/logsly/logging182.rb', line 92 def logger( *args ) return ::Logsly::Logging182::Logger if args.empty? opts = args.pop if args.last.instance_of?(Hash) opts ||= Hash.new dev = args.shift keep = age = args.shift size = args.shift name = case dev when String; dev when File; dev.path else dev.object_id.to_s end repo = ::Logsly::Logging182::Repository.instance return repo[name] if repo.has_logger? name l_opts = { :pattern => "%.1l, [%d #%p] %#{::Logsly::Logging182::MAX_LEVEL_LENGTH}l : %m\n", :date_pattern => '%Y-%m-%dT%H:%M:%S.%s' } [:pattern, :date_pattern, :date_method].each do |o| l_opts[o] = opts.delete(o) if opts.has_key? o end layout = ::Logsly::Logging182::Layouts::Pattern.new(l_opts) a_opts = Hash.new a_opts[:size] = size if size.instance_of?(Fixnum) a_opts[:age] = age if age.instance_of?(String) a_opts[:keep] = keep if keep.instance_of?(Fixnum) a_opts[:filename] = dev if dev.instance_of?(String) a_opts[:layout] = layout a_opts.merge! opts appender = case dev when String ::Logsly::Logging182::Appenders::RollingFile.new(name, a_opts) else ::Logsly::Logging182::Appenders::IO.new(name, dev, a_opts) end logger = ::Logsly::Logging182::Logger.new(name) logger.add_appenders appender logger.additive = false class << logger def close @appenders.each {|a| a.close} h = ::Logsly::Logging182::Repository.instance.instance_variable_get :@h h.delete(@name) class << self; undef :close; end end end logger end |
.mdc ⇒ Object
Public: Accessor method for getting the current Thread’s MappedDiagnosticContext.
Returns MappedDiagnosticContext
243 |
# File 'lib/logsly/logging182/diagnostic_context.rb', line 243 def self.mdc() MappedDiagnosticContext end |
.ndc ⇒ Object
Public: Accessor method for getting the current Thread’s NestedDiagnosticContext.
Returns NestedDiagnosticContext
250 |
# File 'lib/logsly/logging182/diagnostic_context.rb', line 250 def self.ndc() NestedDiagnosticContext end |
.reopen ⇒ Object
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.
182 183 184 185 186 |
# File 'lib/logsly/logging182.rb', line 182 def reopen log_internal {'re-opening all appenders'} ::Logsly::Logging182::Appenders.each {|appender| appender.reopen} self end |
.reset ⇒ Object
Reset the Logsly::Logging182 framework to it’s uninitialized state
509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/logsly/logging182.rb', line 509 def reset ::Logsly::Logging182::Repository.reset ::Logsly::Logging182::Appenders.reset ::Logsly::Logging182::ColorScheme.reset ::Logsly::Logging182.clear_diagnostic_contexts(true) LEVELS.clear LNAMES.clear remove_instance_variable :@backtrace if defined? @backtrace remove_const :MAX_LEVEL_LENGTH if const_defined? :MAX_LEVEL_LENGTH remove_const :OBJ_FORMAT if const_defined? :OBJ_FORMAT self end |
.show_configuration(io = STDOUT, logger = 'root', indent = 0) ⇒ Object
call-seq:
show_configuration( io = STDOUT, logger = 'root' )
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.
463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/logsly/logging182.rb', line 463 def show_configuration( io = STDOUT, logger = 'root', indent = 0 ) logger = ::Logsly::Logging182::Logger[logger] unless ::Logsly::Logging182::Logger === logger logger._dump_configuration(io, indent) indent += 2 children = ::Logsly::Logging182::Repository.instance.children(logger.name) children.sort {|a,b| a.name <=> b.name}.each do |child| ::Logsly::Logging182.show_configuration(io, child, indent) end self end |
.shutdown(*args) ⇒ Object
Close all appenders
501 502 503 504 505 506 |
# File 'lib/logsly/logging182.rb', line 501 def shutdown( *args ) return unless initialized? log_internal {'shutdown called - closing all appenders'} ::Logsly::Logging182::Appenders.each {|appender| appender.close} nil end |