Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
When compiled with Go >= 1.21, special support for log/slog gets enabled automatically: - The formatting of key/value pairs supports slog.Value and slog.LogValuer, regardless of where those come from. - A slog.GroupValue is formatted as a JSON object. - The logger returned by klog.Background() and the textlogger support usage as a backend for the slog API, via slogr.NewSlogHandler, with builtin support for handling a slog.Record. However, -vmodule does not work when called like that because stack unwinding during the Enabled check finds the wrong source code. - KObj (= ObjectRef) and the type behind KObjSlice support the slog.LogValuer interface and thus get formatted properly by slog backends. The klogr package doesn't get updated. It shouldn't be used anymore. To make that clearer, it gets marked as "deprecated". Examples demonstrate the resulting output. That output has to be exactly the same when used as test, so pid and time get set to fixed values.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| //go:build !go1.21 | ||
| // +build !go1.21 | ||
|
|
||
| /* | ||
| 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 serialize | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| // KVFormat serializes one key/value pair into the provided buffer. | ||
| // A space gets inserted before the pair. | ||
| func (f Formatter) KVFormat(b *bytes.Buffer, k, v interface{}) { | ||
| // This is the version without slog support. Must be kept in sync with | ||
| // the version in keyvalues_slog.go. | ||
|
|
||
| b.WriteByte(' ') | ||
| // Keys are assumed to be well-formed according to | ||
| // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#name-arguments | ||
| // for the sake of performance. Keys with spaces, | ||
| // special characters, etc. will break parsing. | ||
| if sK, ok := k.(string); ok { | ||
| // Avoid one allocation when the key is a string, which | ||
| // normally it should be. | ||
| b.WriteString(sK) | ||
| } else { | ||
| b.WriteString(fmt.Sprintf("%s", k)) | ||
| } | ||
|
|
||
| // The type checks are sorted so that more frequently used ones | ||
| // come first because that is then faster in the common | ||
| // cases. In Kubernetes, ObjectRef (a Stringer) is more common | ||
| // than plain strings | ||
| // (https://github.com/kubernetes/kubernetes/pull/106594#issuecomment-975526235). | ||
| switch v := v.(type) { | ||
| case textWriter: | ||
| writeTextWriterValue(b, v) | ||
| case fmt.Stringer: | ||
| writeStringValue(b, StringerToString(v)) | ||
| case string: | ||
| writeStringValue(b, v) | ||
| case error: | ||
| writeStringValue(b, ErrorToString(v)) | ||
| case logr.Marshaler: | ||
| value := MarshalerToValue(v) | ||
| // A marshaler that returns a string is useful for | ||
| // delayed formatting of complex values. We treat this | ||
| // case like a normal string. This is useful for | ||
| // multi-line support. | ||
| // | ||
| // We could do this by recursively formatting a value, | ||
| // but that comes with the risk of infinite recursion | ||
| // if a marshaler returns itself. Instead we call it | ||
| // only once and rely on it returning the intended | ||
| // value directly. | ||
| switch value := value.(type) { | ||
| case string: | ||
| writeStringValue(b, value) | ||
| default: | ||
| f.formatAny(b, value) | ||
| } | ||
| case []byte: | ||
| // In https://github.com/kubernetes/klog/pull/237 it was decided | ||
| // to format byte slices with "%+q". The advantages of that are: | ||
| // - readable output if the bytes happen to be printable | ||
| // - non-printable bytes get represented as unicode escape | ||
| // sequences (\uxxxx) | ||
| // | ||
| // The downsides are that we cannot use the faster | ||
| // strconv.Quote here and that multi-line output is not | ||
| // supported. If developers know that a byte array is | ||
| // printable and they want multi-line output, they can | ||
| // convert the value to string before logging it. | ||
| b.WriteByte('=') | ||
| b.WriteString(fmt.Sprintf("%+q", v)) | ||
| default: | ||
| f.formatAny(b, v) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| //go:build go1.21 | ||
| // +build go1.21 | ||
|
|
||
| /* | ||
| 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 serialize | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "log/slog" | ||
| "strconv" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| // KVFormat serializes one key/value pair into the provided buffer. | ||
| // A space gets inserted before the pair. | ||
| func (f Formatter) KVFormat(b *bytes.Buffer, k, v interface{}) { | ||
| // This is the version without slog support. Must be kept in sync with | ||
| // the version in keyvalues_slog.go. | ||
|
|
||
| b.WriteByte(' ') | ||
| // Keys are assumed to be well-formed according to | ||
| // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#name-arguments | ||
| // for the sake of performance. Keys with spaces, | ||
| // special characters, etc. will break parsing. | ||
| if sK, ok := k.(string); ok { | ||
| // Avoid one allocation when the key is a string, which | ||
| // normally it should be. | ||
| b.WriteString(sK) | ||
| } else { | ||
| b.WriteString(fmt.Sprintf("%s", k)) | ||
| } | ||
|
|
||
| // The type checks are sorted so that more frequently used ones | ||
| // come first because that is then faster in the common | ||
| // cases. In Kubernetes, ObjectRef (a Stringer) is more common | ||
| // than plain strings | ||
| // (https://github.com/kubernetes/kubernetes/pull/106594#issuecomment-975526235). | ||
| // | ||
| // slog.LogValuer does not need to be handled here because the handler will | ||
| // already have resolved such special values to the final value for logging. | ||
| switch v := v.(type) { | ||
| case textWriter: | ||
| writeTextWriterValue(b, v) | ||
| case slog.Value: | ||
| // This must come before fmt.Stringer because slog.Value implements | ||
| // fmt.Stringer, but does not produce the output that we want. | ||
| b.WriteByte('=') | ||
| generateJSON(b, v) | ||
| case fmt.Stringer: | ||
| writeStringValue(b, StringerToString(v)) | ||
| case string: | ||
| writeStringValue(b, v) | ||
| case error: | ||
| writeStringValue(b, ErrorToString(v)) | ||
| case logr.Marshaler: | ||
| value := MarshalerToValue(v) | ||
| // A marshaler that returns a string is useful for | ||
| // delayed formatting of complex values. We treat this | ||
| // case like a normal string. This is useful for | ||
| // multi-line support. | ||
| // | ||
| // We could do this by recursively formatting a value, | ||
| // but that comes with the risk of infinite recursion | ||
| // if a marshaler returns itself. Instead we call it | ||
| // only once and rely on it returning the intended | ||
| // value directly. | ||
| switch value := value.(type) { | ||
| case string: | ||
| writeStringValue(b, value) | ||
| default: | ||
| f.formatAny(b, value) | ||
| } | ||
| case slog.LogValuer: | ||
| value := slog.AnyValue(v).Resolve() | ||
| if value.Kind() == slog.KindString { | ||
| writeStringValue(b, value.String()) | ||
| } else { | ||
| b.WriteByte('=') | ||
| generateJSON(b, value) | ||
| } | ||
| case []byte: | ||
| // In https://github.com/kubernetes/klog/pull/237 it was decided | ||
| // to format byte slices with "%+q". The advantages of that are: | ||
| // - readable output if the bytes happen to be printable | ||
| // - non-printable bytes get represented as unicode escape | ||
| // sequences (\uxxxx) | ||
| // | ||
| // The downsides are that we cannot use the faster | ||
| // strconv.Quote here and that multi-line output is not | ||
| // supported. If developers know that a byte array is | ||
| // printable and they want multi-line output, they can | ||
| // convert the value to string before logging it. | ||
| b.WriteByte('=') | ||
| b.WriteString(fmt.Sprintf("%+q", v)) | ||
| default: | ||
| f.formatAny(b, v) | ||
| } | ||
| } | ||
|
|
||
| // generateJSON has the same preference for plain strings as KVFormat. | ||
| // In contrast to KVFormat it always produces valid JSON with no line breaks. | ||
| func generateJSON(b *bytes.Buffer, v interface{}) { | ||
| switch v := v.(type) { | ||
| case slog.Value: | ||
| switch v.Kind() { | ||
| case slog.KindGroup: | ||
| // Format as a JSON group. We must not involve f.AnyToStringHook (if there is any), | ||
| // because there is no guarantee that it produces valid JSON. | ||
| b.WriteByte('{') | ||
| for i, attr := range v.Group() { | ||
| if i > 0 { | ||
| b.WriteByte(',') | ||
| } | ||
| b.WriteString(strconv.Quote(attr.Key)) | ||
| b.WriteByte(':') | ||
| generateJSON(b, attr.Value) | ||
| } | ||
| b.WriteByte('}') | ||
| case slog.KindLogValuer: | ||
| generateJSON(b, v.Resolve()) | ||
| default: | ||
| // Peel off the slog.Value wrapper and format the actual value. | ||
| generateJSON(b, v.Any()) | ||
| } | ||
| case fmt.Stringer: | ||
| b.WriteString(strconv.Quote(StringerToString(v))) | ||
| case logr.Marshaler: | ||
| generateJSON(b, MarshalerToValue(v)) | ||
| case slog.LogValuer: | ||
| generateJSON(b, slog.AnyValue(v).Resolve().Any()) | ||
| case string: | ||
| b.WriteString(strconv.Quote(v)) | ||
| case error: | ||
| b.WriteString(strconv.Quote(v.Error())) | ||
| default: | ||
| formatAsJSON(b, v) | ||
| } | ||
| } |
Oops, something went wrong.