forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
filelog_test.go
379 lines (325 loc) · 11.2 KB
/
filelog_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
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package filelogreceiver
import (
"context"
"fmt"
"log"
"os"
"path/filepath"
"runtime"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/observiq/nanojack"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/confmap/confmaptest"
"go.opentelemetry.io/collector/consumer/consumertest"
"go.opentelemetry.io/collector/pdata/plog"
"go.opentelemetry.io/collector/receiver/receivertest"
"go.uber.org/zap"
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/consumerretry"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/adapter"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/file"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/json"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/regex"
)
func TestDefaultConfig(t *testing.T) {
factory := NewFactory()
cfg := factory.CreateDefaultConfig()
require.NotNil(t, cfg, "failed to create default config")
require.NoError(t, componenttest.CheckConfigStruct(cfg))
}
func TestLoadConfig(t *testing.T) {
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
require.NoError(t, err)
factory := NewFactory()
cfg := factory.CreateDefaultConfig()
sub, err := cm.Sub(component.NewID("filelog").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))
assert.NoError(t, component.ValidateConfig(cfg))
assert.Equal(t, testdataConfigYaml(), cfg)
}
func TestCreateWithInvalidInputConfig(t *testing.T) {
t.Parallel()
cfg := testdataConfigYaml()
cfg.InputConfig.StartAt = "middle"
_, err := NewFactory().CreateLogsReceiver(
context.Background(),
receivertest.NewNopCreateSettings(),
cfg,
new(consumertest.LogsSink),
)
require.Error(t, err, "receiver creation should fail if given invalid input config")
}
func TestReadStaticFile(t *testing.T) {
t.Parallel()
expectedTimestamp, _ := time.ParseInLocation("2006-01-02", "2020-08-25", time.Local)
f := NewFactory()
sink := new(consumertest.LogsSink)
cfg := testdataConfigYaml()
converter := adapter.NewConverter(zap.NewNop())
converter.Start()
defer converter.Stop()
var wg sync.WaitGroup
wg.Add(1)
go consumeNLogsFromConverter(converter.OutChannel(), 3, &wg)
rcvr, err := f.CreateLogsReceiver(context.Background(), receivertest.NewNopCreateSettings(), cfg, sink)
require.NoError(t, err, "failed to create receiver")
require.NoError(t, rcvr.Start(context.Background(), componenttest.NewNopHost()))
// Build the expected set by using adapter.Converter to translate entries
// to pdata Logs.
queueEntry := func(t *testing.T, c *adapter.Converter, msg string, severity entry.Severity) {
e := entry.New()
e.Timestamp = expectedTimestamp
require.NoError(t, e.Set(entry.NewBodyField("msg"), msg))
e.Severity = severity
e.AddAttribute("file_name", "simple.log")
require.NoError(t, c.Batch([]*entry.Entry{e}))
}
queueEntry(t, converter, "Something routine", entry.Info)
queueEntry(t, converter, "Something bad happened!", entry.Error)
queueEntry(t, converter, "Some details...", entry.Debug)
dir, err := os.Getwd()
require.NoError(t, err)
t.Logf("Working Directory: %s", dir)
wg.Wait()
require.Eventually(t, expectNLogs(sink, 3), 2*time.Second, 5*time.Millisecond,
"expected %d but got %d logs",
3, sink.LogRecordCount(),
)
// TODO: Figure out a nice way to assert each logs entry content.
// require.Equal(t, expectedLogs, sink.AllLogs())
require.NoError(t, rcvr.Shutdown(context.Background()))
}
func TestReadRotatingFiles(t *testing.T) {
tests := []rotationTest{
{
name: "CopyTruncateTimestamped",
copyTruncate: true,
sequential: false,
},
{
name: "CopyTruncateSequential",
copyTruncate: true,
sequential: true,
},
}
if runtime.GOOS != "windows" {
// Windows has very poor support for moving active files, so rotation is less commonly used
tests = append(tests, []rotationTest{
{
name: "MoveCreateTimestamped",
copyTruncate: false,
sequential: false,
},
{
name: "MoveCreateSequential",
copyTruncate: false,
sequential: true,
},
}...)
}
for _, tc := range tests {
t.Run(tc.name, tc.Run)
}
}
type rotationTest struct {
name string
copyTruncate bool
sequential bool
}
func (rt *rotationTest) Run(t *testing.T) {
t.Parallel()
tempDir := t.TempDir()
f := NewFactory()
sink := new(consumertest.LogsSink)
cfg := rotationTestConfig(tempDir)
// With a max of 100 logs per file and 1 backup file, rotation will occur
// when more than 100 logs are written, and deletion when more than 200 are written.
// Write 300 and validate that we got the all despite rotation and deletion.
logger := newRotatingLogger(t, tempDir, 100, 1, rt.copyTruncate, rt.sequential)
numLogs := 300
// Build expected outputs
expectedTimestamp, _ := time.ParseInLocation("2006-01-02", "2020-08-25", time.Local)
converter := adapter.NewConverter(zap.NewNop())
converter.Start()
var wg sync.WaitGroup
wg.Add(1)
go consumeNLogsFromConverter(converter.OutChannel(), numLogs, &wg)
rcvr, err := f.CreateLogsReceiver(context.Background(), receivertest.NewNopCreateSettings(), cfg, sink)
require.NoError(t, err, "failed to create receiver")
require.NoError(t, rcvr.Start(context.Background(), componenttest.NewNopHost()))
for i := 0; i < numLogs; i++ {
msg := fmt.Sprintf("This is a simple log line with the number %3d", i)
// Build the expected set by converting entries to pdata Logs...
e := entry.New()
e.Timestamp = expectedTimestamp
require.NoError(t, e.Set(entry.NewBodyField("msg"), msg))
require.NoError(t, converter.Batch([]*entry.Entry{e}))
// ... and write the logs lines to the actual file consumed by receiver.
logger.Printf("2020-08-25 %s", msg)
time.Sleep(time.Millisecond)
}
wg.Wait()
require.Eventually(t, expectNLogs(sink, numLogs), 2*time.Second, 10*time.Millisecond,
"expected %d but got %d logs",
numLogs, sink.LogRecordCount(),
)
// TODO: Figure out a nice way to assert each logs entry content.
// require.Equal(t, expectedLogs, sink.AllLogs())
require.NoError(t, rcvr.Shutdown(context.Background()))
converter.Stop()
}
func consumeNLogsFromConverter(ch <-chan plog.Logs, count int, wg *sync.WaitGroup) {
defer wg.Done()
n := 0
for pLog := range ch {
n += pLog.ResourceLogs().At(0).ScopeLogs().At(0).LogRecords().Len()
if n == count {
return
}
}
}
func newRotatingLogger(t *testing.T, tempDir string, maxLines, maxBackups int, copyTruncate, sequential bool) *log.Logger {
path := filepath.Join(tempDir, "test.log")
rotator := &nanojack.Logger{
Filename: path,
MaxLines: maxLines,
MaxBackups: maxBackups,
CopyTruncate: copyTruncate,
Sequential: sequential,
}
t.Cleanup(func() { _ = rotator.Close() })
return log.New(rotator, "", 0)
}
func expectNLogs(sink *consumertest.LogsSink, expected int) func() bool {
return func() bool { return sink.LogRecordCount() == expected }
}
func testdataConfigYaml() *FileLogConfig {
return &FileLogConfig{
BaseConfig: adapter.BaseConfig{
Operators: []operator.Config{
{
Builder: func() *regex.Config {
cfg := regex.NewConfig()
cfg.Regex = "^(?P<time>\\d{4}-\\d{2}-\\d{2}) (?P<sev>[A-Z]*) (?P<msg>.*)$"
sevField := entry.NewAttributeField("sev")
sevCfg := helper.NewSeverityConfig()
sevCfg.ParseFrom = &sevField
cfg.SeverityConfig = &sevCfg
timeField := entry.NewAttributeField("time")
timeCfg := helper.NewTimeParser()
timeCfg.Layout = "%Y-%m-%d"
timeCfg.ParseFrom = &timeField
cfg.TimeParser = &timeCfg
return cfg
}(),
},
},
RetryOnFailure: consumerretry.Config{
Enabled: false,
InitialInterval: 1 * time.Second,
MaxInterval: 30 * time.Second,
MaxElapsedTime: 5 * time.Minute,
},
},
InputConfig: func() file.Config {
c := file.NewConfig()
c.Include = []string{"testdata/simple.log"}
c.StartAt = "beginning"
return *c
}(),
}
}
func rotationTestConfig(tempDir string) *FileLogConfig {
return &FileLogConfig{
BaseConfig: adapter.BaseConfig{
Operators: []operator.Config{
{
Builder: func() *regex.Config {
cfg := regex.NewConfig()
cfg.Regex = "^(?P<ts>\\d{4}-\\d{2}-\\d{2}) (?P<msg>[^\n]+)"
timeField := entry.NewAttributeField("ts")
timeCfg := helper.NewTimeParser()
timeCfg.Layout = "%Y-%m-%d"
timeCfg.ParseFrom = &timeField
cfg.TimeParser = &timeCfg
return cfg
}(),
},
},
},
InputConfig: func() file.Config {
c := file.NewConfig()
c.Include = []string{fmt.Sprintf("%s/*", tempDir)}
c.StartAt = "beginning"
c.PollInterval = 10 * time.Millisecond
c.IncludeFileName = false
return *c
}(),
}
}
// TestConsumeContract tests the contract between the filelog receiver and the next consumer with enabled retry.
func TestConsumeContract(t *testing.T) {
tmpDir := t.TempDir()
filePattern := "test-*.log"
flg := &fileLogGenerator{t: t, tmpDir: tmpDir, filePattern: filePattern}
cfg := createDefaultConfig()
cfg.RetryOnFailure.Enabled = true
cfg.RetryOnFailure.InitialInterval = 1 * time.Millisecond
cfg.RetryOnFailure.MaxInterval = 10 * time.Millisecond
cfg.InputConfig.Include = []string{filepath.Join(tmpDir, filePattern)}
cfg.InputConfig.StartAt = "beginning"
jsonParser := json.NewConfig()
tsField := entry.NewAttributeField("ts")
jsonParser.TimeParser = &helper.TimeParser{
ParseFrom: &tsField,
Layout: time.RFC3339,
LayoutType: "gotime",
}
jsonParser.ParseTo = entry.RootableField{Field: entry.NewAttributeField()}
logField := entry.NewAttributeField("log")
jsonParser.BodyField = &logField
cfg.Operators = []operator.Config{{Builder: jsonParser}}
receivertest.CheckConsumeContract(receivertest.CheckConsumeContractParams{
T: t,
Factory: NewFactory(),
DataType: component.DataTypeLogs,
Config: cfg,
Generator: flg,
GenerateCount: 10000,
})
}
type fileLogGenerator struct {
t *testing.T
tmpDir string
filePattern string
tmpFile *os.File
sequenceNum int64
}
func (g *fileLogGenerator) Start() {
tmpFile, err := os.CreateTemp(g.tmpDir, g.filePattern)
require.NoError(g.t, err)
g.tmpFile = tmpFile
}
func (g *fileLogGenerator) Stop() {
require.NoError(g.t, g.tmpFile.Close())
require.NoError(g.t, os.Remove(g.tmpFile.Name()))
}
func (g *fileLogGenerator) Generate() []receivertest.UniqueIDAttrVal {
id := receivertest.UniqueIDAttrVal(fmt.Sprintf("%d", atomic.AddInt64(&g.sequenceNum, 1)))
logLine := fmt.Sprintf(`{"ts": "%s", "log": "log-%s", "%s": "%s"}`, time.Now().Format(time.RFC3339), id,
receivertest.UniqueIDAttrName, id)
_, err := g.tmpFile.WriteString(logLine + "\n")
require.NoError(g.t, err)
return []receivertest.UniqueIDAttrVal{id}
}