Class: Sapience::Log

Inherits:
Struct
  • Object
show all
Defined in:
lib/sapience/log.rb

Overview

rubocop:disable LineLength

Constant Summary collapse

MAX_EXCEPTIONS_TO_UNWRAP = 
5
CALLER_REGEXP = 
/^(.*):(\d+).*/

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#backtrace ⇒ Object

Returns the value of attribute backtrace

Returns:

  • (Object) —

    the current value of backtrace



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def backtrace
  @backtrace
end

#duration ⇒ Object

Returns the value of attribute duration

Returns:

  • (Object) —

    the current value of duration



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def duration
  @duration
end

#exception ⇒ Object

Returns the value of attribute exception

Returns:

  • (Object) —

    the current value of exception



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def exception
  @exception
end

#level ⇒ Object

Returns the value of attribute level

Returns:

  • (Object) —

    the current value of level



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def level
  @level
end

#level_index ⇒ Object

Returns the value of attribute level_index

Returns:

  • (Object) —

    the current value of level_index



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def level_index
  @level_index
end

#message ⇒ Object

Returns the value of attribute message

Returns:

  • (Object) —

    the current value of message



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def message
  @message
end

#metric ⇒ Object

Returns the value of attribute metric

Returns:

  • (Object) —

    the current value of metric



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def metric
  @metric
end

#metric_amount ⇒ Object

Returns the value of attribute metric_amount

Returns:

  • (Object) —

    the current value of metric_amount



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def metric_amount
  @metric_amount
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def name
  @name
end

#payload ⇒ Object

Returns the value of attribute payload

Returns:

  • (Object) —

    the current value of payload



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def payload
  @payload
end

#tags ⇒ Object

Returns the value of attribute tags

Returns:

  • (Object) —

    the current value of tags



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def tags
  @tags
end

#thread_name ⇒ Object

Returns the value of attribute thread_name

Returns:

  • (Object) —

    the current value of thread_name



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def thread_name
  @thread_name
end

#time ⇒ Object

Returns the value of attribute time

Returns:

  • (Object) —

    the current value of time



48
49
50
 
# File 'lib/sapience/log.rb', line 48

def time
  @time
end

Instance Method Details

#backtrace_to_s ⇒ Object

Returns [String] the exception backtrace including all of the child / caused by exceptions



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sapience/log.rb', line 73

def backtrace_to_s
  trace = ""
  each_exception do |exception, i|
    if i == 0
      trace = (exception.backtrace || []).join("\n")
    else
      trace << "\nCause: #{exception.class.name}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
    end
  end
  trace
end

#cleansed_message ⇒ Object

Strip the standard Rails colorizing from the logged message



141
142
143
 
# File 'lib/sapience/log.rb', line 141

