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

feat: add timestamp and traceId to verification response #1697

Merged
merged 4 commits into from
Aug 15, 2024

Conversation

binbin-li
Copy link
Collaborator

Description

What this PR does / why we need it:

Per discussion with @yizha1, we should add more info in the verification response and the error msg from contraint template to help users pinpoint related Ratify logs.

This PR adds timestamp and traceID in verification response to help users identity the failing request easily. And the default constraint template is updated to report the timestamp and traceID when validation fails.

Example:
When we get an error message from admission webhook in terminal:

Error from server (Forbidden): admission webhook "validation.gatekeeper.sh" denied the request: [ratify-constraint] Time=2024-08-08T13:55:51.647024898Z, failed to verify the artifact: libinbinacr.azurecr.io/testcosign@sha256:f2502800f0663995420b13214a0d20eae1ec9a3c072f99c462cef0132a684556, trace-id: 57e4f5ac-7152-4a0b-b056-cf8a117398f5

We could search for traceID in Ratify logs:
image
And if we have ELK set up, traceID can be used to filter logs directly.

The verification response will also include traceID and timestamp fields:
image

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #1669

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Copy link

codecov bot commented Aug 8, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 2 lines in your changes missing coverage. Please review.

Files Patch % Lines
internal/logger/logger.go 60.00% 1 Missing and 1 partial ⚠️
Files Coverage Δ
httpserver/handlers.go 75.66% <100.00%> (+0.12%) ⬆️
httpserver/types.go 100.00% <100.00%> (ø)
internal/logger/logger.go 96.49% <60.00%> (-3.51%) ⬇️

Copy link
Collaborator

@akashsinghal akashsinghal left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for adding this

@susanshi susanshi enabled auto-merge (squash) August 15, 2024 00:28
@susanshi susanshi merged commit 3e04cb5 into ratify-project:dev Aug 15, 2024
18 checks passed
duffney pushed a commit to duffney/ratify that referenced this pull request Aug 16, 2024
akashsinghal pushed a commit to akashsinghal/ratify that referenced this pull request Sep 13, 2024
binbin-li added a commit to binbin-li/ratify that referenced this pull request Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Report more debug info in external data response
3 participants