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

Add logging guidelines #182

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

liu-cong
Copy link
Contributor

@liu-cong liu-cong commented Jan 9, 2025

This is the first attempt to define logging guidelines in our current code base. This is not meant to be perfect/permanent, but something that can improve our logging quickly.

I am happy to follow up with a PR to update logging once this is approved.

Related issue: #108

cc @danehans @ahg-g

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

The full list of commands accepted by this bot can be found 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 requested a review from ahg-g January 9, 2025 23:30
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 9, 2025
@k8s-ci-robot k8s-ci-robot requested a review from kfswain January 9, 2025 23:30
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 9, 2025
@kfswain
Copy link
Collaborator

kfswain commented Jan 10, 2025

This looks reasonable. Can we give a crisp name to each log level?

That would let us make some enums that we can expect to be used as the log level params. It'll give us semantics within the code that makes readability, and following this style decision a tad easier.

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

3 participants