Class: Syslogger

Inherits:
Object
  • Object
show all
Defined in:
lib/syslogger.rb

Constant Summary collapse

VERSION =
"1.6.0"
MAPPING =
{
  Logger::DEBUG => Syslog::LOG_DEBUG,
  Logger::INFO => Syslog::LOG_INFO,
  Logger::WARN => Syslog::LOG_WARNING,
  Logger::ERROR => Syslog::LOG_ERR,
  Logger::FATAL => Syslog::LOG_CRIT,
  Logger::UNKNOWN => Syslog::LOG_ALERT
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ident = $0, options = Syslog::LOG_PID | Syslog::LOG_CONS, facility = nil) ⇒ Syslogger

Initializes default options for the logger

ident

the name of your program [default=$0].

options

syslog options [default=Syslog::LOG_PID | Syslog::LOG_CONS]. Correct values are:

LOG_CONS    : writes the message on the console if an error occurs when sending the message;
LOG_NDELAY  : no delay before sending the message;
LOG_PERROR  : messages will also be written on STDERR;
LOG_PID     : adds the process number to the message (just after the program name)
facility

the syslog facility [default=nil] Correct values include:

Syslog::LOG_DAEMON
Syslog::LOG_USER
Syslog::LOG_SYSLOG
Syslog::LOG_LOCAL2
Syslog::LOG_NEWS
etc.

Usage:

logger = Syslogger.new("my_app", Syslog::LOG_PID | Syslog::LOG_CONS, Syslog::LOG_LOCAL0)
logger.level = Logger::INFO # use Logger levels
logger.warn "warning message"
logger.debug "debug message"


44
45
46
47
48
49
50
51
# File 'lib/syslogger.rb', line 44

def initialize(ident = $0, options = Syslog::LOG_PID | Syslog::LOG_CONS, facility = nil)
  @ident = ident
  @options = options || (Syslog::LOG_PID | Syslog::LOG_CONS)
  @facility = facility
  @level = Logger::INFO
  @mutex = Mutex.new
  @formatter = Logger::Formatter.new
end

Instance Attribute Details

#facilityObject (readonly)

Returns the value of attribute facility



9
10
11
# File 'lib/syslogger.rb', line 9

def facility
  @facility
end

#formatterObject

Returns the value of attribute formatter



10
11
12
# File 'lib/syslogger.rb', line 10

def formatter
  @formatter
end

#identObject

Returns the value of attribute ident



9
10
11
# File 'lib/syslogger.rb', line 9

def ident
  @ident
end

#levelObject

Returns the value of attribute level



9
10
11
# File 'lib/syslogger.rb', line 9

def level
  @level
end

#max_octetsObject

Returns the value of attribute max_octets



9
10
11
# File 'lib/syslogger.rb', line 9

def max_octets
  @max_octets
end

#optionsObject (readonly)

Returns the value of attribute options



9
10
11
# File 'lib/syslogger.rb', line 9

def options
  @options
end

Instance Method Details

#<<(msg) ⇒ Object

Logs a message at the Logger::INFO level.



75
76
77
# File 'lib/syslogger.rb', line 75

def <<(msg)
  add(Logger::INFO, msg)
end

#add(severity, message = nil, progname = nil, &block) ⇒ Object

Low level method to add a message.

severity

the level of the message. One of Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR, Logger::FATAL, Logger::UNKNOWN

message

the message string. If nil, the method will call the block and use the result as the message string. If both are nil or no block is given, it will use the progname as per the behaviour of both the standard Ruby logger, and the Rails BufferedLogger.

progname

optionally, overwrite the program name that appears in the log message.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/syslogger.rb', line 85

def add(severity, message = nil, progname = nil, &block)
  if message.nil? && block.nil? && !progname.nil?
    message, progname = progname, nil
  end
  progname ||= @ident

  @mutex.synchronize do
    Syslog.open(progname, @options, @facility) do |s|
      s.mask = Syslog::LOG_UPTO(MAPPING[@level])
      communication = clean(message || block && block.call)
      if self.max_octets
        buffer = "#{tags_text}"
        communication.bytes do |byte|
          buffer.concat(byte)
          # if the last byte we added is potentially part of an escape, we'll go ahead and add another byte
          if buffer.bytesize >= self.max_octets && !['%'.ord,'\\'.ord].include?(byte)
            s.log(MAPPING[severity],buffer)
            buffer = ""
          end
        end
        s.log(MAPPING[severity],buffer) unless buffer.empty?
      else
        s.log(MAPPING[severity],"#{tags_text}#{communication}")
      end
    end
  end
end

#clear_tags!Object



153
154
155
# File 'lib/syslogger.rb', line 153

def clear_tags!
  current_tags.clear
end

#pop_tags(size = 1) ⇒ Object



149
150
151
# File 'lib/syslogger.rb', line 149

def pop_tags(size = 1)
  current_tags.pop size
end

#push_tags(*tags) ⇒ Object



143
144
145
146
147
# File 'lib/syslogger.rb', line 143

def push_tags(*tags)
  tags.flatten.reject{ |i| i.respond_to?(:empty?) ? i.empty? : !i }.tap do |new_tags|
    current_tags.concat new_tags
  end
end

#tagged(*tags) ⇒ Object

Tagging code borrowed from ActiveSupport gem



136
137
138
139
140
141
# File 'lib/syslogger.rb', line 136

def tagged(*tags)
  new_tags = push_tags(*tags)
  yield self
ensure
  pop_tags(new_tags.size)
end

#write(msg) ⇒ Object

Log a message at the Logger::INFO level. Useful for use with Rack::CommonLogger



70
71
72
# File 'lib/syslogger.rb', line 70

def write(msg)
  add(Logger::INFO, msg)
end