Skip to content

Commit ce9d9e7

Browse files
committed
Add information about the impact of splitting stdout from stderr
1 parent 0b15e37 commit ce9d9e7

File tree

1 file changed

+10
-10
lines changed
  • keps/sig-instrumentation/2845-deprecate-klog-specific-flags-in-k8s-components

1 file changed

+10
-10
lines changed

keps/sig-instrumentation/2845-deprecate-klog-specific-flags-in-k8s-components/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -182,18 +182,18 @@ For logging formats writing to standard streams, we should follow UNIX standard
182182
of mapping "info" logs to stdout and "error" logs to stderr.
183183

184184
Splitting stdout from stderr would be a breaking change in both klog and
185-
kubernetes components. To avoid that I propose to introduce new logging flag
186-
`--logtostdout` in klog that will allow writing info logs to stdout. This flag
187-
will be used avoid introducing breaking change in klog. For Kubernetes components
188-
we would use this flag to start testing this change and delay enabling this flag
189-
by default by one release when we will hit Beta. As any other klog flag it
190-
should be deprecated when this effort hits GA.
191-
192-
With this flag we can follow multi release plan to user impact (each point
193-
should be done in separate release):
185+
kubernetes components. However, we expect only minimal impact on users, as
186+
redirecting both streams is a common practice. In rare cases that will be
187+
impacted, adapting to this change should be a 1 line change. Still we will want
188+
to give users a proper heads up before making this change, so we will hide the
189+
change behind a new logging flag `--logtostdout`. This flag will be used avoid
190+
introducing breaking change in klog.
191+
192+
With this flag we can follow multi release plan to minimize user impact (each
193+
point should be done in a separate Kubernetes release):
194194
1. Introduce the flag in disabled state and start using it in tests.
195195
1. Announce flag availability and encourage users to adopt it.
196-
1. Enable flag by default and deprecate it (allows users to flip back to previous behavior)
196+
1. Enable the flag by default and deprecate it (allows users to flip back to previous behavior)
197197
1. Remove the flag following the deprecation policy.
198198

199199
#### Logging headers

0 commit comments

Comments
 (0)