/
message.rb
327 lines (287 loc) · 8.14 KB
/
message.rb
1
2
3
4
5
6
7
8
9
10
11
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
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
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# frozen_string_literal: true
require 'digest/sha1'
require 'securerandom'
module Logster
MAX_MESSAGE_LENGTH = 600
class Message
LOGSTER_ENV = "_logster_env".freeze
ALLOWED_ENV = %w{
HTTP_HOST
REQUEST_URI
REQUEST_METHOD
HTTP_USER_AGENT
HTTP_ACCEPT
HTTP_REFERER
HTTP_X_FORWARDED_FOR
HTTP_X_REAL_IP
hostname
process_id
application_version
time
}
attr_accessor :timestamp, :severity, :progname, :key, :backtrace, :count, :protected, :first_timestamp, :env_buffer
attr_reader :message, :env
def initialize(severity, progname, message, timestamp = nil, key = nil, count: 1)
@timestamp = timestamp || get_timestamp
@severity = severity
@progname = progname
@message = truncate_message(message)
@key = key || SecureRandom.hex
@backtrace = nil
@count = count || 1
@protected = false
@first_timestamp = nil
@env_buffer = []
end
def to_h(exclude_env: false)
h = {
message: @message,
progname: @progname,
severity: @severity,
timestamp: @timestamp,
key: @key,
backtrace: @backtrace,
count: @count,
protected: @protected
}
h[:first_timestamp] = @first_timestamp if @first_timestamp
h[:env] = @env unless exclude_env
h
end
def message=(m)
@message = truncate_message(m)
end
def to_json(opts = nil)
exclude_env = Hash === opts && opts.delete(:exclude_env)
JSON.fast_generate(to_h(exclude_env: exclude_env), opts)
end
def self.from_json(json)
parsed = ::JSON.parse(json)
msg = new(parsed["severity"],
parsed["progname"],
parsed["message"],
parsed["timestamp"],
parsed["key"])
msg.backtrace = parsed["backtrace"]
msg.env = parsed["env"]
msg.count = parsed["count"]
msg.protected = parsed["protected"]
msg.first_timestamp = parsed["first_timestamp"]
msg
end
def env=(env)
@env = self.class.scrub_params(env)
end
def self.hostname
@hostname ||= `hostname`.strip! rescue "<unknown>"
end
def populate_from_env(env)
env ||= {}
if Array === env
env = env.map do |single_env|
single_env = self.class.default_env.merge(single_env)
if !single_env.key?("time") && !single_env.key?(:time)
single_env["time"] = @timestamp || get_timestamp
end
single_env
end
else
env = self.class.default_env.merge(env)
if !env.key?("time") && !env.key?(:time)
env["time"] = @timestamp || get_timestamp
end
end
@env = Message.populate_from_env(env)
end
def self.default_env
env = {
"hostname" => hostname,
"process_id" => Process.pid
}
env["application_version"] = Logster.config.application_version if Logster.config.application_version
env
end
# in its own method so it can be overridden
def grouping_hash
{ message: self.message, severity: self.severity, backtrace: self.backtrace }
end
# todo - memoize?
def grouping_key
Digest::SHA1.hexdigest JSON.fast_generate grouping_hash
end
# todo - memoize?
def solved_keys
if Array === env
versions = env.map { |single_env| single_env["application_version"] }
else
versions = [env["application_version"]]
end
versions.compact!
if backtrace && backtrace.length > 0
versions.map do |version|
Digest::SHA1.hexdigest "#{version} #{backtrace}"
end
end
end
def is_similar?(other)
self.grouping_key == other.grouping_key
end
def merge_similar_message(other)
self.first_timestamp ||= self.timestamp
self.timestamp = [self.timestamp, other.timestamp].max
self.count += other.count || 1
if Hash === other.env && !other.env.key?("time") && !other.env.key?(:time)
other.env["time"] = other.timestamp
end
if Array === other.env
env_buffer.unshift(*other.env)
else
env_buffer.unshift(other.env)
end
true
end
def has_env_buffer?
env_buffer.size > 0
end
def self.populate_from_env(env)
if Array === env
env.map do |single_env|
self.populate_env_helper(single_env)
end
else
self.populate_env_helper(env)
end
end
def self.populate_env_helper(env)
env[LOGSTER_ENV] ||= begin
unless env.include? "rack.input"
# Not a web request
return env
end
scrubbed = default_env
request = Rack::Request.new(env)
params = {}
request.params.each do |k, v|
if k.include? "password"
params[k] = "[redacted]"
elsif Array === v
params[k] = v[0..20]
else
params[k] = v && v[0..100]
end
end
scrubbed["params"] = params if params.length > 0
ALLOWED_ENV.map { |k|
scrubbed[k] = env[k] if env[k]
}
scrubbed
end
end
def <=>(other)
time = self.timestamp <=> other.timestamp
return time if time && time != 0
self.key <=> other.key
end
def =~(pattern)
case pattern
when Hash
IgnorePattern.new(nil, pattern).matches? self
when String
IgnorePattern.new(pattern, nil).matches? self
when Regexp
IgnorePattern.new(pattern, nil).matches? self
when IgnorePattern
pattern.matches? self
else
nil
end
end
def self.scrub_params(params)
if Array === params
params.map! { |p| scrub_params(p) }
params
elsif Hash === params
params.each do |k, v|
params[k] = scrub_params(v)
end
params
elsif String === params
scrubbed = params.scrub if !params.valid_encoding?
scrubbed || params
else
params
end
end
def drop_redundant_envs(limit)
if Array === env
env.slice!(limit..-1)
end
end
def apply_env_size_limit(size_limit)
if Array === env
env.each { |e| truncate_env(e, size_limit) }
elsif Hash === env
truncate_env(env, size_limit)
end
end
def apply_message_size_limit(limit, gems_dir: nil)
size = self.to_json(exclude_env: true).bytesize
if size > limit && @backtrace
backtrace_limit = limit - (size - @backtrace.bytesize)
@backtrace.gsub!(gems_dir, "") if gems_dir
@backtrace.strip!
stop = false
while @backtrace.bytesize > backtrace_limit && backtrace_limit > 0 && !stop
orig = @backtrace.dup
lines = @backtrace.lines
if lines.size > 1
lines.pop
@backtrace = lines.join
else
@backtrace.slice!(-1)
end
# protection to ensure we never get stuck
stop = orig == @backtrace
end
end
end
protected
def truncate_env(env, limit)
if JSON.fast_generate(env).bytesize > limit
sizes = {}
braces = '{}'.bytesize
env.each do |k, v|
sizes[k] = JSON.fast_generate(k => v).bytesize - braces
end
sorted = env.keys.sort { |a, b| sizes[a] <=> sizes[b] }
kept_keys = []
if env.key?(:time)
kept_keys << :time
elsif env.key?("time")
kept_keys << "time"
end
sum = braces
if time_key = kept_keys.first
sum += sizes[time_key]
sorted.delete(time_key)
end
comma = ','.bytesize
sorted.each do |k|
extra = kept_keys.size == 0 ? 0 : comma
break if sum + sizes[k] + extra > limit
kept_keys << k
sum += sizes[k] + extra
end
env.select! { |k| kept_keys.include?(k) }
end
end
def truncate_message(msg)
return msg unless msg
msg = msg.inspect unless String === msg
msg.size <= MAX_MESSAGE_LENGTH ? msg : msg[0...MAX_MESSAGE_LENGTH] + "..."
end
def get_timestamp
(Time.new.to_f * 1000).to_i
end
end
end