mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-12-06 00:05:52 +00:00
eaa95b9178
The benchmarks and unit tests were written so that they used custom APIs for each log format. This made them less realistic because there were subtle differences between the benchmark and a real Kubernetes component. Now all logging configuration is done with the official k8s.io/component-base/logs/api/v1. To make the different test cases more comparable, "messages/s" is now reported instead of the generic "ns/op".
235 lines
8.2 KiB
Go
235 lines
8.2 KiB
Go
/*
|
|
Copyright 2021 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package benchmark
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
v1 "k8s.io/api/core/v1"
|
|
logsapi "k8s.io/component-base/logs/api/v1"
|
|
_ "k8s.io/component-base/logs/json/register"
|
|
"k8s.io/klog/v2"
|
|
)
|
|
|
|
func TestData(t *testing.T) {
|
|
container := v1.Container{
|
|
Command: []string{"sh -c \nf=/restart-count/restartCount\ncount=$(echo 'hello' >> $f ; wc -l $f | awk {'print $1'})\nif [ $count -eq 1 ]; then\n\texit 1\nfi\nif [ $count -eq 2 ]; then\n\texit 0\nfi\nwhile true; do sleep 1; done\n"},
|
|
Image: "registry.k8s.io/e2e-test-images/busybox:1.29-2",
|
|
Name: "terminate-cmd-rpn",
|
|
TerminationMessagePath: "/dev/termination-log",
|
|
}
|
|
|
|
testcases := map[string]struct {
|
|
messages []logMessage
|
|
// These are subsets of the full output and may be empty.
|
|
// Prefix and variable stack traces therefore aren't compared.
|
|
printf, structured, json string
|
|
stats logStats
|
|
}{
|
|
"data/simple.log": {
|
|
messages: []logMessage{
|
|
{
|
|
msg: "Pod status updated",
|
|
},
|
|
},
|
|
printf: `Pod status updated: []`,
|
|
structured: `"Pod status updated"`,
|
|
json: `"msg":"Pod status updated","v":0`,
|
|
stats: logStats{
|
|
TotalLines: 1,
|
|
JsonLines: 1,
|
|
ArgCounts: map[string]int{},
|
|
},
|
|
},
|
|
"data/split.log": {
|
|
messages: []logMessage{
|
|
{
|
|
msg: "Pod status updated",
|
|
},
|
|
{
|
|
msg: "Pod status updated again",
|
|
},
|
|
},
|
|
stats: logStats{
|
|
TotalLines: 3,
|
|
SplitLines: 1,
|
|
JsonLines: 2,
|
|
ArgCounts: map[string]int{},
|
|
},
|
|
},
|
|
"data/error.log": {
|
|
messages: []logMessage{
|
|
{
|
|
msg: "Pod status update",
|
|
err: errors.New("failed"),
|
|
isError: true,
|
|
},
|
|
},
|
|
printf: `Pod status update: failed []`,
|
|
structured: `"Pod status update" err="failed"`,
|
|
json: `"msg":"Pod status update","err":"failed"`,
|
|
stats: logStats{
|
|
TotalLines: 1,
|
|
JsonLines: 1,
|
|
ErrorMessages: 1,
|
|
ArgCounts: map[string]int{
|
|
stringArg: 1,
|
|
totalArg: 1,
|
|
},
|
|
},
|
|
},
|
|
"data/error-value.log": {
|
|
messages: []logMessage{
|
|
{
|
|
msg: "Pod status update",
|
|
kvs: []interface{}{"err", errors.New("failed")},
|
|
},
|
|
},
|
|
printf: `Pod status update: [err failed]`,
|
|
structured: `"Pod status update" err="failed"`,
|
|
json: `"msg":"Pod status update","v":0,"err":"failed"`,
|
|
stats: logStats{
|
|
TotalLines: 1,
|
|
JsonLines: 1,
|
|
ArgCounts: map[string]int{
|
|
stringArg: 1,
|
|
totalArg: 1,
|
|
},
|
|
},
|
|
},
|
|
"data/values.log": {
|
|
messages: []logMessage{
|
|
{
|
|
msg: "Example",
|
|
kvs: []interface{}{
|
|
"pod", klog.KRef("system", "kube-scheduler"),
|
|
"pv", klog.KRef("", "volume"),
|
|
"someString", "hello world",
|
|
"someValue", 1.0,
|
|
},
|
|
},
|
|
},
|
|
printf: `Example: [pod system/kube-scheduler pv volume someString hello world someValue 1]`,
|
|
structured: `"Example" pod="system/kube-scheduler" pv="volume" someString="hello world" someValue=1`,
|
|
json: `"msg":"Example","v":0,"pod":{"name":"kube-scheduler","namespace":"system"},"pv":{"name":"volume"},"someString":"hello world","someValue":1`,
|
|
stats: logStats{
|
|
TotalLines: 1,
|
|
JsonLines: 1,
|
|
ArgCounts: map[string]int{
|
|
stringArg: 1,
|
|
krefArg: 2,
|
|
numberArg: 1,
|
|
totalArg: 4,
|
|
},
|
|
},
|
|
},
|
|
"data/container.log": {
|
|
messages: []logMessage{
|
|
{
|
|
msg: "Creating container in pod",
|
|
kvs: []interface{}{
|
|
"container", &container,
|
|
},
|
|
},
|
|
},
|
|
printf: `Creating container in pod: [container &Container{Name:terminate-cmd-rpn,Image:registry.k8s.io/e2e-test-images/busybox:1.29-2,Command:[sh -c`,
|
|
structured: `"Creating container in pod" container=<
|
|
&Container{Name:terminate-cmd-rpn,Image:registry.k8s.io/e2e-test-images/busybox:1.29-2,Command:[sh -c
|
|
f=/restart-count/restartCount
|
|
count=$(echo 'hello' >> $f ; wc -l $f | awk {'print $1'})
|
|
if [ $count -eq 1 ]; then
|
|
exit 1
|
|
fi
|
|
if [ $count -eq 2 ]; then
|
|
exit 0
|
|
fi
|
|
while true; do sleep 1; done
|
|
],Args:[],WorkingDir:,Ports:[]ContainerPort{},Env:[]EnvVar{},Resources:ResourceRequirements{Limits:ResourceList{},Requests:ResourceList{},Claims:[]ResourceClaim{},},VolumeMounts:[]VolumeMount{},LivenessProbe:nil,ReadinessProbe:nil,Lifecycle:nil,TerminationMessagePath:/dev/termination-log,ImagePullPolicy:,SecurityContext:nil,Stdin:false,StdinOnce:false,TTY:false,EnvFrom:[]EnvFromSource{},TerminationMessagePolicy:,VolumeDevices:[]VolumeDevice{},StartupProbe:nil,ResizePolicy:[]ContainerResizePolicy{},}
|
|
>`,
|
|
// This is what the output would look like with JSON object. Because of https://github.com/kubernetes/kubernetes/issues/106652 we get the string instead.
|
|
// json: `{"msg":"Creating container in pod","v":0,"container":{"name":"terminate-cmd-rpn","image":"registry.k8s.io/e2e-test-images/busybox:1.29-2","command":["sh -c \nf=/restart-count/restartCount\ncount=$(echo 'hello' >> $f ; wc -l $f | awk {'print $1'})\nif [ $count -eq 1 ]; then\n\texit 1\nfi\nif [ $count -eq 2 ]; then\n\texit 0\nfi\nwhile true; do sleep 1; done\n"],"resources":{},"terminationMessagePath":"/dev/termination-log"}}
|
|
// `,
|
|
json: `"msg":"Creating container in pod","v":0,"container":"&Container{Name:terminate-cmd-rpn,Image:registry.k8s.io/e2e-test-images/busybox:1.29-2,Command:[sh -c \nf=/restart-count/restartCount\ncount=$(echo 'hello' >> $f ; wc -l $f | awk {'print $1'})\nif [ $count -eq 1 ]; then\n\texit 1\nfi\nif [ $count -eq 2 ]; then\n\texit 0\nfi\nwhile true; do sleep 1; done\n],Args:[],WorkingDir:,Ports:[]ContainerPort{},Env:[]EnvVar{},Resources:ResourceRequirements{Limits:ResourceList{},Requests:ResourceList{},Claims:[]ResourceClaim{},},VolumeMounts:[]VolumeMount{},LivenessProbe:nil,ReadinessProbe:nil,Lifecycle:nil,TerminationMessagePath:/dev/termination-log,ImagePullPolicy:,SecurityContext:nil,Stdin:false,StdinOnce:false,TTY:false,EnvFrom:[]EnvFromSource{},TerminationMessagePolicy:,VolumeDevices:[]VolumeDevice{},StartupProbe:nil,ResizePolicy:[]ContainerResizePolicy{},}"`,
|
|
stats: logStats{
|
|
TotalLines: 2,
|
|
JsonLines: 1,
|
|
ArgCounts: map[string]int{
|
|
totalArg: 1,
|
|
otherArg: 1,
|
|
},
|
|
OtherLines: []string{
|
|
"0: # This is a manually created message. See https://github.com/kubernetes/kubernetes/issues/106652 for the real one.",
|
|
},
|
|
OtherArgs: []interface{}{
|
|
&container,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
for filePath, expected := range testcases {
|
|
t.Run(filePath, func(t *testing.T) {
|
|
messages, stats, err := loadLog(filePath)
|
|
if err != nil {
|
|
t.Fatalf("unexpected load error: %v", err)
|
|
}
|
|
assert.Equal(t, expected.messages, messages)
|
|
assert.Equal(t, expected.stats, stats)
|
|
printAll := func(format func(item logMessage)) {
|
|
for _, item := range expected.messages {
|
|
format(item)
|
|
}
|
|
}
|
|
testBuffered := func(t *testing.T, expected string, format string, print func(item logMessage)) {
|
|
var buffer bytes.Buffer
|
|
c := logsapi.NewLoggingConfiguration()
|
|
c.Format = format
|
|
o := logsapi.LoggingOptions{
|
|
ErrorStream: &buffer,
|
|
InfoStream: &buffer,
|
|
}
|
|
klog.SetOutput(&buffer)
|
|
if err := logsapi.ValidateAndApplyWithOptions(c, &o, nil); err != nil {
|
|
t.Fatalf("Unexpected error configuring logging: %v", err)
|
|
}
|
|
|
|
printAll(print)
|
|
klog.Flush()
|
|
|
|
if !strings.Contains(buffer.String(), expected) {
|
|
t.Errorf("Expected log output to contain:\n%s\nActual log output:\n%s\n", expected, buffer.String())
|
|
}
|
|
}
|
|
|
|
t.Run("printf", func(t *testing.T) {
|
|
testBuffered(t, expected.printf, "text", printf)
|
|
})
|
|
t.Run("structured", func(t *testing.T) {
|
|
testBuffered(t, expected.structured, "text", printLogger)
|
|
})
|
|
t.Run("json", func(t *testing.T) {
|
|
testBuffered(t, expected.json, "json", printLogger)
|
|
})
|
|
})
|
|
}
|
|
}
|