Class: SemanticLogger::Appender::File

Inherits:
Base
  • Object
show all
Defined in:
lib/semantic_logger/appender/file.rb

Instance Attribute Summary

Attributes inherited from Base

#formatter

Attributes inherited from Base

#level, #name

Instance Method Summary collapse

Methods inherited from Base

#default_formatter

Methods inherited from Base

default_level, default_level=, #payload, #tags, #with_payload, #with_tags

Constructor Details

#initialize(filename, level = nil, &block) ⇒ File

Create a File Logger appender instance

Example

require 'semantic_logger'

# Enable trace level logging
SemanticLogger::Logger.level = :info

# Log to screen
SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new(STDOUT)

# And log to a file at the same time
SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new('application.log')

logger =  SemanticLogger::Logger.new('test')
logger.info 'Hello World'

Example 2. To log all levels to file and only :info and above to screen:

require 'semantic_logger'

# Enable trace level logging
SemanticLogger::Logger.level = :trace

# Log to screen but only display :info and above
SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new(STDOUT, :info)

# And log to a file at the same time, including all :trace level data
SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new('application.log')

logger =  SemanticLogger::Logger.new('test')
logger.info 'Hello World'



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/semantic_logger/appender/file.rb', line 42

def initialize(filename, level=nil, &block)
  raise "logger cannot be null when initializing the SemanticLogging::Appender::Logger" unless filename
  @filename = filename
  @log = if filename.respond_to?(:write) and filename.respond_to?(:close)
    filename
  else
    @log = open(filename, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
    # Force all log entries to write immediately without buffering
    # Allows multiple processes to write to the same log file simultaneously
    @log.sync = true
    @log.set_encoding(Encoding::BINARY) if @log.respond_to?(:set_encoding)
    @log
  end

  # Set the log level and formatter if supplied
  super(level, &block)
end

Instance Method Details

#flush ⇒ Object

Flush all pending logs to disk.

Waits for all sent documents to be writted to disk



72
73
74
 
# File 'lib/semantic_logger/appender/file.rb', line 72

def flush
  @log.flush if @log.respond_to?(:flush)
end

#log(log) ⇒ Object

Pass log calls to the underlying Rails, log4j or Ruby logger

trace entries are mapped to debug since :trace is not supported by the
Ruby or Rails Loggers



63
64
65
66
67
68
 
# File 'lib/semantic_logger/appender/file.rb', line 63

def log(log)
  # Since only one appender thread will be writing to the file at a time
  # it is not necessary to protect access to the file with a semaphore
  # Allow this logger to filter out log levels lower than it's own
  @log.write(@formatter.call(log) << "\n") if level_index <= (log.level_index || 0)
end