-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
format_json.go
284 lines (255 loc) · 7.36 KB
/
format_json.go
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
// Copyright 2020 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package log
import (
"strings"
"unicode/utf8"
"github.com/cockroachdb/cockroach/pkg/util/log/logpb"
)
type formatFluentJSONCompact struct{}
func (formatFluentJSONCompact) formatterName() string { return "json-fluent-compact" }
func (f formatFluentJSONCompact) formatEntry(entry logpb.Entry, stacks []byte) *buffer {
return formatJSON(entry, stacks, true /* fluent */, true /* compact */)
}
type formatFluentJSONFull struct{}
func (formatFluentJSONFull) formatterName() string { return "json-fluent" }
func (f formatFluentJSONFull) formatEntry(entry logpb.Entry, stacks []byte) *buffer {
return formatJSON(entry, stacks, true /* fluent */, false /* compact */)
}
type formatJSONCompact struct{}
func (formatJSONCompact) formatterName() string { return "json-compact" }
func (f formatJSONCompact) formatEntry(entry logpb.Entry, stacks []byte) *buffer {
return formatJSON(entry, stacks, false /* fluent */, true /* compact */)
}
type formatJSONFull struct{}
func (formatJSONFull) formatterName() string { return "json" }
func (f formatJSONFull) formatEntry(entry logpb.Entry, stacks []byte) *buffer {
return formatJSON(entry, stacks, false /* fluent */, false /* compact */)
}
var fullTags = map[byte]string{
'c': "channel_numeric",
'C': "channel",
't': "timestamp",
's': "severity_numeric",
'S': "severity",
'g': "goroutine",
'f': "file",
'l': "line",
'n': "entry_counter",
'r': "redactable",
}
var compactTags = map[byte]string{
'c': "c",
'C': "C",
't': "t",
's': "s",
'S': "sev",
'g': "g",
'f': "f",
'l': "l",
'n': "n",
'r': "r",
}
var programEscaped = strings.ReplaceAll(program, ".", "_")
var channelNamesLowercase = func() map[Channel]string {
lnames := make(map[Channel]string, len(logpb.Channel_name))
for ch, s := range logpb.Channel_name {
lnames[Channel(ch)] = strings.ToLower(s)
}
return lnames
}()
func formatJSON(entry logpb.Entry, stacks []byte, forFluent, compact bool) *buffer {
jtags := fullTags
if compact {
jtags = compactTags
}
buf := getBuffer()
buf.WriteByte('{')
if forFluent {
// Tag: this is the main category for Fluentd events.
buf.WriteString(`"tag":"`)
// Note: fluent prefers if there is no period in the tag other
// than the one splitting the application and category.
buf.WriteString(programEscaped)
buf.WriteByte('.')
buf.WriteString(channelNamesLowercase[entry.Channel])
// Also include the channel number in numeric form to facilitate
// automatic processing.
buf.WriteString(`",`)
}
buf.WriteByte('"')
buf.WriteString(jtags['c'])
buf.WriteString(`":`)
n := buf.someDigits(0, int(entry.Channel))
buf.Write(buf.tmp[:n])
if !compact {
buf.WriteString(`,"`)
buf.WriteString(jtags['C'])
buf.WriteString(`":"`)
escapeString(buf, entry.Channel.String())
buf.WriteByte('"')
}
// Timestamp.
// Note: fluentd is particular about the time format; although this
// looks like a float with a fractional number of seconds, fluentd
// interprets the number after the period as a number of
// nanoseconds. So for example "1.2" is interpreted as "2
// nanoseconds after the second". So we really need to emit all 9
// digits.
// Also, we enclose the timestamp in double quotes because the
// precision of the resulting number exceeds json's native float
// precision. Fluentd doesn't care and still parses the value properly.
buf.WriteString(`,"`)
buf.WriteString(jtags['t'])
buf.WriteString(`":"`)
n = buf.someDigits(0, int(entry.Time/1000000000))
buf.tmp[n] = '.'
n++
n += buf.nDigits(9, n, int(entry.Time%1000000000), '0')
buf.Write(buf.tmp[:n])
// Severity, both in numeric form (for ease of processing) and
// string form (to facilitate human comprehension).
buf.WriteString(`","`)
buf.WriteString(jtags['s'])
buf.WriteString(`":`)
n = buf.someDigits(0, int(entry.Severity))
buf.Write(buf.tmp[:n])
if compact {
if entry.Severity > 0 && int(entry.Severity) <= len(severityChar) {
buf.WriteString(`,"`)
buf.WriteString(jtags['S'])
buf.WriteString(`":"`)
buf.WriteByte(severityChar[int(entry.Severity)-1])
buf.WriteByte('"')
}
} else {
buf.WriteString(`,"`)
buf.WriteString(jtags['S'])
buf.WriteString(`":"`)
escapeString(buf, entry.Severity.String())
buf.WriteByte('"')
}
// Goroutine number.
buf.WriteString(`,"`)
buf.WriteString(jtags['g'])
buf.WriteString(`":`)
n = buf.someDigits(0, int(entry.Goroutine))
buf.Write(buf.tmp[:n])
// Source location.
buf.WriteString(`,"`)
buf.WriteString(jtags['f'])
buf.WriteString(`":"`)
escapeString(buf, entry.File)
buf.WriteString(`","`)
buf.WriteString(jtags['l'])
buf.WriteString(`":`)
n = buf.someDigits(0, int(entry.Line))
buf.Write(buf.tmp[:n])
// Entry counter.
buf.WriteString(`,"`)
buf.WriteString(jtags['n'])
buf.WriteString(`":`)
n = buf.someDigits(0, int(entry.Counter))
buf.Write(buf.tmp[:n])
// Whether the tags/message are redactable.
// We use 0/1 instead of true/false, because
// it's likely there will be more redaction formats
// in the future.
buf.WriteString(`,"`)
buf.WriteString(jtags['r'])
buf.WriteString(`":`)
if entry.Redactable {
buf.WriteByte('1')
} else {
buf.WriteByte('0')
}
// Tags.
if entry.Tags != "" {
buf.WriteString(`,"tags":"`)
escapeString(buf, entry.Tags)
buf.WriteByte('"')
}
// Message and stacks.
buf.WriteString(`,"message":"`)
escapeString(buf, entry.Message)
if len(stacks) > 0 {
buf.WriteString(`","stacks":"`)
escapeString(buf, string(stacks))
}
buf.WriteString(`"}` + "\n")
return buf
}
// escapeString is a variant of Go's json (*encodeState).stringBytes()
// which writes to buf directly.
func escapeString(buf *buffer, s string) {
const hex = "0123456789abcdef"
start := 0
for i := 0; i < len(s); {
if b := s[i]; b < utf8.RuneSelf {
if b >= 0x20 && b < 0x80 && b != '"' && b != '\\' {
i++
continue
}
if start < i {
buf.WriteString(s[start:i])
}
buf.WriteByte('\\')
switch b {
case '\\', '"':
buf.WriteByte(b)
case '\n':
buf.WriteByte('n')
case '\r':
buf.WriteByte('r')
case '\t':
buf.WriteByte('t')
default:
// This encodes bytes < 0x20 except for \t, \n and \r.
buf.WriteString(`u00`)
buf.WriteByte(hex[b>>4])
buf.WriteByte(hex[b&0xF])
}
i++
start = i
continue
}
c, size := utf8.DecodeRuneInString(s[i:])
if c == utf8.RuneError && size == 1 {
if start < i {
buf.WriteString(s[start:i])
}
buf.WriteString(`\ufffd`)
i += size
start = i
continue
}
// U+2028 is LINE SEPARATOR.
// U+2029 is PARAGRAPH SEPARATOR.
// They are both technically valid characters in JSON strings,
// but don't work in JSONP, which has to be evaluated as JavaScript,
// and can lead to security holes there. It is valid JSON to
// escape them, so we do so unconditionally.
// See http://timelessrepo.com/json-isnt-a-javascript-subset for discussion.
if c == '\u2028' || c == '\u2029' {
if start < i {
buf.WriteString(s[start:i])
}
buf.WriteString(`\u202`)
buf.WriteByte(hex[c&0xF])
i += size
start = i
continue
}
i += size
}
if start < len(s) {
buf.WriteString(s[start:])
}
}