Split stdout and stderr log stream of container

[knight42]

Enhancement Description

• One-line enhancement description (can be used as a release note): Split stdout and stderr log stream of container
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-node/3288-separate-stdout-from-stderr
• Discussion Link: kubectl logs should allow to discriminate between pod's stderr and stdout kubernetes#28167
• Primary contact (assignee): @knight42
• Responsible SIGs: sig-node, sig-apimachinery, sig-cli
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.32
  • Beta release target (x.y):
  • Stable release target (x.y):
• Alpha
  • KEP (k/enhancements) update PR(s):
    • KEP 3288: Split stdout and stderr log stream #3289
    • feat: update kep 3288 #4879
  • Code (k/k) update PR(s):
    • API: add a new Stream field to PodLogOptions kubernetes#127360
    • feat(kubectl): print the logs from given log sream kubernetes#128159 (not required for 1.32)
    • feat: retrieve specific log stream of a container kubernetes-sigs/cri-tools#1724
  • Docs (k/website) update PR(s):
    • Update docs for split stdout / stderr Pod logging website#48405
    • blog: PodLogsSplitStreams announcement website#48598

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[knight42]

/sig node
/sig api-machinery
/sig cli

[knight42]

/milestone v1.25

[k8s-ci-robot]

@knight42: You must be a member of the kubernetes/milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Milestone Maintainers Team and have them propose you as an additional delegate for this responsibility.

In response to this:

/milestone v1.25

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Priyankasaggu11929]

/milestone v1.25

[Priyankasaggu11929]

Hello @knight42 👋, 1.25 Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00 PST on Thursday June 16, 2022.

For note, This enhancement is targeting for stage alpha for 1.25 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP file using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable
• KEP has a updated detailed test plan section filled out
• KEP has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

Looks like for this one, we would need to get the open KEP PR #3289 merged by Enhancements Freeze:

For note, the status of this enhancement is marked as at risk. Thanks for keeping the issue description up-to-date!

[Priyankasaggu11929]

With KEP PR #3289 merged, this enhancement is ready for the upcoming enhancements freeze.

For note, the status is not marked as tracked in the enhancements tracking sheet. Thank you!

[knight42]

@Priyankasaggu11929 I think the following could be marked as done now:

• KEP file using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable
• KEP has a updated detailed test plan section filled out
• KEP has a production readiness review that has been completed and merged into k/enhancements.

[Atharva-Shinde]

Hi @knight42, Enhancements team here again 👋

Checking in as we approach Code Freeze at 01:00 UTC on Wednesday, 3rd August 2022.

Please ensure that the following items are completed before the code-freeze:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.
  API: Allow Stream to be set in PodLogOptions kubernetes#110794
  Let me know if there are any additional k/k PRs besides the one listed above

Currently, the status of the enhancement is marked as at-risk

Thanks :)

[Atharva-Shinde]

Hey @knight42 reaching out again as we approach Code Freeze at 01:00 UTC on this Wednesday i.e 3rd August 2022.
Try to get this PR kubernetes/kubernetes#110794 merged before the code-freeze :)
The status of the enhancement is still marked as at-risk

[knight42]

@Atharva-Shinde Hi, I think we need to move it to next release v1.26. Thanks!

[Priyankasaggu11929]

Thanks for the update @knight42.

/milestone clear

[marosset]

/milestone v1.26
/label lead-opted-in
(I'm doing this on behalf of @ruiwen-zhao / SIG-node)

[k8s-ci-robot]

@kannon92: Reopened this issue.

In response to this:

/reopen

KEP still has a lot of work to go until it is stable. We should keep this issue open.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[mochizuki875]

@knight42
Hi, current kep.yaml indicates featuregate-name as SplitStdoutAndStderr.
Is it correct?

enhancements/keps/sig-node/3288-separate-stdout-from-stderr/kep.yaml

Lines 31 to 32 in 3fb4087

	feature-gates:
	- name: "SplitStdoutAndStderr"

The correct name seems to be PodLogsQuerySplitStreams.
https://github.com/kubernetes/kubernetes/blob/1e55df4985835ac7f07f6c569cc838aa8cd9bcfa/pkg/features/kube_features.go#L499-L500

[knight42]

@mochizuki875 Thank you! I have filed a PR to fix it.

[dipesh-rawat]

Hello @knight42 👋, 1.33 Enhancements Lead here.

I’m closing milestone 1.32 now. If you'd like to work on this enhancement in v1.33, please have the SIG lead opt-in by adding the lead-opted-in label, which ensures it gets added to the tracking board. Also, please set the milestone to v1.33 using /milestone v1.33.
Thanks!

/remove-label lead-opted-in
/milestone clear

[kannon92]

@knight42 Thank you for opening up kubernetes-sigs/cri-tools#1724 to add this feature to cri-tools.

I hope you can see through the kubectl fix and maybe bring this feature to beta?

[knight42]

I hope you can see through the kubectl fix and maybe bring this feature to beta?

Absolutely! I am working on it.

[haircommander]

/label lead-opted-in
/milestone v1.33

note: PRR freeze is tomorrow! you need to have a KEP update for this opened before then. Thanks!

[kannon92]

@knight42

I think we could get this into beta if you work on this soon.

We have the kubectl PR and we would need a KEP update/PRR updates to promote to beta.

Otherwise we will keep this in alpha for 1.33.

[jenshu]

Hello @knight42 👋, v1.33 Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th February 2025 / 19:00 PDT Thursday 13th February 2025.

This enhancement is targeting stage beta for v1.33 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.33.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline on Thursday 6th February 2025 so that the PRR team has enough time to review your KEP.

For this KEP, we would just need to update the following:

• to match the latest readme template, can you add in the missing question about resource exhaustion under the Scalability section?
• in your kep.yaml, the latest-milestone needs to be updated to v1.33
• in your PRR file, you will need to add an approver for beta

The status of this enhancement is marked as At risk for enhancements freeze. Please keep the issue description up-to-date with appropriate stages as well.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[dipesh-rawat]

Hi @knight42 👋, 1.33 Enhancements team here,

Just a quick friendly reminder as we approach the enhancements freeze later this week, at 02:00 UTC Friday 14th February 2025 / 19:00 PDT Thursday 13th February 2025.

The current status of this enhancement is marked as At risk for enhancement freeze. There are a few requirements mentioned in the comment #3288 (comment) that still need to be completed.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[jenshu]

Hello @knight42 👋, v1.33 Enhancements team here,

Unfortunately, this enhancement did not meet requirements for enhancements freeze.

If you still wish to progress this enhancement in v1.33, please file an exception request as soon as possible, within three days. If you have any questions, you can reach out in the #release-enhancements channel on Slack and we'll be happy to help. Thanks!

/milestone clear

[knight42]

We have the kubectl PR and we would need a KEP update/PRR updates to promote to beta.

@kannon92 Apologies for the delayed response. I believe we should get kubernetes/kubernetes#128159 merged before pursuing beta. Otherwise, it won’t be convenient for users to test the feature and provide feedback.