Class: LogBrew::Logger

Inherits:
Logger
  • Object
show all
Includes:
TraceLoggerMethods
Defined in:
lib/logbrew.rb

Constant Summary collapse

DEFAULT_LOGGER_NAME = 
"ruby-logger"
SEVERITY_TO_LOGBREW_LEVEL = 
{
  ::Logger::DEBUG => "info",
  ::Logger::INFO => "info",
  ::Logger::WARN => "warning",
  ::Logger::ERROR => "error",
  ::Logger::FATAL => "critical",
  ::Logger::UNKNOWN => "error"
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(client:, logdev: File::NULL, logger_name: nil, event_id_prefix: "ruby_log", metadata: nil, transport: nil, flush_on_log: false, include_exception_backtrace: false, timestamp_provider: nil, on_error: nil, raise_errors: false, level: ::Logger::DEBUG, progname: nil, formatter: nil, datetime_format: nil) ⇒ Logger

Returns a new instance of Logger.

Raises:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/logbrew.rb', line 242

def initialize(
  client:,
  logdev: File::NULL,
  logger_name: nil,
  event_id_prefix: "ruby_log",
  metadata: nil,
  transport: nil,
  flush_on_log: false,
  include_exception_backtrace: false,
  timestamp_provider: nil,
  on_error: nil,
  raise_errors: false,
  level: ::Logger::DEBUG,
  progname: nil,
  formatter: nil,
  datetime_format: nil
)
  Validation.require_non_empty("logger name", logger_name) unless logger_name.nil?
  Validation.require_non_empty("event id prefix", event_id_prefix)
  raise SdkError.new("validation_error", "metadata must be an object") unless metadata.nil? || metadata.is_a?(Hash)

  @client = client
  @logger_name = logger_name
  @event_id_prefix = event_id_prefix
  @metadata = metadata || {}
  @transport = transport
  @flush_on_log = flush_on_log
  @include_exception_backtrace = include_exception_backtrace
  @timestamp_provider = timestamp_provider
  @on_error = on_error
  @raise_errors = raise_errors
  @next_event_number = 0

  super(logdev || File::NULL)
  self.level = level
  self.progname = progname unless progname.nil?
  self.formatter = formatter unless formatter.nil?
  self.datetime_format = datetime_format unless datetime_format.nil?
end

Instance Method Details

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/logbrew.rb', line 282

def add(severity, message = nil, progname = nil)
  severity = ::Logger::UNKNOWN if severity.nil?
  return true if severity < level

  resolved_message, resolved_progname = resolve_log_arguments(message, progname, block_given?) do
    yield
  end

  begin
    capture_logbrew_event(severity, resolved_message, resolved_progname)
  rescue StandardError => error
    handle_logbrew_error(error)
  end

  super(severity, resolved_message, resolved_progname)
end

#flush_logbrew(transport = @transport) ⇒ Object 



299
300
301
302
303
 
# File 'lib/logbrew.rb', line 299

def flush_logbrew(transport = @transport)
  return nil if transport.nil? || @client.pending_events.zero?

  @client.flush(transport)
end