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

improve watcher logs #626

Merged

Conversation

ramessesii2
Copy link
Member

@ramessesii2 ramessesii2 commented Oct 3, 2023

  • improve watcher logs messages

/kind cleanup

Changes

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you review them:

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Tested your changes locally (if this is a code change)
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user-facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contain the string "action required" if the change requires additional action from users switching to the new release

Release Notes

@tekton-robot tekton-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Oct 3, 2023
@tekton-robot tekton-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 3, 2023
@tekton-robot
Copy link

Hi @ramessesii2. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@ramessesii2
Copy link
Member Author

cc @sayan-biswas

@enarha
Copy link
Contributor

enarha commented Oct 4, 2023

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 4, 2023
@enarha
Copy link
Contributor

enarha commented Oct 4, 2023

@ramessesii2 personally I like we have the name and the namespace as separate fields as having the combo in "knative.dev/key" is less obvious. I agree the kind is probably redundant as it's quite obvious from the "results.tekton.dev/kind" field. That's IMO. Having said that, I do not have strong objection, so if others prefer the shorter records, then OK with me.

Copy link
Member

@avinal avinal left a comment

Choose a reason for hiding this comment

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

+1 to Emil. Although it may seem that the fields are redundant. Having explicit common fields like name, namespace, and kind is preferable and direct. In an ideal case, a user/log parser will look out for well-known fields than a less common field injected by the knative framework.

So, IMO we should leave them as it is. The message improvement is necessary and appreciated, and if you find more instances for improvement, please do that.

@ramessesii2
Copy link
Member Author

ramessesii2 commented Oct 5, 2023

@enarha @avinal given your reviews, I propose having the keys 'namespace' & 'name' uniform throughout the watcher logs. Right now, it's sporadic.
Also, we seem to agree having "results.tekton.dev/kind" is enough for marking a kind in logs, so I'll get rid of kind keys.

Removing changes related to redundant fields in logs.

Signed-off-by: Satyam Bhardwaj <sabhardw@redhat.com>
@ramessesii2 ramessesii2 force-pushed the RAMESSESII2/improve-watcher-logs branch from ce87e69 to 8755349 Compare October 5, 2023 09:54
@enarha
Copy link
Contributor

enarha commented Oct 5, 2023

/approve

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 5, 2023
Copy link
Member

@avinal avinal left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 10, 2023
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: avinal, enarha

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

@tekton-robot tekton-robot merged commit e203c93 into tektoncd:main Oct 10, 2023
6 checks passed
@khrm
Copy link
Contributor

khrm commented Feb 1, 2024

/kind misc

@tekton-robot tekton-robot added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Feb 1, 2024
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. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. 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.

5 participants