Module: JsonLogging::LineEncoder

Defined in:
lib/json_logging/line_encoder.rb

Class Method Summary collapse

Class Method Details

.build_line(msg:, severity:, timestamp:, tags:, additional_context:, additional_context_sanitized: false, sanitize_tags: true) ⇒ Object 



12
13
14
15
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
42
43
44
45
46
47
48
49
50
51
52
53
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
 
# File 'lib/json_logging/line_encoder.rb', line 12

def build_line(msg:, severity:, timestamp:, tags:, additional_context:, additional_context_sanitized: false, sanitize_tags: true)
  if simple_string_line?(msg, tags, additional_context)
    return simple_string_json_line(
      message: msg,
      severity: Severity.name_for(severity),
      timestamp: timestamp
    )
  end

  if tagged_simple_string_line?(msg, tags, additional_context)
    return tagged_simple_string_json_line(
      message: msg,
      severity: Severity.name_for(severity),
      timestamp: timestamp,
      tags: tags,
      sanitize_tags: sanitize_tags
    )
  end

  if contextual_simple_string_line?(msg, tags, additional_context, additional_context_sanitized: additional_context_sanitized)
    return contextual_simple_string_json_line(
      message: msg,
      severity: Severity.name_for(severity),
      timestamp: timestamp,
      additional_context: additional_context
    )
  end

  if standalone_hash_line?(msg, tags, additional_context)
    return standalone_hash_json_line(
      message: msg,
      severity: Severity.name_for(severity),
      timestamp: timestamp
    )
  end

  if tagged_hash_line?(msg, tags, additional_context)
    return tagged_hash_json_line(
      message: msg,
      severity: Severity.name_for(severity),
      timestamp: timestamp,
      tags: tags,
      sanitize_tags: sanitize_tags
    )
  end

  if contextual_hash_line?(msg, tags, additional_context, additional_context_sanitized: additional_context_sanitized)
    return contextual_hash_json_line(
      message: msg,
      severity: Severity.name_for(severity),
      timestamp: timestamp,
      additional_context: additional_context
    )
  end

  sev = Severity.name_for(severity)
  payload = PayloadBuilder.build_base_payload(msg, severity: sev, timestamp: timestamp)
  unless tags.empty? && PayloadBuilder.empty_additional_context?(additional_context)
    payload = PayloadBuilder.merge_context(
      payload,
      additional_context: additional_context,
      tags: tags,
      additional_context_sanitized: additional_context_sanitized,
      sanitize_tags: sanitize_tags
    )
  end
  to_json_line(payload)
end

.build_sanitized_hash_payload(message:, severity:, timestamp:) ⇒ Object 



226
227
228
229
230
231
232
 
# File 'lib/json_logging/line_encoder.rb', line 226

def build_sanitized_hash_payload(message:, severity:, timestamp:)
  hash = message.is_a?(Hash) ? message : message.to_hash
  payload = Sanitizer.sanitize_hash(hash)
  payload["severity"] = severity
  payload["timestamp"] = timestamp
  payload
end

.contextual_hash_json_line(message:, severity:, timestamp:, additional_context:) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/json_logging/line_encoder.rb', line 198

def contextual_hash_json_line(message:, severity:, timestamp:, additional_context:)
  hash = message.is_a?(Hash) ? message : message.to_hash
  context = PayloadBuilder.context_payload_portion(additional_context)
  merged_context = {}
  unless context.empty?
    existing_context = hash[:context] || hash["context"]
    merged_context = existing_context.is_a?(Hash) ? existing_context.merge(context) : context
  end
  field_overrides = merged_context.empty? ? {} : {"context" => merged_context}

  line = StructuredHashJsonEncoder.try_encode_line(
    hash,
    severity: severity,
    timestamp: timestamp,
    field_overrides: field_overrides
  )
  return line if line

  payload = Sanitizer.sanitize_hash(hash)
  payload["severity"] = severity
  payload["timestamp"] = timestamp
  unless merged_context.empty?
    existing_context = payload["context"].is_a?(Hash) ? payload["context"] : {}
    payload["context"] = existing_context.merge(merged_context)
  end
  "#{JSON.generate(payload)}\n"
end

.contextual_hash_line?(message, tags, additional_context, additional_context_sanitized:) ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
194
195
196
 
# File 'lib/json_logging/line_encoder.rb', line 191

def contextual_hash_line?(message, tags, additional_context, additional_context_sanitized:)
  hash_message?(message) &&
    tags.respond_to?(:empty?) && tags.empty? &&
    !PayloadBuilder.empty_additional_context?(additional_context) &&
    additional_context_sanitized
end

.contextual_simple_string_json_line(message:, severity:, timestamp:, additional_context:) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/json_logging/line_encoder.rb', line 131

def contextual_simple_string_json_line(message:, severity:, timestamp:, additional_context:)
  sanitized_message = Sanitizer.sanitize_string(message)
  payload = {
    "message" => sanitized_message,
    "severity" => severity,
    "timestamp" => timestamp
  }
  context = PayloadBuilder.context_payload_portion(additional_context)
  payload["context"] = context unless context.empty?
  "#{JSON.generate(payload)}\n"
end

.contextual_simple_string_line?(message, tags, additional_context, additional_context_sanitized:) ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
 
# File 'lib/json_logging/line_encoder.rb', line 123

def contextual_simple_string_line?(message, tags, additional_context, additional_context_sanitized:)
  message.is_a?(String) &&
    !MessageParser.json_string?(message) &&
    tags.respond_to?(:empty?) && tags.empty? &&
    !PayloadBuilder.empty_additional_context?(additional_context) &&
    additional_context_sanitized
