Module: Legion::Logging::Methods

Included in:
Legion::Logging, Logger
Defined in:
lib/legion/logging/methods.rb

Constant Summary collapse

COMPONENT_REGEX = 
%r{
  /(runners|actors|actor|helpers|hooks|absorbers|matchers|transport|
  exchanges|queues|messages|data|builders|tools|adapters|engines|
  formatters|parsers|middleware)/
}x
EXCEPTION_PRIORITY = 
{ warn: 0, error: 5, fatal: 9 }.freeze

Instance Method Summary collapse

Instance Method Details

#debug(message = nil) ⇒ Object 



29
30
31
32
33
34
35
36
 
# File 'lib/legion/logging/methods.rb', line 29

def debug(message = nil)
  return unless log.level < 1

  message = yield if message.nil? && block_given?
  raw = maybe_redact(message)
  formatted = format_message_for_level(:debug, raw)
  write_async_or_sync(:debug, formatted, raw)
end

#emit_tagged(level, message = nil, segments: nil, method_ctx: nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/legion/logging/methods.rb', line 83

def emit_tagged(level, message = nil, segments: nil, method_ctx: nil)
  level = level.to_sym
  message = yield if message.nil? && block_given?
  return if message.nil?

  raw = maybe_redact(message)
  formatted = format_message_for_level(level, raw)

  with_tagged_context(segments, method_ctx) do
    write_forced(level, formatted)
    fire_log_writer(level, raw) if %i[warn error fatal].include?(level)
  end
end

#error(message = nil) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/legion/logging/methods.rb', line 56

def error(message = nil)
  return unless log.level < 4

  message = yield if message.nil? && block_given?
  raw = maybe_redact(message)
  formatted = format_message_for_level(:error, raw)
  write_async_or_sync(:error, formatted, raw, writer_context: build_writer_context(:error, raw))
end

#fatal(message = nil) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/legion/logging/methods.rb', line 65

def fatal(message = nil)
  return unless log.level < 5

  message = yield if message.nil? && block_given?
  message = maybe_redact(message)
  raw = message
  message = Rainbow(message).darkred if @color
  log.fatal(message)
  fire_log_writer(:fatal, raw)
end

#info(message = nil) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/legion/logging/methods.rb', line 38

def info(message = nil)
  return unless log.level < 2

  message = yield if message.nil? && block_given?
  raw = maybe_redact(message)
  formatted = format_message_for_level(:info, raw)
  write_async_or_sync(:info, formatted, raw)
end

#log_exception(exception, level: :error, lex: nil, component_type: nil, gem_name: nil, lex_version: nil, gem_path: nil, source_code_uri: nil, handled: false, payload_summary: nil, task_id: nil, **extra) ⇒ Object 



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/legion/logging/methods.rb', line 102

def log_exception(exception, level: :error, lex: nil, component_type: nil,
                  gem_name: nil, lex_version: nil, gem_path: nil,
                  source_code_uri: nil, handled: false, payload_summary: nil,
                  task_id: nil, **extra)
  level = level.to_sym if level.respond_to?(:to_sym)
  # 1. Log human-readable line + backtrace to stdout/file (bypass writer callbacks)
  msg = exception.respond_to?(:message) ? exception.message : exception.to_s
  msg = maybe_redact(msg)
  bt = Array(exception.backtrace)
  if bt.any?
    lines = ["#{exception.class}: #{msg}"]
    bt.each { |frame| lines << "  #{frame}" }
    msg = lines.join("\n")
  end
  log.public_send(level, msg) if respond_to?(:log) && log.respond_to?(level)

  # 2. Build rich exception event
  event = Legion::Logging::EventBuilder.build_exception(
    exception:       exception,
    level:           level,
    lex:             lex,
    component_type:  component_type,
    gem_name:        gem_name,
    lex_version:     lex_version,
    gem_path:        gem_path,
    source_code_uri: source_code_uri,
    handled:         handled,
    payload_summary: payload_summary,
    task_id:         task_id,
    caller_offset:   3,
    **extra
  )

  # 3. Redact secrets before publishing
  event = Legion::Logging::Redactor.redact(event) if defined?(Legion::Logging::Redactor)

  # 4. Publish rich event via exception_writer
  publish_exception_event(event, level)
rescue StandardError => e
  if respond_to?(:log) && log.respond_to?(:warn)
    log.warn("Failed to publish structured exception event: #{e.class}: #{e.message}")
  else
    warn("Failed to publish structured exception event: #{e.class}: #{e.message}")
  end
end

#runner_exception(exc, **opts) ⇒ Object 



97
98
99
100
 
# File 'lib/legion/logging/methods.rb', line 97

def runner_exception(exc, **opts)
  log_exception(exc, handled: true, **opts)
  { success: false, message: exc.message, backtrace: exc.backtrace }.merge(opts)
end

#thread(kvl: false, **_opts) ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/legion/logging/methods.rb', line 148

def thread(kvl: false, **_opts)
  if kvl
    "thread=#{Thread.current.object_id}"
  else
    Thread.current.object_id.to_s
  end
end

#trace(raw_message = nil, size: @trace_size, log_caller: true) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/legion/logging/methods.rb', line 15

def trace(raw_message = nil, size: @trace_size, log_caller: true)
  return unless @trace_enabled

  raw_message = yield if raw_message.nil? && block_given?
  message = Rainbow('Tracing: ').cyan
  message.concat Rainbow("#{raw_message} ").cyan
  if log_caller && size.nil?
    message.concat Rainbow(caller_locations).cyan.underline
  elsif log_caller
    message.concat Rainbow(caller_locations[0..size]).cyan.underline
  end
  log.unknown(message)
end

#unknown(message = nil) ⇒ Object 



76
77
78
79
80
81
 
# File 'lib/legion/logging/methods.rb', line 76

def unknown(message = nil)
  message = yield if message.nil? && block_given?
  raw = maybe_redact(message)
  formatted = format_message_for_level(:unknown, raw)
  write_async_or_sync(:unknown, formatted, raw)
end

#warn(message = nil) ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'lib/legion/logging/methods.rb', line 47

def warn(message = nil)
  return unless log.level < 3

  message = yield if message.nil? && block_given?
  raw = maybe_redact(message)
  formatted = format_message_for_level(:warn, raw)
  write_async_or_sync(:warn, formatted, raw, writer_context: build_writer_context(:warn, raw))
end