mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
c55a4ac779
The io/ioutil package has been deprecated in Go 1.16. This commit replaces the existing io/ioutil functions with their new definitions in io and os packages. Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
320 lines
9.6 KiB
Go
320 lines
9.6 KiB
Go
package jsonfilelog // import "github.com/docker/docker/daemon/logger/jsonfilelog"
|
|
|
|
import (
|
|
"bytes"
|
|
"compress/gzip"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"reflect"
|
|
"strconv"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/docker/docker/daemon/logger"
|
|
"github.com/docker/docker/daemon/logger/jsonfilelog/jsonlog"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
"gotest.tools/v3/fs"
|
|
)
|
|
|
|
func TestJSONFileLogger(t *testing.T) {
|
|
cid := "a7317399f3f857173c6179d44823594f8294678dea9999662e5c625b5a1c7657"
|
|
tmp, err := os.MkdirTemp("", "docker-logger-")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer os.RemoveAll(tmp)
|
|
filename := filepath.Join(tmp, "container.log")
|
|
l, err := New(logger.Info{
|
|
ContainerID: cid,
|
|
LogPath: filename,
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer l.Close()
|
|
|
|
if err := l.Log(&logger.Message{Line: []byte("line1"), Source: "src1"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := l.Log(&logger.Message{Line: []byte("line2"), Source: "src2"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := l.Log(&logger.Message{Line: []byte("line3"), Source: "src3"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
res, err := os.ReadFile(filename)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
expected := `{"log":"line1\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line2\n","stream":"src2","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line3\n","stream":"src3","time":"0001-01-01T00:00:00Z"}
|
|
`
|
|
|
|
if string(res) != expected {
|
|
t.Fatalf("Wrong log content: %q, expected %q", res, expected)
|
|
}
|
|
}
|
|
|
|
func TestJSONFileLoggerWithTags(t *testing.T) {
|
|
cid := "a7317399f3f857173c6179d44823594f8294678dea9999662e5c625b5a1c7657"
|
|
cname := "test-container"
|
|
tmp, err := os.MkdirTemp("", "docker-logger-")
|
|
|
|
assert.NilError(t, err)
|
|
|
|
defer os.RemoveAll(tmp)
|
|
filename := filepath.Join(tmp, "container.log")
|
|
l, err := New(logger.Info{
|
|
Config: map[string]string{
|
|
"tag": "{{.ID}}/{{.Name}}", // first 12 characters of ContainerID and full ContainerName
|
|
},
|
|
ContainerID: cid,
|
|
ContainerName: cname,
|
|
LogPath: filename,
|
|
})
|
|
|
|
assert.NilError(t, err)
|
|
defer l.Close()
|
|
|
|
err = l.Log(&logger.Message{Line: []byte("line1"), Source: "src1"})
|
|
assert.NilError(t, err)
|
|
|
|
err = l.Log(&logger.Message{Line: []byte("line2"), Source: "src2"})
|
|
assert.NilError(t, err)
|
|
|
|
err = l.Log(&logger.Message{Line: []byte("line3"), Source: "src3"})
|
|
assert.NilError(t, err)
|
|
|
|
res, err := os.ReadFile(filename)
|
|
assert.NilError(t, err)
|
|
|
|
expected := `{"log":"line1\n","stream":"src1","attrs":{"tag":"a7317399f3f8/test-container"},"time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line2\n","stream":"src2","attrs":{"tag":"a7317399f3f8/test-container"},"time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line3\n","stream":"src3","attrs":{"tag":"a7317399f3f8/test-container"},"time":"0001-01-01T00:00:00Z"}
|
|
`
|
|
assert.Check(t, is.Equal(expected, string(res)))
|
|
}
|
|
|
|
func BenchmarkJSONFileLoggerLog(b *testing.B) {
|
|
tmp := fs.NewDir(b, "bench-jsonfilelog")
|
|
defer tmp.Remove()
|
|
|
|
jsonlogger, err := New(logger.Info{
|
|
ContainerID: "a7317399f3f857173c6179d44823594f8294678dea9999662e5c625b5a1c7657",
|
|
LogPath: tmp.Join("container.log"),
|
|
Config: map[string]string{
|
|
"labels": "first,second",
|
|
"max-file": "10",
|
|
"compress": "true",
|
|
"max-size": "20m",
|
|
},
|
|
ContainerLabels: map[string]string{
|
|
"first": "label_value",
|
|
"second": "label_foo",
|
|
},
|
|
})
|
|
assert.NilError(b, err)
|
|
defer jsonlogger.Close()
|
|
|
|
t := time.Now().UTC()
|
|
for _, data := range [][]byte{
|
|
[]byte(""),
|
|
[]byte("a short string"),
|
|
bytes.Repeat([]byte("a long string"), 100),
|
|
bytes.Repeat([]byte("a really long string"), 10000),
|
|
} {
|
|
b.Run(fmt.Sprintf("%d", len(data)), func(b *testing.B) {
|
|
testMsg := &logger.Message{
|
|
Line: data,
|
|
Source: "stderr",
|
|
Timestamp: t,
|
|
}
|
|
|
|
buf := bytes.NewBuffer(nil)
|
|
assert.NilError(b, marshalMessage(testMsg, nil, buf))
|
|
b.SetBytes(int64(buf.Len()))
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
msg := logger.NewMessage()
|
|
msg.Line = testMsg.Line
|
|
msg.Timestamp = testMsg.Timestamp
|
|
msg.Source = testMsg.Source
|
|
if err := jsonlogger.Log(msg); err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestJSONFileLoggerWithOpts(t *testing.T) {
|
|
cid := "a7317399f3f857173c6179d44823594f8294678dea9999662e5c625b5a1c7657"
|
|
tmp, err := os.MkdirTemp("", "docker-logger-")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer os.RemoveAll(tmp)
|
|
filename := filepath.Join(tmp, "container.log")
|
|
config := map[string]string{"max-file": "3", "max-size": "1k", "compress": "true"}
|
|
l, err := New(logger.Info{
|
|
ContainerID: cid,
|
|
LogPath: filename,
|
|
Config: config,
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer l.Close()
|
|
for i := 0; i < 36; i++ {
|
|
if err := l.Log(&logger.Message{Line: []byte("line" + strconv.Itoa(i)), Source: "src1"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
res, err := os.ReadFile(filename)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
penUlt, err := os.ReadFile(filename + ".1")
|
|
if err != nil {
|
|
if !os.IsNotExist(err) {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
file, err := os.Open(filename + ".1.gz")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer file.Close()
|
|
zipReader, err := gzip.NewReader(file)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer zipReader.Close()
|
|
penUlt, err = io.ReadAll(zipReader)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
file, err := os.Open(filename + ".2.gz")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer file.Close()
|
|
zipReader, err := gzip.NewReader(file)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer zipReader.Close()
|
|
antepenult, err := io.ReadAll(zipReader)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
expectedAntepenultimate := `{"log":"line0\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line1\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line2\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line3\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line4\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line5\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line6\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line7\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line8\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line9\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line10\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line11\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line12\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line13\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line14\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line15\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
`
|
|
expectedPenultimate := `{"log":"line16\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line17\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line18\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line19\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line20\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line21\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line22\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line23\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line24\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line25\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line26\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line27\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line28\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line29\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line30\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line31\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
`
|
|
expected := `{"log":"line32\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line33\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line34\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
{"log":"line35\n","stream":"src1","time":"0001-01-01T00:00:00Z"}
|
|
`
|
|
|
|
if string(res) != expected {
|
|
t.Fatalf("Wrong log content: %q, expected %q", res, expected)
|
|
}
|
|
if string(penUlt) != expectedPenultimate {
|
|
t.Fatalf("Wrong log content: %q, expected %q", penUlt, expectedPenultimate)
|
|
}
|
|
if string(antepenult) != expectedAntepenultimate {
|
|
t.Fatalf("Wrong log content: %q, expected %q", antepenult, expectedAntepenultimate)
|
|
}
|
|
}
|
|
|
|
func TestJSONFileLoggerWithLabelsEnv(t *testing.T) {
|
|
cid := "a7317399f3f857173c6179d44823594f8294678dea9999662e5c625b5a1c7657"
|
|
tmp, err := os.MkdirTemp("", "docker-logger-")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer os.RemoveAll(tmp)
|
|
filename := filepath.Join(tmp, "container.log")
|
|
config := map[string]string{"labels": "rack,dc", "labels-regex": "^loc", "env": "environ,debug,ssl", "env-regex": "^dc"}
|
|
l, err := New(logger.Info{
|
|
ContainerID: cid,
|
|
LogPath: filename,
|
|
Config: config,
|
|
ContainerLabels: map[string]string{"rack": "101", "dc": "lhr", "location": "here"},
|
|
ContainerEnv: []string{"environ=production", "debug=false", "port=10001", "ssl=true", "dc_region=west"},
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer l.Close()
|
|
if err := l.Log(&logger.Message{Line: []byte("line"), Source: "src1"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
res, err := os.ReadFile(filename)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
var jsonLog jsonlog.JSONLogs
|
|
if err := json.Unmarshal(res, &jsonLog); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
extra := make(map[string]string)
|
|
if err := json.Unmarshal(jsonLog.RawAttrs, &extra); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
expected := map[string]string{
|
|
"rack": "101",
|
|
"dc": "lhr",
|
|
"location": "here",
|
|
"environ": "production",
|
|
"debug": "false",
|
|
"ssl": "true",
|
|
"dc_region": "west",
|
|
}
|
|
if !reflect.DeepEqual(extra, expected) {
|
|
t.Fatalf("Wrong log attrs: %q, expected %q", extra, expected)
|
|
}
|
|
}
|