Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

logging: structured logging, klog deprecation #30505

Merged
merged 1 commit into from
Nov 20, 2021

Conversation

pohly
Copy link
Contributor

@pohly pohly commented Nov 16, 2021

This is primarily the docs PR for

But as it touches the file, it also updates the examples and explanations to
reflect some recent observations.

@k8s-ci-robot k8s-ci-robot added this to the 1.23 milestone Nov 16, 2021
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 16, 2021
@netlify
Copy link

netlify bot commented Nov 16, 2021

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

🔨 Explore the source changes: c307316

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6195fe8aea995c0007ff7b22

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. language/en Issues or PRs related to English language labels Nov 16, 2021
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 16, 2021
@@ -22,11 +22,59 @@ generates log messages for the Kubernetes system components.

For more information about klog configuration, see the [Command line tool reference](/docs/reference/command-line-tools-reference/).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the right approach for updating the command line tools reference? Manually edit the HTML table?

That needs to be part of this PR.

/hold

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We typically update all generated docs during the release, separately from human-made PRs that accompany changes in that release.

If that's true here to, we can /unhold.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like I don't need to worry about the reference docs then.

/unhold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 16, 2021
| Merge stderr and stdout, write to stdout | `2>&1` | `kube-log-runner` (default behavior) |
| Redirect both into log file | `1>>/tmp/log 2>&1` | `kube-log-runner -log-file=/tmp/log` |
| Copy into log file and to stdout | `2>&1 \| tee -a /tmp/log` | `kube-log-runner -log-file=/tmp/log -also-stdout` |
| Redirect only stdout into log file | `>/tmp/log` | `kube-log-runner -log-file=/tmp/log -redirect-stderr=false` |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to check that this complex table is rendered correctly. It works in GitHub, but I am not sure about the Kubernetes HTML.

Where can I find the preview pages?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, "Deploy preview" is just plain text when I look at that comment.

I see a link to the deploy log, but that also doesn't link to the preview.

Anyway, rendering looks good.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah sorry. It turns out that as a privileged user I get that link and other folks don't.
Not sure why (I don't see it as confidential and the URLs are predictable).

I might nudge Netlify about that if I get time. It's a busy period though!

@sftim
Copy link
Contributor

sftim commented Nov 16, 2021

/sig instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Nov 16, 2021
@mehabhalodiya
Copy link
Contributor

/assign

This is primarily the docs PR for
- alpha: kubernetes/enhancements#2845
- beta: kubernetes/enhancements#1602

But as it touches the file, it also updates the examples and explanations to
reflect some recent observations.
@pohly pohly force-pushed the structured-logging-1.23 branch from 14ff32f to c307316 Compare November 18, 2021 07:19
@pohly pohly changed the title logging: document klog flag deprecation and enhance format examples logging: structured logging, klog deprecation Nov 18, 2021
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 18, 2021
@ehashman
Copy link
Member

ehashman commented Nov 18, 2021

/assign @serathius
(SIG Instrumentation technical reviewer)

@serathius
Copy link
Contributor

LG from technical standpoint.
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 19, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 586c9a34ac508b2c948c0452d8e6bacdefd8b5bf

Copy link
Contributor

@mehabhalodiya mehabhalodiya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from SIG Docs!

@mehabhalodiya
Copy link
Contributor

/cc @jlbutler

@pohly
Copy link
Contributor Author

pohly commented Nov 19, 2021

/assign @reylejano

For approval.

@jlbutler
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jlbutler

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

The pull request process is described here

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 20, 2021
@k8s-ci-robot k8s-ci-robot merged commit 8da444b into kubernetes:dev-1.23 Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants