class Tennpipes::Logger
Tennpipess internal logger, using all of Tennpipes
log extensions.
Constants
- Config
Configuration for a given environment, possible options are:
- :log_level
-
Once of [:fatal, :error, :warn, :info, :debug]
- :stream
-
Once of [:to_file, :null, :stdout, :stderr] our your custom stream
- :log_level
-
The log level from, e.g. :fatal or :info. Defaults to :warn in the production environment and :debug otherwise.
- :auto_flush
-
Whether the log should automatically flush after new messages are added. Defaults to true.
- :format_datetime
-
Format of datetime. Defaults to: “%d/%b/%Y %H:%M:%S”
- :format_message
-
Format of message. Defaults to: “”%s - - [%s] "%s"“”
- :log_static
-
Whether or not to show log messages for static files. Defaults to: false
- :colorize_logging
-
Whether or not to colorize log messages. Defaults to: true
@example
Tennpipes::Logger::Config[:development] = { :log_level => :debug, :stream => :to_file } # or you can edit our defaults Tennpipes::Logger::Config[:development][:log_level] = :error # or you can use your stream Tennpipes::Logger::Config[:development][:stream] = StringIO.new
Defaults are:
:production => { :log_level => :warn, :stream => :to_file } :development => { :log_level => :debug, :stream => :stdout } :test => { :log_level => :fatal, :stream => :null }
In some cases, configuring the loggers before loading the framework is necessary. You can do so by setting TENNPIPES_LOGGER:
TENNPIPES_LOGGER = { :staging => { :log_level => :debug, :stream => :to_file }}
- Levels
Ruby (standard) logger levels:
- :fatal
-
An not handleable error that results in a program crash
- :error
-
A handleable error condition
- :warn
-
A warning
- :info
-
generic (useful) information about system operation
- :debug
-
low-level information for developers
- :devel
-
Development-related information that is unnecessary in debug mode
Attributes
Public Class Methods
# File lib/tennpipes-base/logger.rb, line 304 def self.logger @_logger || setup! end
# File lib/tennpipes-base/logger.rb, line 308 def self.logger=(logger) logger.extend(Tennpipes::Logger::Extensions) @_logger = logger end
To initialize the logger you create a new object, proxies to set_log.
@param [Hash] options
@option options [Symbol] :stream ($stdout)
Either an IO object or a name of a logfile. Defaults to $stdout
@option options [Symbol] :log_level (:production in the production environment and :debug otherwise)
The log level from, e.g. :fatal or :info.
@option options [Symbol] :auto_flush (true)
Whether the log should automatically flush after new messages are added. Defaults to true.
@option options [Symbol] :format_datetime (“ [%d/%b/%Y %H:%M:%S] ”)
Format of datetime.
@option options [Symbol] :format_message (“%s -%s%s”)
Format of message.
@option options [Symbol] :log_static (false)
Whether or not to show log messages for static files.
@option options [Symbol] :colorize_logging (true)
Whether or not to colorize log messages. Defaults to: true.
# File lib/tennpipes-base/logger.rb, line 371 def initialize(options={}) @buffer = [] @auto_flush = options.has_key?(:auto_flush) ? options[:auto_flush] : true @level = options[:log_level] ? Tennpipes::Logger::Levels[options[:log_level]] : Tennpipes::Logger::Levels[:debug] @log = options[:stream] || $stdout @log.sync = true @format_datetime = options[:format_datetime] || "%d/%b/%Y %H:%M:%S" @format_message = options[:format_message] || "%s - %s %s" @log_static = options.has_key?(:log_static) ? options[:log_static] : false @colorize_logging = options.has_key?(:colorize_logging) ? options[:colorize_logging] : true @source_location = options[:source_location] colorize! if @colorize_logging end
Setup a new logger.
@return [Tennpipes::Logger]
A {Tennpipes::Logger} instance
# File lib/tennpipes-base/logger.rb, line 320 def self.setup! self.logger = begin config_level = (TENNPIPES_LOG_LEVEL || Tennpipes.env || :test).to_sym # need this for TENNPIPES_LOG_LEVEL config = Config[config_level] unless config warn("No logging configuration for :#{config_level} found, falling back to :production") config = Config[:production] end stream = case config[:stream] when :to_file FileUtils.mkdir_p(Tennpipes.root('log')) unless File.exist?(Tennpipes.root('log')) File.new(Tennpipes.root('log', "#{Tennpipes.env}.log"), 'a+') when :null then StringIO.new when :stdout then $stdout when :stderr then $stderr else config[:stream] # return itself, probabilly is a custom stream. end Tennpipes::Logger.new(config.merge(:stream => stream)) end end
Public Instance Methods
Directly append message to the log.
@param [String] message
The message
# File lib/tennpipes-base/logger.rb, line 424 def <<(message = nil) message << "\n" unless message[-1] == ?\n @@mutex.synchronize { @buffer << message } flush if @auto_flush message end
Adds a message to the log - for compatibility with other loggers.
# File lib/tennpipes-base/logger.rb, line 414 def add(level, message = nil) write(message) end
Close and remove the current log object.
@return [NilClass]
# File lib/tennpipes-base/logger.rb, line 405 def close flush @log.close if @log.respond_to?(:close) && !@log.tty? @log = nil end
Flush the entire buffer to the log object.
# File lib/tennpipes-base/logger.rb, line 392 def flush return unless @buffer.size > 0 @@mutex.synchronize do @log.write(@buffer.join('')) @buffer.clear end end
# File lib/tennpipes-base/logger.rb, line 434 def format(message, level) @format_message % [stylized_level(level), colorize(Time.now.strftime(@format_datetime), :yellow), message.to_s.strip] end
# File lib/tennpipes-base/logger.rb, line 385 def source_location? !!@source_location end