forked from gemnasium/logrus-graylog-hook
-
Notifications
You must be signed in to change notification settings - Fork 0
/
graylog_hook_test.go
465 lines (374 loc) · 10.9 KB
/
graylog_hook_test.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
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
package graylog
import (
"compress/flate"
"encoding/json"
"errors"
"io/ioutil"
"net"
"regexp"
"runtime"
"strings"
"sync"
"testing"
pkgerrors "github.com/pkg/errors"
"github.com/sirupsen/logrus"
)
const SyslogInfoLevel = 6
const SyslogErrorLevel = 7
func TestWritingToUDP(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), map[string]interface{}{"foo": "bar"})
hook.Host = "testing.local"
hook.Blacklist([]string{"filterMe"})
msgData := "test message\nsecond line"
log := logrus.New()
log.Out = ioutil.Discard
log.Hooks.Add(hook)
log.WithFields(logrus.Fields{"withField": "1", "filterMe": "1"}).Info(msgData)
msg, err := r.ReadMessage()
if err != nil {
t.Errorf("ReadMessage: %s", err)
}
if msg.Short != "test message" {
t.Errorf("msg.Short: expected %s, got %s", msgData, msg.Full)
}
if msg.Full != msgData {
t.Errorf("msg.Full: expected %s, got %s", msgData, msg.Full)
}
if msg.Level != SyslogInfoLevel {
t.Errorf("msg.Level: expected: %d, got %d)", SyslogInfoLevel, msg.Level)
}
if msg.Host != "testing.local" {
t.Errorf("Host should match (exp: testing.local, got: %s)", msg.Host)
}
if len(msg.Extra) != 2 {
t.Errorf("wrong number of extra fields (exp: %d, got %d) in %v", 5, len(msg.Extra), msg.Extra)
}
fileExpected := ""
if msg.File != fileExpected {
t.Errorf("msg.File: expected %s, got %s", fileExpected,
msg.File)
}
lineExpected := 0
if msg.Line != lineExpected {
t.Errorf("msg.Line: expected %d, got %d", lineExpected, msg.Line)
}
if len(msg.Extra) != 2 {
t.Errorf("wrong number of extra fields (exp: %d, got %d) in %v", 2, len(msg.Extra), msg.Extra)
}
extra := map[string]interface{}{"foo": "bar", "withField": "1"}
for k, v := range extra {
// Remember extra fileds are prefixed with "_"
if msg.Extra["_"+k].(string) != extra[k].(string) {
t.Errorf("Expected extra '%s' to be %#v, got %#v", k, v, msg.Extra["_"+k])
}
}
}
func testErrorLevelReporting(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), map[string]interface{}{"foo": "bar"})
msgData := "test message\nsecond line"
log := logrus.New()
log.Out = ioutil.Discard
log.Hooks.Add(hook)
log.Error(msgData)
msg, err := r.ReadMessage()
if err != nil {
t.Errorf("ReadMessage: %s", err)
}
if msg.Short != "test message" {
t.Errorf("msg.Short: expected %s, got %s", msgData, msg.Full)
}
if msg.Full != msgData {
t.Errorf("msg.Full: expected %s, got %s", msgData, msg.Full)
}
if msg.Level != SyslogErrorLevel {
t.Errorf("msg.Level: expected: %d, got %d)", SyslogErrorLevel, msg.Level)
}
}
func TestJSONErrorMarshalling(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), map[string]interface{}{})
log := logrus.New()
log.Out = ioutil.Discard
log.Hooks.Add(hook)
log.WithError(errors.New("sample error")).Info("Testing sample error")
msg, err := r.ReadMessage()
if err != nil {
t.Errorf("ReadMessage: %s", err)
}
encoded, err := json.Marshal(msg)
if err != nil {
t.Errorf("Marshaling json: %s", err)
}
errSection := regexp.MustCompile(`"_error":"sample error"`)
if !errSection.MatchString(string(encoded)) {
t.Errorf("Expected error message to be encoded into message")
}
}
func TestParallelLogging(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), nil)
asyncHook := NewAsyncGraylogHook(r.Addr(), nil)
log := logrus.New()
log.Out = ioutil.Discard
log.Hooks.Add(hook)
log.Hooks.Add(asyncHook)
log2 := logrus.New()
log2.Out = ioutil.Discard
log2.Hooks.Add(hook)
log2.Hooks.Add(asyncHook)
quit := make(chan struct{})
defer close(quit)
recordPanic := func() {
if r := recover(); r != nil {
t.Fatalf("Logging in parallel caused a panic")
}
}
var wg sync.WaitGroup
// Start draining messages from GELF
go func() {
defer recordPanic()
for {
select {
case <-quit:
return
default:
r.ReadMessage()
}
}
}()
// Log into our hook in parallel
for i := 0; i < 100; i++ {
wg.Add(1)
go func() {
defer wg.Done()
defer recordPanic()
log.Info("Logging")
log2.Info("Logging from another logger")
}()
}
wg.Wait()
}
func TestSetWriter(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), nil)
w := hook.Writer()
w.CompressionLevel = flate.BestCompression
hook.SetWriter(w)
if hook.Writer().CompressionLevel != flate.BestCompression {
t.Error("Writer was not set correctly")
}
if hook.SetWriter(nil) == nil {
t.Error("Setting a nil writter should raise an error")
}
}
func TestWithInvalidGraylogAddr(t *testing.T) {
addr, err := net.ResolveUDPAddr("udp", "localhost:0")
if err != nil {
panic(err)
}
logrus.SetOutput(ioutil.Discard)
hook := NewGraylogHook(addr.String(), nil)
log := logrus.New()
log.Out = ioutil.Discard
log.Hooks.Add(hook)
// Should not panic
log.WithError(errors.New("sample error")).Info("Testing sample error")
}
func TestStackTracer(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), map[string]interface{}{})
log := logrus.New()
log.SetReportCaller(true)
log.Out = ioutil.Discard
log.Hooks.Add(hook)
stackErr := pkgerrors.New("sample error")
log.WithError(stackErr).Info("Testing sample error")
msg, err := r.ReadMessage()
if err != nil {
t.Errorf("ReadMessage: %s", err)
}
fileExpected := "graylog_hook_test.go"
if !strings.HasSuffix(msg.File, fileExpected) {
t.Errorf("msg.File: expected %s, got %s", fileExpected,
msg.File)
}
lineExpected := 258 // Update this if code is updated above
if msg.Line != lineExpected {
t.Errorf("msg.Line: expected %d, got %d", lineExpected, msg.Line)
}
stacktraceI, ok := msg.Extra[StackTraceKey]
if !ok {
t.Error("Stack Trace not found in result")
}
stacktrace, ok := stacktraceI.(string)
if !ok {
t.Error("Stack Trace is not a string")
}
// Run the test for stack trace only in stable versions
if !strings.Contains(runtime.Version(), "devel") {
stacktraceRE := regexp.MustCompile(`^
(.+)?logrus-graylog-hook(/v3)?.TestStackTracer
(/|[A-Z]:/).+/logrus-graylog-hook(.v3)?/graylog_hook_test.go:\d+
testing.tRunner
(/|[A-Z]:/).*/testing.go:\d+
runtime.*
(/|[A-Z]:/).*/runtime/.*:\d+$`)
if !stacktraceRE.MatchString(stacktrace) {
t.Errorf("Stack Trace not as expected. Got:\n%s\n", stacktrace)
}
}
}
func TestLogrusLevelToSylog(t *testing.T) {
// Syslog constants
const (
LOG_EMERG = 0 /* system is unusable */
LOG_ALERT = 1 /* action must be taken immediately */
LOG_CRIT = 2 /* critical conditions */
LOG_ERR = 3 /* error conditions */
LOG_WARNING = 4 /* warning conditions */
LOG_NOTICE = 5 /* normal but significant condition */
LOG_INFO = 6 /* informational */
LOG_DEBUG = 7 /* debug-level messages */
)
if logrusLevelToSylog(logrus.TraceLevel) != LOG_DEBUG {
t.Error("logrusLevelToSylog(TraceLevel) != LOG_DEBUG")
}
if logrusLevelToSylog(logrus.DebugLevel) != LOG_DEBUG {
t.Error("logrusLevelToSylog(DebugLevel) != LOG_DEBUG")
}
if logrusLevelToSylog(logrus.InfoLevel) != LOG_INFO {
t.Error("logrusLevelToSylog(InfoLevel) != LOG_INFO")
}
if logrusLevelToSylog(logrus.WarnLevel) != LOG_WARNING {
t.Error("logrusLevelToSylog(WarnLevel) != LOG_WARNING")
}
if logrusLevelToSylog(logrus.ErrorLevel) != LOG_ERR {
t.Error("logrusLevelToSylog(ErrorLevel) != LOG_ERR")
}
if logrusLevelToSylog(logrus.FatalLevel) != LOG_CRIT {
t.Error("logrusLevelToSylog(FatalLevel) != LOG_CRIT")
}
if logrusLevelToSylog(logrus.PanicLevel) != LOG_ALERT {
t.Error("logrusLevelToSylog(PanicLevel) != LOG_ALERT")
}
}
func TestReportCallerEnabled(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), map[string]interface{}{})
hook.Host = "testing.local"
msgData := "test message\nsecond line"
log := logrus.New()
log.SetReportCaller(true)
log.Out = ioutil.Discard
log.Hooks.Add(hook)
log.Info(msgData)
msg, err := r.ReadMessage()
if err != nil {
t.Errorf("ReadMessage: %s", err)
}
fileField, ok := msg.Extra["_file"]
if !ok {
t.Error("_file field not present in extra fields")
}
fileGot, ok := fileField.(string)
if !ok {
t.Error("_file field is not a string")
}
fileExpected := "graylog_hook_test.go"
if !strings.HasSuffix(fileGot, fileExpected) {
t.Errorf("msg.Extra[\"_file\"]: expected %s, got %s", fileExpected, fileGot)
}
lineField, ok := msg.Extra["_line"]
if !ok {
t.Error("_line field not present in extra fields")
}
lineGot, ok := lineField.(float64)
if !ok {
t.Error("_line dowes not have the correct type")
}
lineExpected := 356 // Update this if code is updated above
if msg.Line != lineExpected {
t.Errorf("msg.Extra[\"_line\"]: expected %d, got %d", lineExpected, int(lineGot))
}
functionField, ok := msg.Extra["_function"]
if !ok {
t.Error("_function field not present in extra fields")
}
functionGot, ok := functionField.(string)
if !ok {
t.Error("_function field is not a string")
}
functionExpected := "TestReportCallerEnabled"
if !strings.HasSuffix(functionGot, functionExpected) {
t.Errorf("msg.Extra[\"_function\"]: expected %s, got %s", functionExpected, functionGot)
}
gelfFileExpected := "graylog_hook_test.go"
if !strings.HasSuffix(msg.File, gelfFileExpected) {
t.Errorf("msg.File: expected %s, got %s", gelfFileExpected,
msg.File)
}
gelfLineExpected := 359 // Update this if code is updated above
if msg.Line != lineExpected {
t.Errorf("msg.Line: expected %d, got %d", gelfLineExpected, msg.Line)
}
}
func TestReportCallerDisabled(t *testing.T) {
r, err := NewReader("127.0.0.1:0")
if err != nil {
t.Fatalf("NewReader: %s", err)
}
hook := NewGraylogHook(r.Addr(), map[string]interface{}{})
hook.Host = "testing.local"
msgData := "test message\nsecond line"
log := logrus.New()
log.SetReportCaller(false)
log.Out = ioutil.Discard
log.Hooks.Add(hook)
log.Info(msgData)
msg, err := r.ReadMessage()
if err != nil {
t.Errorf("ReadMessage: %s", err)
}
if _, ok := msg.Extra["_file"]; ok {
t.Error("_file field should not present in extra fields")
}
if _, ok := msg.Extra["_line"]; ok {
t.Error("_line field should not present in extra fields")
}
if _, ok := msg.Extra["_function"]; ok {
t.Error("_function field should not present in extra fields")
}
// if reportCaller is disabled (this is the default setting) the File and Line field should have the default values
// corresponding to the types. "" and 0 respectively.
gelfFileExpected := ""
if msg.File != gelfFileExpected {
t.Errorf("msg.File: expected %s, got %s", gelfFileExpected, msg.File)
}
gelfLineExpected := 0
if msg.Line != gelfLineExpected {
t.Errorf("msg.Line: expected %d, got %d", gelfLineExpected, msg.Line)
}
}