Skip to content

Comments

fix: improve debug log format#1248

Merged
JeyJeyGao merged 10 commits intonotaryproject:mainfrom
JeyJeyGao:fix/debug_log
May 15, 2025
Merged

fix: improve debug log format#1248
JeyJeyGao merged 10 commits intonotaryproject:mainfrom
JeyJeyGao:fix/debug_log

Conversation

@JeyJeyGao
Copy link
Contributor

@JeyJeyGao JeyJeyGao commented Apr 3, 2025

Pending on #1260

Fix:

  • updated timestamp to UTC with nanosecond
  • added new line after request and response log

Previous example:

DEBU[2025-04-14T07:42:25Z] Request #0
> Request: "HEAD" "https://notationreg.azurecr.io/v2/hello/manifests/v1"
> Request headers:
   "Accept": "application/vnd.docker.distribution.manifest.v2+json, application/vnd.docker.distribution.manifest.list.v2+json, application/vnd.oci.image.manifest.v1+json, application/vnd.oci.image.index.v1+json, application/vnd.oci.artifact.manifest.v1+json"
   "User-Agent": "notation/v2.0.0-alpha.1+unreleased"
DEBU[2025-04-14T07:42:26Z] Response #0
< Response status: "401 Unauthorized"
< Response headers:
   "Content-Length": "199"
   "X-Content-Type-Options": "nosniff"
   "Date": "Mon, 14 Apr 2025 07:42:26 GMT"
   "Server": "AzureContainerRegistry"
   "Connection": "keep-alive"
   "Strict-Transport-Security": "max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains"
   "Content-Type": "application/json; charset=utf-8"
   "Access-Control-Expose-Headers": "Docker-Content-Digest, WWW-Authenticate, Link, X-Ms-Correlation-Request-Id"
   "Docker-Distribution-Api-Version": "registry/2.0"
   "Www-Authenticate": "Bearer realm=\"https://notationreg.azurecr.io/oauth2/token\",service=\"notationreg.azurecr.io\",scope=\"repository:hello:pull\""
   "X-Ms-Correlation-Request-Id": "df5ee6ff-0afb-47d6-ab98-6835c2e41f8a"
DEBU[2025-04-14T07:42:26Z] Request #1
> Request: "POST" "https://notationreg.azurecr.io/oauth2/token"
> Request headers:
   "Content-Type": "application/x-www-form-urlencoded"
   "User-Agent": "notation/v2.0.0-alpha.1+unreleased"

Current example:

notation sign notationreg.azurecr.io/hello:v1 -d
DEBU[2025-05-12 07:41:42.720229189Z] Request #0
> Request: "HEAD" "https://notationreg.azurecr.io/v2/hello/manifests/v1"
> Request headers:
   "Accept": "application/vnd.docker.distribution.manifest.v2+json, application/vnd.docker.distribution.manifest.list.v2+json, application/vnd.oci.image.manifest.v1+json, application/vnd.oci.image.index.v1+json, application/vnd.oci.artifact.manifest.v1+json"
   "User-Agent": "notation/v2.0.0-alpha.1+unreleased"


DEBU[2025-05-12 07:41:43.248214367Z] Response #0
< Response status: "401 Unauthorized"
< Response headers:
   "Date": "Mon, 12 May 2025 07:41:43 GMT"
   "Server": "AzureContainerRegistry"
   "Access-Control-Expose-Headers": "Docker-Content-Digest, WWW-Authenticate, Link, X-Ms-Correlation-Request-Id"
   "Docker-Distribution-Api-Version": "registry/2.0"
   "Strict-Transport-Security": "max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains"
   "X-Content-Type-Options": "nosniff"
   "X-Ms-Correlation-Request-Id": "0c11d32c-4ffe-480c-acb3-8d145a83a87e"
   "Content-Type": "application/json; charset=utf-8"
   "Content-Length": "199"
   "Connection": "keep-alive"
   "Www-Authenticate": "Bearer realm=\"https://notationreg.azurecr.io/oauth2/token\",service=\"notationreg.azurecr.io\",scope=\"repository:hello:pull\""


DEBU[2025-05-12 07:41:43.248394566Z] Request #1
> Request: "POST" "https://notationreg.azurecr.io/oauth2/token"
> Request headers:
   "Content-Type": "application/x-www-form-urlencoded"
   "User-Agent": "notation/v2.0.0-alpha.1+unreleased"


DEBU[2025-05-12 07:41:43.414852708Z] Response #1
< Response status: "200 OK"
< Response headers:
   "Connection": "keep-alive"
   "X-Ms-Correlation-Request-Id": "d4baeae0-e47e-4b6f-8767-a7002229a1d6"
   "X-Ms-Ratelimit-Remaining-Calls-Per-Second": "333.316667"
   "Strict-Transport-Security": "max-age=31536000; includeSubDomains"
   "Server": "AzureContainerRegistry"
   "Date": "Mon, 12 May 2025 07:41:43 GMT"
   "Content-Type": "application/json; charset=utf-8"

Color:
image
image
image
image

Resolve part of #1247

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@codecov
Copy link

codecov bot commented Apr 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.01%. Comparing base (c68425f) to head (eb8f9e7).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1248      +/-   ##
==========================================
+ Coverage   76.96%   77.01%   +0.04%     
==========================================
  Files          68       68              
  Lines        3847     3855       +8     
==========================================
+ Hits         2961     2969       +8     
  Misses        682      682              
  Partials      204      204              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao marked this pull request as ready for review May 12, 2025 07:48
@JeyJeyGao JeyJeyGao requested a review from a user May 12, 2025 07:48
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@FeynmanZhou FeynmanZhou 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 @JeyJeyGao

Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@JeyJeyGao JeyJeyGao merged commit 48b9eee into notaryproject:main May 15, 2025
7 checks passed
@JeyJeyGao JeyJeyGao deleted the fix/debug_log branch May 15, 2025 06:07
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.

3 participants