Class: Twiglet::Logger

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

Constant Summary collapse

DEFAULT_VALIDATION_SCHEMA = 
File.read("#{__dir__}/validation_schema.json")

Instance Method Summary collapse

Constructor Details

#initialize(service_name, **args) ⇒ Logger

Returns a new instance of Logger.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/twiglet/logger.rb', line 16

def initialize(
  service_name,
  **args
)
  @service_name = service_name
  @args = args

  now = args.fetch(:now, -> { Time.now.utc })
  output = args.fetch(:output, $stdout)
  level = args.fetch(:level, DEBUG)
  validation_schema = args.fetch(:validation_schema, DEFAULT_VALIDATION_SCHEMA)

  raise 'Service name is mandatory' \
    unless service_name.is_a?(String) && !service_name.strip.empty?

  @validator = Validator.new(validation_schema)

  formatter = Twiglet::Formatter.new(
    service_name,
    default_properties: args.fetch(:default_properties, {}),
    context_provider: args[:context_provider],
    now: now,
    validator: @validator
  )
  super(output, formatter: formatter, level: level)
end

Instance Method Details

#configure_validation_error_response(&block) ⇒ Object 



43
44
45
 
# File 'lib/twiglet/logger.rb', line 43

def configure_validation_error_response(&block)
  @validator.custom_error_handler = block
end

#context_provider(&blk) ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/twiglet/logger.rb', line 78

def context_provider(&blk)
  self.class.new(
    @service_name,
    **@args.merge(context_provider: blk)
  )
end

#debug(message_or_error = nil, &block) ⇒ Object 



47
48
49
50
51
 
# File 'lib/twiglet/logger.rb', line 47

def debug(message_or_error = nil, &block)
  message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error

  super(message, &block)
end

#error(message = nil, error = nil, &block) ⇒ Object 



65
66
67
68
69
 
# File 'lib/twiglet/logger.rb', line 65

def error(message = nil, error = nil, &block)
  message = error_message(error, message) if error

  super(message, &block)
end

#info(message_or_error = nil, &block) ⇒ Object 



53
54
55
56
57
 
# File 'lib/twiglet/logger.rb', line 53

def info(message_or_error = nil, &block)
  message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error

  super(message, &block)
end

#warn(message_or_error = nil, &block) ⇒ Object Also known as: warning 



59
60
61
62
63
 
# File 'lib/twiglet/logger.rb', line 59

def warn(message_or_error = nil, &block)
  message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error

  super(message, &block)
end

#with(default_properties) ⇒ Object 



71
72
73
74
75
76
 
# File 'lib/twiglet/logger.rb', line 71

def with(default_properties)
  self.class.new(
    @service_name,
    **@args.merge(default_properties: default_properties)
  )
end