end

.deep_stringify_structure(obj) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/json_logging/line_encoder.rb', line 234

def deep_stringify_structure(obj)
  case obj
  when Hash
    obj.deep_stringify_keys
  when Array
    obj.map { |v| deep_stringify_structure(v) }
  else
    obj
  end
end

.hash_message?(message) ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/json_logging/line_encoder.rb', line 149

def hash_message?(message)
  message.is_a?(Hash) || (message.respond_to?(:to_hash) && !message.is_a?(String))
end

.simple_string_json_line(message:, severity:, timestamp:) ⇒ Object 



105
106
107
108
 
# File 'lib/json_logging/line_encoder.rb', line 105

def simple_string_json_line(message:, severity:, timestamp:)
  sanitized_message = Sanitizer.sanitize_string(message)
  "#{JSON.generate("message" => sanitized_message, "severity" => severity, "timestamp" => timestamp)}\n"
end

.simple_string_line?(message, tags, additional_context) ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
101
102
103
 
# File 'lib/json_logging/line_encoder.rb', line 98

def simple_string_line?(message, tags, additional_context)
  message.is_a?(String) &&
    !MessageParser.json_string?(message) &&
    tags.respond_to?(:empty?) && tags.empty? &&
    additional_context.respond_to?(:empty?) && additional_context.empty?
end

.standalone_hash_json_line(message:, severity:, timestamp:) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/json_logging/line_encoder.rb', line 153

def standalone_hash_json_line(message:, severity:, timestamp:)
  hash = message.is_a?(Hash) ? message : message.to_hash
  line = StructuredHashJsonEncoder.try_encode_line(hash, severity: severity, timestamp: timestamp)
  return line if line

  payload = Sanitizer.sanitize_hash(hash)
  payload["severity"] = severity
  payload["timestamp"] = timestamp
  "#{JSON.generate(payload)}\n"
end

.standalone_hash_line?(message, tags, additional_context) ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
146
147
 
# File 'lib/json_logging/line_encoder.rb', line 143

def standalone_hash_line?(message, tags, additional_context)
  hash_message?(message) &&
    tags.respond_to?(:empty?) && tags.empty? &&
    additional_context.respond_to?(:empty?) && additional_context.empty?
end

.string_keyed_structure?(object) ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
94
95
96
 
# File 'lib/json_logging/line_encoder.rb', line 87

def string_keyed_structure?(object)
  case object
  when Hash
    object.keys.all?(String) && object.values.all? { |value| string_keyed_structure?(value) }
  when Array
    object.all? { |value| string_keyed_structure?(value) }
  else
    true
  end
end

.tagged_hash_json_line(message:, severity:, timestamp:, tags:, sanitize_tags:) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/json_logging/line_encoder.rb', line 170

def tagged_hash_json_line(message:, severity:, timestamp:, tags:, sanitize_tags:)
  hash = message.is_a?(Hash) ? message : message.to_hash
  prepared_tags = sanitize_tags ? Sanitizer.prepare_tags(tags) : tags
  merged_tags = (Array(hash[:tags] || hash["tags"]) + prepared_tags).uniq
  field_overrides = {"tags" => merged_tags}

  line = StructuredHashJsonEncoder.try_encode_line(
    hash,
    severity: severity,
    timestamp: timestamp,
    field_overrides: field_overrides
  )
  return line if line

  payload = Sanitizer.sanitize_hash(hash)
  payload["severity"] = severity
  payload["timestamp"] = timestamp
  payload["tags"] = merged_tags
  "#{JSON.generate(payload)}\n"
end

.tagged_hash_line?(message, tags, additional_context) ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
167
168
 
# File 'lib/json_logging/line_encoder.rb', line 164

def tagged_hash_line?(message, tags, additional_context)
  hash_message?(message) &&
    tags.respond_to?(:empty?) && !tags.empty? &&
    additional_context.respond_to?(:empty?) && additional_context.empty?
end

.tagged_simple_string_json_line(message:, severity:, timestamp:, tags:, sanitize_tags:) ⇒ Object 



117
118
119
120
121
 
# File 'lib/json_logging/line_encoder.rb', line 117

def tagged_simple_string_json_line(message:, severity:, timestamp:, tags:, sanitize_tags:)
  sanitized_message = Sanitizer.sanitize_string(message)
  prepared_tags = sanitize_tags ? Sanitizer.prepare_tags(tags) : tags
  "#{JSON.generate("message" => sanitized_message, "severity" => severity, "timestamp" => timestamp, "tags" => prepared_tags.uniq)}\n"
end

.tagged_simple_string_line?(message, tags, additional_context) ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
113
114
115
 
# File 'lib/json_logging/line_encoder.rb', line 110

def tagged_simple_string_line?(message, tags, additional_context)
  message.is_a?(String) &&
    !MessageParser.json_string?(message) &&
    tags.respond_to?(:empty?) && !tags.empty? &&
    additional_context.respond_to?(:empty?) && additional_context.empty?
end

.to_json_line(payload_hash) ⇒ Object 



81
82
83
84
85
 
# File 'lib/json_logging/line_encoder.rb', line 81

def to_json_line(payload_hash)
  compacted = payload_hash.compact
  json_payload = string_keyed_structure?(compacted) ? compacted : compacted.deep_stringify_keys
  "#{json_payload.to_json}\n"
end