Skip to content

docs: clarify chunked behavior in non-blocking pod log example#2645

Open
nagashiva23 wants to merge 1 commit into
kubernetes-client:masterfrom
nagashiva23:first-contribution
Open

docs: clarify chunked behavior in non-blocking pod log example#2645
nagashiva23 wants to merge 1 commit into
kubernetes-client:masterfrom
nagashiva23:first-contribution

Conversation

@nagashiva23

Copy link
Copy Markdown

Summary

Clarify the behavior of pod log streaming when _preload_content=False is used.

The non-blocking log streaming example now explains that streamed data is returned in transport-level chunks, which may contain multiple or partial log lines. Applications that require line-oriented processing should buffer and split on newline boundaries.

Motivation

This change improves the example by documenting behavior that can surprise users when streaming logs with _preload_content=False, as discussed in Issue #2426.

Changes

  • Added explanatory comments to examples/pod_logs_non_blocking.py
  • No runtime behavior changed

@kubernetes-prow

Copy link
Copy Markdown
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Details

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.

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Jul 22, 2026
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 22, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: nagashiva23 / name: nagashiva23 (a256cd1)

@kubernetes-prow
kubernetes-prow Bot requested a review from roycaihw July 22, 2026 04:02
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nagashiva23
Once this PR has been reviewed and has the lgtm label, please assign yliaog for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow
kubernetes-prow Bot requested a review from yliaog July 22, 2026 04:02
@kubernetes-prow kubernetes-prow Bot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 22, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @nagashiva23!

It looks like this is your first PR to kubernetes-client/python 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/python has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant