Class: Lumberjack::LogEntry

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

Overview

An entry in a log is a data structure that captures the log message as well as information about the system that logged the message.

Constant Summary collapse

TIME_FORMAT = 
"%Y-%m-%dT%H:%M:%S"
UNIT_OF_WORK_ID = 
"unit_of_work_id"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(time, severity, message, progname, pid, tags) ⇒ LogEntry

Create a new log entry.

Parameters:

  • time (Time) —

    The time the log entry was created.

  • severity (Integer, String) —

    The severity of the log entry.

  • message (String) —

    The message to log.

  • progname (String) —

    The name of the program that created the log entry.

  • pid (Integer) —

    The process id of the program that created the log entry.

  • tags (Hash) —

    A hash of tags to associate with the log entry.



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/lumberjack/log_entry.rb', line 21

def initialize(time, severity, message, progname, pid, tags)
  @time = time
  @severity = (severity.is_a?(Integer) ? severity : Severity.label_to_level(severity))
  @message = message
  @progname = progname
  @pid = pid
  # backward compatibility with 1.0 API where the last argument was the unit of work id
  @tags = if tags.nil? || tags.is_a?(Hash)
    tags
  else
    {UNIT_OF_WORK_ID => tags}
  end
end

Instance Attribute Details

#message ⇒ Object

Returns the value of attribute message.



7
8
9
 
# File 'lib/lumberjack/log_entry.rb', line 7

def message
  @message
end

#pid ⇒ Object

Returns the value of attribute pid.



7
8
9
 
# File 'lib/lumberjack/log_entry.rb', line 7

def pid
  @pid
end

#progname ⇒ Object

Returns the value of attribute progname.



7
8
9
 
# File 'lib/lumberjack/log_entry.rb', line 7

def progname
  @progname
end

#severity ⇒ Object

Returns the value of attribute severity.



7
8
9
 
# File 'lib/lumberjack/log_entry.rb', line 7

def severity
  @severity
end

#tags ⇒ Object

Returns the value of attribute tags.



7
8
9
 
# File 'lib/lumberjack/log_entry.rb', line 7

def tags
  @tags
end

#time ⇒ Object

Returns the value of attribute time.



7
8
9
 
# File 'lib/lumberjack/log_entry.rb', line 7

def time
  @time
end

Instance Method Details

#inspect ⇒ Object 



43
44
45
 
# File 'lib/lumberjack/log_entry.rb', line 43

def inspect
  to_s
end

#severity_label ⇒ Object 



35
36
37
 
# File 'lib/lumberjack/log_entry.rb', line 35

def severity_label
  Severity.level_to_label(severity)
end

#tag(name) ⇒ Object

Return the tag with the specified name.



62
63
64
 
# File 'lib/lumberjack/log_entry.rb', line 62

def tag(name)
  tags[name.to_s] if tags
end

#to_s ⇒ Object 



39
40
41
 
# File 'lib/lumberjack/log_entry.rb', line 39

def to_s
  "[#{time.strftime(TIME_FORMAT)}.#{(time.usec / 1000.0).round.to_s.rjust(3, "0")} #{severity_label} #{progname}(#{pid})#{tags_to_s}] #{message}"
end

#unit_of_work_id ⇒ Object

Deprecated - backward compatibility with 1.0 API



48
49
50
 
# File 'lib/lumberjack/log_entry.rb', line 48

def unit_of_work_id
  tags[UNIT_OF_WORK_ID] if tags
end

#unit_of_work_id=(value) ⇒ Object

Deprecated - backward compatibility with 1.0 API



53
54
55
56
57
58
59
 
# File 'lib/lumberjack/log_entry.rb', line 53

def unit_of_work_id=(value)
  if tags
    tags[UNIT_OF_WORK_ID] = value
  else
    @tags = {UNIT_OF_WORK_ID => value}
  end
end