Skip to content

Support structured logging: broadcaster & eventRecorder #171

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

Conversation

bells17
Copy link
Contributor

@bells17 bells17 commented May 3, 2024

What type of PR is this?

/kind feature

What this PR does / why we need it:

In the following PR, support for contextual logging was implemented, but the broadcaster and eventRecorder were not updated to support contextual logging.
#154

Therefore, I made changes to enable the use of contextual logging within the broadcaster and eventRecorder as well.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

kubernetes/kubernetes#120729

Does this PR introduce a user-facing change?:

Signature of NewProvisionController has been changed to support contextual logging for eventRecorder. This is a breaking change that requires updates to code that calls this function.

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label May 3, 2024
@k8s-ci-robot k8s-ci-robot requested review from pohly and wongma7 May 3, 2024 17:15
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 3, 2024
@bells17
Copy link
Contributor Author

bells17 commented May 3, 2024

/wg structured-logging
/area logging
/priority important-longterm
/kind cleanup
/cc @kubernetes/wg-structured-logging-reviews

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#what-to-include-in-the-pull-request

@k8s-ci-robot
Copy link
Contributor

@bells17: GitHub didn't allow me to request PR reviews from the following users: kubernetes/wg-structured-logging-reviews.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/wg structured-logging
/area logging
/priority important-longterm
/kind cleanup
/cc @kubernetes/wg-structured-logging-reviews

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#what-to-include-in-the-pull-request

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.

@k8s-ci-robot k8s-ci-robot added wg/structured-logging Categorizes an issue or PR as relevant to WG Structured Logging. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels May 3, 2024
@k8s-ci-robot
Copy link
Contributor

@bells17: The label(s) area/logging cannot be applied, because the repository doesn't have them.

In response to this:

/wg structured-logging
/area logging
/priority important-longterm
/kind cleanup
/cc @kubernetes/wg-structured-logging-reviews

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#what-to-include-in-the-pull-request

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.

@bells17
Copy link
Contributor Author

bells17 commented May 3, 2024

/cc @jsafrane

#154 (comment)

@k8s-ci-robot k8s-ci-robot requested a review from jsafrane May 3, 2024 18:40
@bells17 bells17 force-pushed the broadcaster-eventrecorder-contextual-logging branch from ac4d7ae to 358f93a Compare May 4, 2024 06:42
@bells17 bells17 force-pushed the broadcaster-eventrecorder-contextual-logging branch from 358f93a to 1b5aac4 Compare May 10, 2024 16:23
@jsafrane
Copy link
Contributor

Signature of NewProvisionController changes and therefore it's a breaking change. Please update the release note accordingly.

@bells17
Copy link
Contributor Author

bells17 commented May 14, 2024

@jsafrane, I'm thinking of using the following text for the release notes. Do you think this is appropriate?

Signature of NewProvisionController has been changed to support contextual logging for eventRecorder. This is a breaking change that requires updates to code that calls this function.

@jsafrane
Copy link
Contributor

Signature of NewProvisionController has been changed to support contextual logging for eventRecorder. This is a breaking change that requires updates to code that calls this function.

That would work nicely.

@bells17
Copy link
Contributor Author

bells17 commented May 23, 2024

@jsafrane Thank you! I've updated the release note.

@jsafrane
Copy link
Contributor

/lgtm
/approvee

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 23, 2024
@jsafrane
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bells17, jsafrane

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 May 23, 2024
@k8s-ci-robot k8s-ci-robot merged commit 8761842 into kubernetes-sigs:master May 23, 2024
3 checks passed
@bells17 bells17 deleted the broadcaster-eventrecorder-contextual-logging branch May 23, 2024 12:50
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. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. wg/structured-logging Categorizes an issue or PR as relevant to WG Structured Logging.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants