Class: Timber::LogEntry

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

Overview

Represents a new log entry into the log. This is an intermediary class between ‘Logger` and the log device that you set it up with.

Constant Summary collapse

BINARY_LIMIT_THRESHOLD =

:nodoc:

1_000.freeze
DT_PRECISION = 
6.freeze
MESSAGE_MAX_BYTES = 
8192.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(level, time, progname, message, context_snapshot, event, options = {}) ⇒ LogEntry

Creates a log entry suitable to be sent to the Timber API.

Parameters:

  • level (Integer) —

    the log level / severity

  • time (Time) —

    the exact time the log message was written

  • progname (String) —

    the progname scope for the log message

  • message (String) —

    Human readable log message.

  • context_snapshot (Hash) —

    structured data representing a snapshot of the context at the given point in time.

  • event (Timber.Event) —

    structured data representing the log line event. This should be an instance of Event.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/timber/log_entry.rb', line 27

def initialize(level, time, progname, message, context_snapshot, event, options = {})
  @level = level
  @time = time.utc
  @progname = progname

  # If the message is not a string we call inspect to ensure it is a string.
  # This follows the default behavior set by ::Logger
  # See: https://github.com/ruby/ruby/blob/trunk/lib/logger.rb#L615
  @message = message.is_a?(String) ? message : message.inspect
  @message = @message.byteslice(0, MESSAGE_MAX_BYTES)
  @tags = options[:tags]
  @context_snapshot = context_snapshot
  @event = event
end

Instance Attribute Details

#context_snapshot ⇒ Object (readonly)

Returns the value of attribute context_snapshot.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def context_snapshot
  @context_snapshot
end

#event ⇒ Object (readonly)

Returns the value of attribute event.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def event
  @event
end

#level ⇒ Object (readonly)

Returns the value of attribute level.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def level
  @level
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def message
  @message
end

#progname ⇒ Object (readonly)

Returns the value of attribute progname.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def progname
  @progname
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def tags
  @tags
end

#time ⇒ Object (readonly)

Returns the value of attribute time.



15
16
17
 
# File 'lib/timber/log_entry.rb', line 15

def time
  @time
end

Instance Method Details

#inspect ⇒ Object 



76
77
78
 
# File 'lib/timber/log_entry.rb', line 76

def inspect
  to_s
end

#to_hash(options = {}) ⇒ Object

Builds a hash representation containing simple objects, suitable for serialization (JSON).



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/timber/log_entry.rb', line 43

def to_hash(options = {})
  options ||= {}
  hash = {
    :level => level,
    :dt => formatted_dt,
    :message => message
  }

  if !tags.nil? && tags.length > 0
    hash[:tags] = tags
  end

  if !event.nil?
    hash.merge!(event)
  end

  if !context_snapshot.nil? && context_snapshot.length > 0
    hash[:context] = context_snapshot
  end

  if options[:only]
    hash.select do |key, _value|
      options[:only].include?(key)
    end
  elsif options[:except]
    hash.select do |key, _value|
      !options[:except].include?(key)
    end
  else
    hash
  end
end

#to_json(options = {}) ⇒ Object 



80
81
82
 
# File 'lib/timber/log_entry.rb', line 80

def to_json(options = {})
  to_hash.to_json
end

#to_msgpack(*args) ⇒ Object 



84
85
86
 
# File 'lib/timber/log_entry.rb', line 84

def to_msgpack(*args)
  to_hash.to_msgpack(*args)
end

#to_s ⇒ Object

This is used when LogEntry objects make it to a non-Timber logger.



89
90
91
 
# File 'lib/timber/log_entry.rb', line 89

def to_s
  message + "\n"
end