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 conversion webhook logging #1552

Conversation

qu1queee
Copy link
Contributor

@qu1queee qu1queee commented Mar 20, 2024

Changes

Ensure Info log is kept to a minimal
Ensure log content is valuable:

  • provide conversion request UID
  • provide conversion response UID and status

Upon conversion of an object, this is how the webhook will log:

{"level":"debug","ts":"2024-03-20T12:31:01Z","logger":"shp-build-webhook","msg":"handling request"}
{"level":"info","ts":"2024-03-20T12:31:01Z","logger":"shp-build-webhook","msg":"conversion request","uid":"0fea4dac-0a67-4c2f-b01c-4798ae7de382"}
{"level":"debug","ts":"2024-03-20T12:31:01Z","logger":"shp-build-webhook","msg":"converting custom resource"}
{"level":"info","ts":"2024-03-20T12:31:01Z","logger":"shp-build-webhook","msg":"converting Build from beta to alpha","namespace":"default","name":"buildkit-build"}
{"level":"info","ts":"2024-03-20T12:31:01Z","logger":"shp-build-webhook","msg":"conversion response","status":"Success","uid":"0fea4dac-0a67-4c2f-b01c-4798ae7de382"}

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Set a kind label on this PR
  • Release notes block has been filled in, or marked NONE

Release Notes

Improve conversion webhook logging

Ensure Info log is kept to a minimal
Ensure log content is valuable:

- provide conversion request UID
- provide conversion response UID and status
@qu1queee qu1queee added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Mar 20, 2024
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 20, 2024
@openshift-ci openshift-ci bot added the release-note Label for when a PR has specified a release note label Mar 20, 2024
@openshift-ci openshift-ci bot requested review from adambkaplan and otaviof March 20, 2024 13:05
Copy link
Member

@SaschaSchwarze0 SaschaSchwarze0 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

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 20, 2024
Copy link
Contributor

openshift-ci bot commented Mar 20, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: SaschaSchwarze0

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

@SaschaSchwarze0 SaschaSchwarze0 added this to the release-v0.13.0 milestone Mar 20, 2024
@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 20, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 8287c07 into shipwright-io:main Mar 20, 2024
13 checks passed
@qu1queee qu1queee deleted the qu1queee/improve_webhook_logging branch March 21, 2024 07:59
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. lgtm Indicates that a PR is ready to be merged. release-note Label for when a PR has specified a release note size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants