contextual logging: beta in Kubernetes 1.30 #45288

pohly · 2024-02-22T14:18:04Z

Related-to: kubernetes/enhancements#3077

/hold

kubernetes/kubernetes#122589 needs to be merged first.

netlify · 2024-02-22T14:18:21Z

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

Name	Link
🔨 Latest commit	`4f0dc7a`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/65f48a0c96b08d0008d5b48b

sftim

Please also update content/en/docs/reference/command-line-tools-reference/feature-gates/contextual-logging.md

sftim · 2024-02-22T14:39:37Z

content/en/docs/concepts/cluster-administration/system-logs.md

@@ -133,8 +133,8 @@ If developers use additional functions like `WithValues` or `WithName` in
 their components, then log entries contain additional information that gets
 passed into functions by their caller.

-Currently this is gated behind the `StructuredLogging` feature gate and
-disabled by default. The infrastructure for this was added in 1.24 without
+Currently this is gated behind the `ContextualLogging` feature gate and


Suggested change

Currently this is gated behind the `ContextualLogging` feature gate and

For Kubernetes {{< skew currentVersion >}}, this is gated behind the `ContextualLogging`

[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) and is

Done.

I also updated the feature gate description.

content/en/docs/concepts/cluster-administration/system-logs.md

drewhagen · 2024-03-05T15:52:18Z

Hello @pohly 👋 please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday March 12th 2024 18:00 PST. Thank you!

pohly · 2024-03-06T15:37:38Z

content/en/docs/reference/command-line-tools-reference/feature-gates/contextual-logging.md

- contextual logging add extra detail to log output.
+When you disable this feature gate, Kubernetes components that support
+ contextual logging might produce less detailed log output because
+ some extra information might be provided only as part of the context.


Note that I switched from "if you enable" to "if you disable" here because that is what users would do now.

Also note that when converting existing log calls we try to avoid information loss should the feature get disabled. But in new code that I recently wrote for DRA, I am assuming that the feature remains enabled and avoid logging information both via context and as parameters.

I expect this to happen more often going forward because the duplication is annoying.

We always write descriptions as what happens when the feature is enabled.
Try

Enables additional detail in log output from Kubernetes components that support writing structure logs.

Think about the graduation to stable; Kubernetes still has the feature, but now you cannot disable it. We want a feature description that makes sense for beta and for stable.

Makes sense. I used the text that I had in the main file because this works regardless of the log output format.

Enables extra details in log output of Kubernetes components that support
contextual logging.

drewhagen · 2024-03-15T02:23:44Z

/milestone 1.30

drewhagen · 2024-03-15T05:12:34Z

Hello @pohly 👋, it looks like you've already engaged feedback in review of this PR. Great job! Keep this up. 🚀

@alculquicondor @liggitt @serathius @ehashman @thockin
When one of y'all have a moment, please give a review for technical accuracy. A friendly reminder that this PR needs doc review complete by Doc Freeze on March 26th 18:00 PT to get this into the release.

It also looks like there is a hold here and a PR that has been merged. Can this hold be removed?

Thanks!

pohly · 2024-03-15T07:03:57Z

There's not much technical content that needs to be reviewed here. I think it's fine if the docs team does a LGTM + approve for the wording and formatting.

/hold cancel

Implementation was merged, PR can be merged, too.

sftim

One thing to fix, otherwise LGTM

sftim · 2024-03-15T16:30:09Z

content/en/docs/reference/command-line-tools-reference/feature-gates/contextual-logging.md

- contextual logging add extra detail to log output.
+When you disable this feature gate, Kubernetes components that support
+ contextual logging might produce less detailed log output because
+ some extra information might be provided only as part of the context.


We always write descriptions as what happens when the feature is enabled.
Try

Enables additional detail in log output from Kubernetes components that support writing structure logs.

sftim

/lgtm

for docs

/approve
I don't think this needs a technical review before it merges.

sftim · 2024-03-16T16:38:32Z

content/en/docs/concepts/cluster-administration/system-logs.md

@@ -122,7 +122,7 @@ second line.}

 ### Contextual Logging


(nit / good to fix before GA / yes, I know the rest of the file is also not following the style guide here)

Suggested change

### Contextual Logging

### Contextual logging

k8s-ci-robot · 2024-03-16T16:38:42Z

LGTM label has been added.

Git tree hash: 98023378d82e6b99b4d3f4589d7ec6037bd36753

k8s-ci-robot · 2024-03-16T16:38:52Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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:

~~content/en/OWNERS~~ [sftim]

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

drewhagen · 2024-04-25T23:22:59Z

/milestone 1.30

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 22, 2024

k8s-ci-robot requested review from 44past4 and dims February 22, 2024 14:18

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 22, 2024

pohly mentioned this pull request Feb 22, 2024

contextual logging kubernetes/enhancements#3077

Open

12 tasks

sftim reviewed Feb 22, 2024

View reviewed changes

pohly force-pushed the contextual-logging branch from 2d3a3a9 to fcbeb85 Compare March 6, 2024 15:33

pohly commented Mar 6, 2024

View reviewed changes

k8s-ci-robot added this to the 1.30 milestone Mar 15, 2024

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 15, 2024

sftim requested changes Mar 15, 2024

View reviewed changes

contextual logging: document promotion to beta

4f0dc7a

pohly force-pushed the contextual-logging branch from fcbeb85 to 4f0dc7a Compare March 15, 2024 17:48

sftim reviewed Mar 16, 2024

View reviewed changes

k8s-ci-robot assigned sftim Mar 16, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2024

k8s-ci-robot merged commit 463ce41 into kubernetes:dev-1.30 Mar 16, 2024
6 checks passed

k8s-ci-robot added this to the 1.30 milestone Apr 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

contextual logging: beta in Kubernetes 1.30 #45288

contextual logging: beta in Kubernetes 1.30 #45288

pohly commented Feb 22, 2024

netlify bot commented Feb 22, 2024 •

edited

sftim left a comment

sftim Feb 22, 2024

pohly Mar 6, 2024

drewhagen commented Mar 5, 2024

pohly Mar 6, 2024

sftim Mar 15, 2024

sftim Mar 15, 2024

pohly Mar 15, 2024

drewhagen commented Mar 15, 2024

drewhagen commented Mar 15, 2024

pohly commented Mar 15, 2024

sftim left a comment

sftim Mar 15, 2024

sftim left a comment

sftim Mar 16, 2024

k8s-ci-robot commented Mar 16, 2024

k8s-ci-robot commented Mar 16, 2024

drewhagen commented Apr 25, 2024

	Currently this is gated behind the `ContextualLogging` feature gate and
	For Kubernetes {{< skew currentVersion >}}, this is gated behind the `ContextualLogging`
	[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) and is

contextual logging: beta in Kubernetes 1.30 #45288

contextual logging: beta in Kubernetes 1.30 #45288

Conversation

pohly commented Feb 22, 2024

netlify bot commented Feb 22, 2024 • edited

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

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drewhagen commented Mar 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drewhagen commented Mar 15, 2024

drewhagen commented Mar 15, 2024

pohly commented Mar 15, 2024

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 16, 2024

k8s-ci-robot commented Mar 16, 2024

drewhagen commented Apr 25, 2024

netlify bot commented Feb 22, 2024 •

edited