Class: SemanticLogger::Log
- Inherits:
-
Object
- Object
- SemanticLogger::Log
- Defined in:
- lib/semantic_logger/log.rb
Overview
Log
Class to hold all log entry information
level
Log level of the supplied log call
:trace, :debug, :info, :warn, :error, :fatal
thread_name
Name of the thread in which the logging call was called
name
Class name supplied to the logging instance
message
Text to be logged
payload
Optional Hash or Ruby Exception object to be logged
time
The time at which the log entry was created
duration
The time taken to complete a measure call
tags
Any tags active on the thread when the log call was made
level_index
Internal index of the log level
exception
Ruby Exception object to log
metric [Object]
Object supplied when measure_x was called
backtrace [Array<String>]
The backtrace captured at source when the log level >= SemanticLogger.backtrace_level
metric_amount [Numeric]
Used for numeric or counter metrics.
For example, the number of inquiries or, the amount purchased etc.
context [Hash]
Named contexts that were captured when the log entry was created.
Defined Under Namespace
Classes: DeprecatedLogger
Constant Summary collapse
- MAX_EXCEPTIONS_TO_UNWRAP =
5
- CALLER_REGEXP =
/^(.*):(\d+).*/
Instance Attribute Summary collapse
-
#backtrace ⇒ Object
Returns the value of attribute backtrace.
-
#context ⇒ Object
Returns the value of attribute context.
-
#dimensions ⇒ Object
Returns the value of attribute dimensions.
-
#duration ⇒ Object
Returns the value of attribute duration.
-
#exception ⇒ Object
Returns the value of attribute exception.
-
#level ⇒ Object
Returns the value of attribute level.
-
#level_index ⇒ Object
Returns the value of attribute level_index.
-
#message ⇒ Object
Returns the value of attribute message.
-
#metric ⇒ Object
Returns the value of attribute metric.
-
#metric_amount ⇒ Object
Returns the value of attribute metric_amount.
-
#name ⇒ Object
Returns the value of attribute name.
-
#named_tags ⇒ Object
Returns the value of attribute named_tags.
-
#payload ⇒ Object
Returns the value of attribute payload.
-
#tags ⇒ Object
Returns the value of attribute tags.
-
#thread_name ⇒ Object
Returns the value of attribute thread_name.
-
#time ⇒ Object
Returns the value of attribute time.
Instance Method Summary collapse
-
#assign(message: nil, payload: nil, min_duration: 0.0, exception: nil, metric: nil, metric_amount: nil, duration: nil, backtrace: nil, log_exception: :full, on_exception_level: nil, dimensions: nil) ⇒ Object
Assign named arguments to this log entry, supplying defaults where applicable.
-
#assign_positional(message = nil, payload = nil, exception = nil) ⇒ Object
Assign positional arguments to this log entry, supplying defaults where applicable.
-
#backtrace_to_s ⇒ Object
Returns [String] the exception backtrace including all of the child / caused by exceptions.
-
#cleansed_message ⇒ Object
Strip the standard Rails colorizing from the logged message.
-
#duration_human ⇒ Object
Returns [String] the duration in human readable form.
- #duration_to_s ⇒ Object
-
#each_exception ⇒ Object
Call the block for exception and any nested exception.
-
#extract_file_and_line(stack, short_name = false) ⇒ Object
Extract the filename and line number from the last entry in the supplied backtrace.
-
#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.
-
#formatted_time ⇒ Object
DEPRECATED.
-
#initialize(name, level, index = nil) ⇒ Log
constructor
A new instance of Log.
-
#level_to_s ⇒ Object
Returns [String] single character upper case log level.
-
#metric_only? ⇒ Boolean
A metric only event has a metric but no message or exception.
-
#payload? ⇒ Boolean
(also: #has_payload?)
Returns [true|false] whether the log entry has a payload.
-
#payload_to_s ⇒ Object
Return the payload in text form Returns nil if payload is missing or empty.
-
#process_info(thread_name_length = 30) ⇒ Object
Returns [String] the available process info Example: 18934:thread 23 test_logging.rb:51.
-
#set_context(key, value) ⇒ Object
Lazy initializes the context hash and assigns a key value pair.
-
#to_h(host = SemanticLogger.host, application = SemanticLogger.application) ⇒ Object
DEPRECATED: Use SemanticLogger::Formatters::Raw.
Constructor Details
#initialize(name, level, index = nil) ⇒ Log
Returns a new instance of Log.
55 56 57 58 59 60 61 62 63 |
# File 'lib/semantic_logger/log.rb', line 55 def initialize(name, level, index = nil) @level = level @thread_name = Thread.current.name @name = name @time = Time.now @tags = SemanticLogger. @named_tags = SemanticLogger. @level_index = index.nil? ? Levels.index(level) : index end |
Instance Attribute Details
#backtrace ⇒ Object
Returns the value of attribute backtrace.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def backtrace @backtrace end |
#context ⇒ Object
Returns the value of attribute context.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def context @context end |
#dimensions ⇒ Object
Returns the value of attribute dimensions.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def dimensions @dimensions end |
#duration ⇒ Object
Returns the value of attribute duration.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def duration @duration end |
#exception ⇒ Object
Returns the value of attribute exception.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def exception @exception end |
#level ⇒ Object
Returns the value of attribute level.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def level @level end |
#level_index ⇒ Object
Returns the value of attribute level_index.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def level_index @level_index end |
#message ⇒ Object
Returns the value of attribute message.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def @message end |
#metric ⇒ Object
Returns the value of attribute metric.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def metric @metric end |
#metric_amount ⇒ Object
Returns the value of attribute metric_amount.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def metric_amount @metric_amount end |
#name ⇒ Object
Returns the value of attribute name.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def name @name end |
#named_tags ⇒ Object
Returns the value of attribute named_tags.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def @named_tags end |
#payload ⇒ Object
Returns the value of attribute payload.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def payload @payload end |
#tags ⇒ Object
Returns the value of attribute tags.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def @tags end |
#thread_name ⇒ Object
Returns the value of attribute thread_name.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def thread_name @thread_name end |
#time ⇒ Object
Returns the value of attribute time.
50 51 52 |
# File 'lib/semantic_logger/log.rb', line 50 def time @time end |
Instance Method Details
#assign(message: nil, payload: nil, min_duration: 0.0, exception: nil, metric: nil, metric_amount: nil, duration: nil, backtrace: nil, log_exception: :full, on_exception_level: nil, dimensions: nil) ⇒ Object
Assign named arguments to this log entry, supplying defaults where applicable
Returns [true|false] whether this log entry should be logged
Example:
logger.info(name: 'value')
71 72 73 74 75 76 77 78 79 80 81 82 83 84 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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/semantic_logger/log.rb', line 71 def assign(message: nil, payload: nil, min_duration: 0.0, exception: nil, metric: nil, metric_amount: nil, duration: nil, backtrace: nil, log_exception: :full, on_exception_level: nil, dimensions: nil) # Elastic logging: Log when :duration exceeds :min_duration # Except if there is an exception when it will always be logged if duration self.duration = duration return false if (duration < min_duration) && exception.nil? end self. = if payload && payload.is_a?(Hash) self.payload = payload elsif payload self. = .nil? ? payload.to_s : "#{} -- #{payload}" self.payload = nil end if exception case log_exception when :full self.exception = exception when :partial self. = "#{} -- Exception: #{exception.class}: #{exception.}" when nil, :none # Log the message without the exception that was raised nil else raise(ArgumentError, "Invalid value:#{log_exception.inspect} for argument :log_exception") end # On exception change the log level if on_exception_level self.level = on_exception_level self.level_index = Levels.index(level) end end if backtrace self.backtrace = Utils.extract_backtrace(backtrace) elsif level_index >= SemanticLogger.backtrace_level_index self.backtrace = Utils.extract_backtrace end if metric self.metric = metric self.metric_amount = metric_amount self.dimensions = dimensions end true end |
#assign_positional(message = nil, payload = nil, exception = nil) ⇒ Object
Assign positional arguments to this log entry, supplying defaults where applicable
Returns [true|false] whether this log entry should be logged
Example:
logger.info('value', :debug, 0, "hello world")
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/semantic_logger/log.rb', line 137 def assign_positional( = nil, payload = nil, exception = nil) # Exception being logged? # Under JRuby a java exception is not a Ruby Exception # Java::JavaLang::ClassCastException.new.is_a?(Exception) => false if exception.nil? && payload.nil? && .respond_to?(:backtrace) && .respond_to?(:message) exception = = nil elsif exception.nil? && payload && payload.respond_to?(:backtrace) && payload.respond_to?(:message) exception = payload payload = nil elsif payload && !payload.is_a?(Hash) = .nil? ? payload : "#{} -- #{payload}" payload = nil end # Add result of block as message or payload if not nil if block_given? && (result = yield) if result.is_a?(String) = .nil? ? result : "#{} -- #{result}" assign(message: , payload: payload, exception: exception) elsif .nil? && result.is_a?(Hash) && %i[message payload exception].any? { |k| result.key? k } assign(result) elsif payload&.respond_to?(:merge) assign(message: , payload: payload.merge(result), exception: exception) else assign(message: , payload: result, exception: exception) end else assign(message: , payload: payload, exception: exception) end end |
#backtrace_to_s ⇒ Object
Returns [String] the exception backtrace including all of the child / caused by exceptions
193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/semantic_logger/log.rb', line 193 def backtrace_to_s trace = '' each_exception do |exception, i| if i.zero? trace = (exception.backtrace || []).join("\n") else trace << "\nCause: #{exception.class.name}: #{exception.}\n#{(exception.backtrace || []).join("\n")}" end end trace end |
#cleansed_message ⇒ Object
Strip the standard Rails colorizing from the logged message
267 268 269 |
# File 'lib/semantic_logger/log.rb', line 267 def .to_s.gsub(/(\e(\[([\d;]*[mz]?))?)?/, '').strip end |
#duration_human ⇒ Object
Returns [String] the duration in human readable form
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/semantic_logger/log.rb', line 220 def duration_human 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('%.3f', seconds)}s" else duration_to_s end end |
#duration_to_s ⇒ Object
209 210 211 |
# File 'lib/semantic_logger/log.rb', line 209 def duration_to_s "#{duration.to_i}ms" if duration end |
#each_exception ⇒ Object
Call the block for exception and any nested exception
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/semantic_logger/log.rb', line 171 def each_exception # 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
254 255 256 257 |
# File 'lib/semantic_logger/log.rb', line 254 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
261 262 263 264 |
# File 'lib/semantic_logger/log.rb', line 261 def file_name_and_line(short_name = false) stack = backtrace || exception&.backtrace extract_file_and_line(stack, short_name) if stack&.size&.positive? end |
#formatted_time ⇒ Object
DEPRECATED
286 287 288 |
# File 'lib/semantic_logger/log.rb', line 286 def formatted_time time.strftime(Formatters::Base.build_time_format) end |
#level_to_s ⇒ Object
Returns [String] single character upper case log level
237 238 239 |
# File 'lib/semantic_logger/log.rb', line 237 def level_to_s level.to_s[0..0].upcase end |
#metric_only? ⇒ Boolean
A metric only event has a metric but no message or exception.
304 305 306 |
# File 'lib/semantic_logger/log.rb', line 304 def metric_only? metric && .nil? && exception.nil? end |
#payload? ⇒ Boolean Also known as: has_payload?
Returns [true|false] whether the log entry has a payload
278 279 280 |
# File 'lib/semantic_logger/log.rb', line 278 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
273 274 275 |
# File 'lib/semantic_logger/log.rb', line 273 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
244 245 246 247 248 249 |
# File 'lib/semantic_logger/log.rb', line 244 def process_info(thread_name_length = 30) file, line = file_name_and_line(true) file_name = " #{file}:#{line}" if file "#{$$}:#{format("%.#{thread_name_length}s", thread_name)}#{file_name}" end |
#set_context(key, value) ⇒ Object
Lazy initializes the context hash and assigns a key value pair.
299 300 301 |
# File 'lib/semantic_logger/log.rb', line 299 def set_context(key, value) (self.context ||= {})[key] = value end |
#to_h(host = SemanticLogger.host, application = SemanticLogger.application) ⇒ Object
DEPRECATED: Use SemanticLogger::Formatters::Raw
293 294 295 296 |
# File 'lib/semantic_logger/log.rb', line 293 def to_h(host = SemanticLogger.host, application = SemanticLogger.application) logger = DeprecatedLogger.new(host, application) SemanticLogger::Formatters::Raw.new.call(self, logger) end |