mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-29 22:46:12 +00:00
component-base: fix documentation of log flush frequency
The intention for Kubernetes 1.23 was to support `flushFrequency: 60` and treat that as seconds. But time.Duration counts nanoseconds. Because the struct is embedded inside the beta KubeletConfiguration, we cannot switch to a type that serializes differently (like metav1.Duration) and therefore (for now) just update the documentation to match the implementation from Kubernetes 1.23.
This commit is contained in:
parent
018288b38f
commit
f9c8a9d794
@ -93,8 +93,9 @@ type LoggingConfiguration struct {
|
|||||||
// Format Flag specifies the structure of log messages.
|
// Format Flag specifies the structure of log messages.
|
||||||
// default value of format is `text`
|
// default value of format is `text`
|
||||||
Format string
|
Format string
|
||||||
// Maximum number of seconds between log flushes. Ignored if the
|
// Maximum number of nanoseconds (i.e. 1s = 1000000000) between log
|
||||||
// selected logging backend writes log messages without buffering.
|
// flushes. Ignored if the selected logging backend writes log
|
||||||
|
// messages without buffering.
|
||||||
FlushFrequency time.Duration
|
FlushFrequency time.Duration
|
||||||
// Verbosity is the threshold that determines which log messages are
|
// Verbosity is the threshold that determines which log messages are
|
||||||
// logged. Default is zero which logs only the most important
|
// logged. Default is zero which logs only the most important
|
||||||
|
@ -90,8 +90,9 @@ type LoggingConfiguration struct {
|
|||||||
// Format Flag specifies the structure of log messages.
|
// Format Flag specifies the structure of log messages.
|
||||||
// default value of format is `text`
|
// default value of format is `text`
|
||||||
Format string `json:"format,omitempty"`
|
Format string `json:"format,omitempty"`
|
||||||
// Maximum number of seconds between log flushes. Ignored if the
|
// Maximum number of nanoseconds (i.e. 1s = 1000000000) between log
|
||||||
// selected logging backend writes log messages without buffering.
|
// flushes. Ignored if the selected logging backend writes log
|
||||||
|
// messages without buffering.
|
||||||
FlushFrequency time.Duration `json:"flushFrequency"`
|
FlushFrequency time.Duration `json:"flushFrequency"`
|
||||||
// Verbosity is the threshold that determines which log messages are
|
// Verbosity is the threshold that determines which log messages are
|
||||||
// logged. Default is zero which logs only the most important
|
// logged. Default is zero which logs only the most important
|
||||||
|
Loading…
Reference in New Issue
Block a user