def cleansed_message
  message.to_s.gsub(/(\e(\[([\d;]*[mz]?))?)?/, "").strip
end

#duration_human ⇒ Object

Returns [String] the duration in human readable form



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/sapience/log.rb', line 93

def duration_human # rubocop:disable AbcSize
  return nil unless duration
  seconds = duration / 1000
  if seconds >= 86_400.0 # 1 day
    "#{(seconds / 86_400).to_i}d #{Time.at(seconds).strftime("%-Hh %-Mm")}"
  elsif seconds >= 3600.0 # 1 hour
    Time.at(seconds).strftime("%-Hh %-Mm")
  elsif seconds >= 60.0 # 1 minute
    Time.at(seconds).strftime("%-Mm %-Ss")
  elsif seconds >= 1.0 # 1 second
    format "%.3fs", seconds
  else
    duration_to_s
  end
end

#duration_to_s ⇒ Object

Returns [String] duration of the log entry as a string Returns nil if their is no duration



87
88
89
90
 
# File 'lib/sapience/log.rb', line 87

def duration_to_s
  return unless duration
  format((duration < 10.0 ? "%.3fms" : "%.1fms"), duration)
end

#each_exception ⇒ Object

Call the block for exception and any nested exception



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/sapience/log.rb', line 51

def each_exception # rubocop:disable AbcSize, PerceivedComplexity, CyclomaticComplexity
  # With thanks to https://github.com/bugsnag/bugsnag-ruby/blob/6348306e44323eee347896843d16c690cd7c4362/lib/bugsnag/notification.rb#L81
  depth      = 0
  exceptions = []
  ex         = exception
  while !ex.nil? && !exceptions.include?(ex) && exceptions.length < MAX_EXCEPTIONS_TO_UNWRAP
    exceptions << ex
    yield(ex, depth)

    depth += 1
    ex    =
      if ex.respond_to?(:cause) && ex.cause
        ex.cause
      elsif ex.respond_to?(:continued_exception) && ex.continued_exception
        ex.continued_exception
      elsif ex.respond_to?(:original_exception) && ex.original_exception
        ex.original_exception
      end
  end
end

#extract_file_and_line(stack, short_name = false) ⇒ Object

Extract the filename and line number from the last entry in the supplied backtrace



127
128
129
130
 
# File 'lib/sapience/log.rb', line 127

def extract_file_and_line(stack, short_name = false)
  match = CALLER_REGEXP.match(stack.first)
  [short_name ? File.basename(match[1]) : match[1], match[2].to_i]
end

#file_name_and_line(short_name = false) ⇒ Object

Returns [String, String] the file_name and line_number from the backtrace supplied in either the backtrace or exception



134
135
136
137
138
 
# File 'lib/sapience/log.rb', line 134

def file_name_and_line(short_name = false) # rubocop:disable CyclomaticComplexity
  return unless backtrace || (exception && exception.backtrace)
  stack = backtrace || exception.backtrace
  extract_file_and_line(stack, short_name) if stack && stack.size > 0
end

#formatted_time ⇒ Object

Return the Time as a formatted string Ruby MRI supports micro seconds DEPRECATED



159
160
161
 
# File 'lib/sapience/log.rb', line 159

def formatted_time
  format("#{time.strftime("%Y-%m-%d %H:%M:%S")}.%06d", time.usec)
end

#level_to_s ⇒ Object

Returns [String] single character upper case log level



110
111
112
 
# File 'lib/sapience/log.rb', line 110

def level_to_s
  level.to_s[0..0].upcase
end

#payload? ⇒ Boolean

Returns [true|false] whether the log entry has a payload

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/sapience/log.rb', line 152

def payload?
  !(payload.nil? || (payload.respond_to?(:empty?) && payload.empty?))
end

#payload_to_s ⇒ Object

Return the payload in text form Returns nil if payload is missing or empty



147
148
149
 
# File 'lib/sapience/log.rb', line 147

def payload_to_s
  payload.inspect if payload?
end

#process_info(thread_name_length = 30) ⇒ Object

Returns [String] the available process info Example:

18934:thread 23 test_logging.rb:51



117
118
119
120
121
122
 
# File 'lib/sapience/log.rb', line 117

def process_info(thread_name_length = 30)
  file, line = file_name_and_line(true)
  file_name  = " #{file}:#{line}" if file

  format "#{$PROCESS_ID}:%.#{thread_name_length}s#{file_name}", thread_name
end

#to_h(host = Sapience.config.host, application = Sapience.config.application) ⇒ Object

Returns [Hash] representation of this log entry



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/sapience/log.rb', line 164

def to_h(host = Sapience.config.host, application = Sapience.config.application) # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity, LineLength
  # Header
  h               = {
    name:        name,
    pid:         $PROCESS_ID,
    thread:      thread_name,
    time:        time,
    level:       level,
    level_index: level_index,
  }
  h[:host]        = host if host
  h[:application] = application if application
  file, line      = file_name_and_line
  if file
    h[:file] = file
    h[:line] = line.to_i
  end

  # Tags
  h[:tags] = tags if tags && (tags.size > 0)

  # Duration
  if duration
    h[:duration_ms] = duration
    h[:duration]    = duration_human
  end

  # Log message
  h[:message] = cleansed_message if message

  # Payload
  if payload
    if payload.is_a?(Hash)
      h.merge!(payload)
    else
      h[:payload] = payload
    end
  end

  # Exceptions
  if exception
    root = h
    each_exception do |exception, i|
      name       = i == 0 ? :exception : :cause
      root[name] = {
        name:        exception.class.name,
        message:     exception.message,
        stack_trace: exception.backtrace,
      }
      root       = root[name]
    end
  end

  # Metric
  h[:metric] = metric if metric
  h
end