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:



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/logbrew.rb', line 209

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 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/logbrew.rb', line 249

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 



266
267
268
269
270
 
# File 'lib/logbrew.rb', line 266

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

  @client.flush(transport)
end