Skip to content

feat: add per-request trace IDs and system-error metrics #2849

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.

Sign up for GitHub

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

Open
charleswool wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −5
Open

feat: add per-request trace IDs and system-error metrics #2849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions internal/httpserver/handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ import (
"strings"
"time"

"github.com/notaryproject/ratify/v2/internal/logger"
"github.com/notaryproject/ratify/v2/pkg/metrics"
"github.com/open-policy-agent/frameworks/constraint/pkg/externaldata"
"github.com/sirupsen/logrus"
"oras.land/oras-go/v2/registry"
)

var logOpt = logger.Option{ComponentType: logger.Server}

// verify handles the verification request from Gatekeeper.
func (s *server) verify(ctx context.Context, w http.ResponseWriter, r *http.Request) error {
start := time.Now()
Expand Down Expand Up @@ -73,12 +75,13 @@ func (s *server) verify(ctx context.Context, w http.ResponseWriter, r *http.Requ
}
renderedResult := convertResult(result)
if err = s.verifyCache.Set(ctx, key, renderedResult, 0); err != nil {
logrus.Warnf("failed to set verify cache for image %s: %v", artifact, err)
logger.GetLogger(ctx, logOpt).Warnf("failed to set verify cache for image %s: %v", artifact, err)
}
return renderedResult, nil
})
if err != nil {
results[idx].Error = err.Error()
metrics.ReportSystemError(ctx, "verify_artifact")
}
results[idx].Value = val
}
Expand Down Expand Up @@ -119,6 +122,7 @@ func (s *server) resolveReference(ctx context.Context, key string) externaldata.
ref, err := registry.ParseReference(reference)
if err != nil {
item.Error = fmt.Sprintf("failed to parse reference: %v", err)
metrics.ReportSystemError(ctx, "mutate_parse_reference")
return item
}
if _, err = ref.Digest(); err == nil {
Expand Down Expand Up @@ -150,12 +154,13 @@ func (s *server) resolveReference(ctx context.Context, key string) externaldata.
resolvedRef := ref.String()

if err = s.mutateCache.Set(ctx, cacheKey, resolvedRef, 0); err != nil {
logrus.Warnf("failed to set mutate cache for image %s: %v", reference, err)
logger.GetLogger(ctx, logOpt).Warnf("failed to set mutate cache for image %s: %v", reference, err)
}
return resolvedRef, nil
})
if err != nil {
item.Error = err.Error()
metrics.ReportSystemError(ctx, "mutate_resolve_reference")
} else {
item.Value = val
}
Expand Down
5 changes: 3 additions & 2 deletions internal/httpserver/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"github.com/notaryproject/ratify/v2/internal/executor"
"github.com/notaryproject/ratify/v2/internal/httpserver/config"
"github.com/notaryproject/ratify/v2/internal/httpserver/tlssecret"
"github.com/notaryproject/ratify/v2/internal/logger"
"github.com/sirupsen/logrus"
"golang.org/x/sync/singleflight"
)
Expand Down Expand Up @@ -200,13 +201,13 @@ func (s *server) registerVerifyHandler() error {

func (s *server) verifyHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
_ = s.verify(r.Context(), w, r)
_ = s.verify(logger.InitContext(r.Context(), r), w, r)

@charleswool charleswool Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Correct - InitLogConfig is not called in this binary, so trace IDs are generated per request, not read from incoming headers. I have fixed the PR description to say generated; header-based propagation can be wired later by calling InitLogConfig with the header names.

}
}

func (s *server) mutateHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
_ = s.mutate(r.Context(), w, r)
_ = s.mutate(logger.InitContext(r.Context(), r), w, r)
}
}

Expand Down
Loading