Module: Legion::Logging::EventBuilder

Defined in:
lib/legion/logging/event_builder.rb

Constant Summary collapse

MAX_MESSAGE_BYTES = 
4096
MAX_PAYLOAD_BYTES = 
8192
MAX_TOTAL_BYTES = 
65_536
BACKTRACE_FALLBACK_FRAMES = 
20
MIN_TRUNCATED_FIELD_BYTES = 
256
CORE_EXCEPTION_FIELDS = 
%i[
  timestamp
  level
  exception_class
  message
  caller_file
  caller_line
  caller_function
  lex
  component_type
  gem_name
  lex_version
  handled
  pid
  thread
  task_id
  conversation_id
  user
  error_fingerprint
  node
].freeze

Class Method Summary collapse

Class Method Details

.build(level:, message:, lex: nil, lex_segments: nil, context: nil, category: nil, caller_offset: 2) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/legion/logging/event_builder.rb', line 42

def build(level:, message:, lex: nil, lex_segments: nil, context: nil, category: nil, caller_offset: 2)
  event = base_fields(level, message)
  event[:lex] = derive_lex_source(lex, lex_segments)
  add_node(event)
  add_caller_info(event, caller_offset)
  add_exception_info(event, message)
  add_gem_info(event, event[:lex])
  event[:context] = context if context
  event[:category] = category.to_s if category
  event.compact
end

.build_exception(exception:, level:, 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, caller_offset: 2, **extra) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/legion/logging/event_builder.rb', line 54

def build_exception(
  exception:,
  level:,
  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,
  caller_offset: 2,
  **extra
)
  bt = Array(exception.backtrace)
  cf_file, cf_line, cf_func = parse_backtrace_location(bt.first) ||
                              caller_location(caller_offset)

  event = {
    timestamp:       Time.now.utc.iso8601(3),
    level:           level,
    exception_class: exception.class.name,
    message:         truncate_bytes(exception.message.to_s, MAX_MESSAGE_BYTES),
    backtrace:       bt,
    caller_file:     cf_file,
    caller_line:     cf_line,
    caller_function: cf_func,
    lex:             lex,
    component_type:  component_type,
    gem_name:        gem_name,
    lex_version:     lex_version,
    gem_path:        gem_path,
    source_code_uri: source_code_uri,
    legion_versions: legion_versions,
    ruby_version:    "#{RUBY_VERSION} #{RUBY_PLATFORM}",
    handled:         handled,
    pid:             ::Process.pid,
    thread:          Thread.current.object_id
  }

  event[:task_id] = task_id if task_id
  event[:payload_summary] = truncate_payload(payload_summary) if payload_summary

  add_node(event)
  add_user(event)
  add_session_context(event)

  event[:error_fingerprint] = fingerprint(
    exception_class: exception.class.name,
    message:         event[:message],
    caller_file:     cf_file.to_s,
    caller_line:     cf_line.to_i,
    caller_function: cf_func.to_s,
    gem_name:        gem_name.to_s,
    component_type:  component_type.to_s,
    backtrace:       bt
  )

  extra.each { |k, v| event[k] = v unless event.key?(k) }

  enforce_total_size!(event)
  event.compact
end

.fingerprint(exception_class:, message:, caller_file:, caller_line:, caller_function:, gem_name:, component_type:, backtrace:) ⇒ Object 



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
 
# File 'lib/legion/logging/event_builder.rb', line 119

def fingerprint(
  exception_class:,
  message:,
  caller_file:,
  caller_line:,
  caller_function:,
  gem_name:,
  component_type:,
  backtrace:
)
  norm_msg = normalize_message(message.to_s)
  norm_file = normalize_path(caller_file.to_s)
  norm_bt = Array(backtrace).first(5).map { |l| normalize_path(l.to_s) }.join('|')

  raw = [
    exception_class.to_s,
    norm_msg,
    norm_file,
    caller_line.to_s,
    caller_function.to_s,
    gem_name.to_s,
    component_type.to_s,
    norm_bt
  ].join(':')

  Digest::MD5.hexdigest(raw)
end