Class: Attio::Logger

Inherits:
Logger
  • Object
show all
Defined in:
lib/attio/logger.rb

Overview

Enhanced logger for structured logging with JSON formatting

This logger extends Ruby's standard Logger to provide structured logging with contextual information and JSON output.

Examples:

Basic usage

logger = Attio::Logger.new(STDOUT)
logger.info("API request", method: "GET", path: "/users")

Since:

  • 1.0.0

Instance Method Summary collapse

Constructor Details

#initialize(logdev, level: ::Logger::INFO, formatter: nil) ⇒ Logger

Returns a new instance of Logger.

Since:

  • 1.0.0



16
17
18
19
20
 
# File 'lib/attio/logger.rb', line 16

def initialize(logdev, level: ::Logger::INFO, formatter: nil)
  super(logdev)
  self.level = level
  self.formatter = formatter || default_formatter
end

Instance Method Details

#debug(message, **context) ⇒ Object

Since:

  • 1.0.0



22
23
24
 
# File 'lib/attio/logger.rb', line 22

def debug(message, **context)
  super(format_message(message, context))
end

#default_formatter ⇒ Object (private)

Since:

  • 1.0.0



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/attio/logger.rb', line 47

private def default_formatter
  proc do |severity, datetime, progname, msg|
    data = {
      timestamp: datetime.iso8601,
      level: severity,
      progname: progname,
    }

    if msg.is_a?(Hash)
      data.merge!(msg)
    else
      data[:message] = msg
    end

    "#{JSON.generate(data)}\n"
  end
end

#error(message, **context) ⇒ Object

Since:

  • 1.0.0



34
35
36
 
# File 'lib/attio/logger.rb', line 34

def error(message, **context)
  super(format_message(message, context))
end

#format_message(message, context) ⇒ Object (private)

Since:

  • 1.0.0



38
39
40
41
42
43
44
45
 
# File 'lib/attio/logger.rb', line 38

private def format_message(message, context)
  return message if context.empty?

  {
    message: message,
    **context,
  }
end

#info(message, **context) ⇒ Object

Since:

  • 1.0.0



26
27
28
 
# File 'lib/attio/logger.rb', line 26

def info(message, **context)
  super(format_message(message, context))
end

#warn(message, **context) ⇒ Object

Since:

  • 1.0.0



30
31
32
 
# File 'lib/attio/logger.rb', line 30

def warn(message, **context)
  super(format_message(message, context))
end