Module: JsonLogging::PayloadBuilder

Defined in:
lib/json_logging/payload_builder.rb

Class Method Summary collapse

Class Method Details

.build_base_payload(msg, severity: nil, timestamp: nil) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/json_logging/payload_builder.rb', line 5

def build_base_payload(msg, severity: nil, timestamp: nil)
  parsed = MessageParser.parse_message(msg)
  payload = {}

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

  payload[:severity] = severity if severity
  payload[:timestamp] = timestamp if timestamp

  payload
end

.merge_context(payload, additional_context:, tags: []) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/json_logging/payload_builder.rb', line 21

def merge_context(payload, additional_context:, tags: [])
  existing_context = payload[:context].is_a?(Hash) ? payload[:context] : {}

  # Sanitize additional context before merging (filters sensitive keys, limits size, sanitizes strings only)
  # Only sanitize if it's a hash - preserve other types
  sanitized_context = if additional_context.is_a?(Hash) && !additional_context.empty?
    Sanitizer.sanitize_hash(additional_context)
  else
    additional_context || {}
  end

  # Filter out system-controlled keys from user context
  # These keys should never be set by user context as they're controlled by the logger
  system_controlled_keys = [:tags, "tags", :severity, "severity", :timestamp, "timestamp", :message, "message", :context, "context"]
  user_context_filtered = sanitized_context.except(*system_controlled_keys)

  # Also prevent overriding any existing payload keys (additional safety)
  deduped_additional = user_context_filtered.reject { |k, _| payload.key?(k) }
  merged_context = existing_context.merge(deduped_additional)

  # Put tags at root level, separate from context
  # Merge with existing tags from payload (e.g., when logging a hash with tags: [...] at root)
  unless tags.empty?
    existing_tags = Array(payload[:tags] || payload["tags"])
    # Sanitize tag strings (remove control chars, truncate)
    sanitized_tags = tags.map { |tag| Sanitizer.sanitize_string(tag.to_s) }
    payload[:tags] = (existing_tags + sanitized_tags).uniq
  end

  payload[:context] = merged_context unless merged_context.empty?
  payload
end