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): 1.33
  • Stable release target (x.y): 1.34
• 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)
  • 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)

[edithturn]

Hello @knight42 , 👋🏼 this is Edith from the v1.32 Communications Team!

We’d love for you to consider writing a feature blog about your enhancement! ✍
Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog, see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[spurin]

Hi @knight42 👋, I'm James Spurin, a 1.32 Docs Shadow. Great to meet you.

Does this enhancement work planned for 1.32 require any new docs or modifications to the existing docs?

If so, please follows the steps here to open a PR against dev-1.32 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday October 24th 2024 18:00 PDT.

Also, take a look at Documenting for a release to familiarise with the docs requirement for the release.

Thank you!

[spurin]

Hi @knight42,

Thanks for tagging me in the PR and referencing the WIP documentation. Appreciated.

I see that this is in progress under PR #48405 and that there are some pending actions based on feedback from @sftim.

Could you please take a look?

At the moment I've marked the documentation as in Draft for the time being on the overall enhancements tracking board.

[jenshu]

Hey again @knight42 👋, v1.32 Enhancements team here.

Just checking in as we approach code freeze at 02:00 UTC Friday 8th November 2024 / 19:00 PDT Thursday 7th November 2024.

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the following PRs need to be merged before code freeze (and we need to update the Issue description to include all the related PRs of this KEP):

• API: add a new Stream field to PodLogOptions kubernetes#127360
• feat(kubectl): print the logs from given log sream kubernetes#128159

If you anticipate missing code freeze, you can file an exception request in advance.

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[edithturn]

Hello, @knight42 ! 🙂 👋

This is a reminder to author your feature blog post!

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog see the blog contribution guidelines.

Please feel free to reach out if you have any questions!

Thank you very much!
Edith from the v1.32 Shadow Communications Team

[jenshu]

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

Unfortunately, the implementation (code related) PR(s) associated with this enhancement are not in the merge-ready state by code-freeze and hence this enhancement is now removed from the v1.32 milestone.

If you still wish to progress this enhancement in v1.32, 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

[kannon92]

We really only need kubernetes/kubernetes#127360 for this feature. Kubectl is a nice to have but not required for alpha.

I think this feature is on track actually.

[jenshu]

@kannon92 thanks for clarifying. I will add it back to the milestone! (also edited the issue description to indicate the kubectl PR is not required for 1.32)

[jenshu]

/milestone v1.32

[knight42]

@kannon92 thanks for clarifying. I will add it back to the milestone! (also edited the issue description to indicate the kubectl PR is not required for 1.32)

Well... the situation is getting complex now, I would love to hear advice from @SergeyKanzhelev @thockin @liggitt .

[rashansmith]

Hello @knight42 👋, v1.32 Comms team here,

Thank you for creating a placeholder PR for a feature blog!

The deadline for completing blog content to be Ready for Review is Monday 25th November 2024 . For more information about writing a blog see the blog contribution guidelines.

Please feel free to reach out if you have any questions!

[kannon92]

/reopen

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

[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.