marcel/argo-cd
1
0
Fork 0
mirror of https://github.com/argoproj/argo-cd.git synced 2026-02-20 01:28:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: adds various OCI metrics (#25493)

Browse Source 
Signed-off-by: Patroklos Papapetrou <ppapapetrou76@gmail.com>
This commit is contained in:
Papapetrou Patroklos
2025-12-08 13:53:28 +02:00
committed by GitHub
parent cc57831808
commit 0000f05c38
7 changed files with 367 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
util/oci/client.go
View File

@@ -192,8 +192,23 @@ func newClientWithLock(repoURL string, repoLock sync.KeyLock, repo oras.ReadOnly
return c
}
type EventHandlers struct {
OnExtract func(repo string) func()
OnResolveRevision func(repo string) func()
OnDigestMetadata func(repo string) func()
OnTestRepo func(repo string) func()
OnGetTags func(repo string) func()
OnExtractFail func(repo string) func(revision string)
OnResolveRevisionFail func(repo string) func(revision string)
OnDigestMetadataFail func(repo string) func(revision string)
OnTestRepoFail func(repo string) func()
OnGetTagsFail func(repo string) func()
}
// nativeOCIClient implements Client interface using oras-go
type nativeOCIClient struct {
EventHandlers
repoURL string
repo oras.ReadOnlyTarget
tagsFunc func(context.Context, string) ([]string, error)
@@ -208,11 +223,18 @@ type nativeOCIClient struct {
// TestRepo verifies that the remote OCI repo can be connected to.
func (c *nativeOCIClient) TestRepo(ctx context.Context) (bool, error) {
defer c.OnTestRepo(c.repoURL)()
err := c.pingFunc(ctx)
if err != nil {
defer c.OnTestRepoFail(c.repoURL)()
}
return err == nil, err
}
func (c *nativeOCIClient) Extract(ctx context.Context, digest string) (string, utilio.Closer, error) {
defer c.OnExtract(c.repoURL)()
cachedPath, err := c.getCachedPath(digest)
if err != nil {
return "", nil, fmt.Errorf("error getting oci path for digest %s: %w", digest, err)
@@ -229,6 +251,7 @@ func (c *nativeOCIClient) Extract(ctx context.Context, digest string) (string, u
if !exists {
ociManifest, err := getOCIManifest(ctx, digest, c.repo)
if err != nil {
defer c.OnExtractFail(c.repoURL)(digest)
return "", nil, err
}
@@ -295,6 +318,8 @@ func (c *nativeOCIClient) CleanCache(revision string) error {
// DigestMetadata extracts the OCI manifest for a given revision and returns it to the caller.
func (c *nativeOCIClient) DigestMetadata(ctx context.Context, digest string) (*imagev1.Manifest, error) {
defer c.OnDigestMetadata(c.repoURL)()
path, err := c.getCachedPath(digest)
if err != nil {
return nil, fmt.Errorf("error fetching oci metadata path for digest %s: %w", digest, err)
@@ -309,6 +334,8 @@ func (c *nativeOCIClient) DigestMetadata(ctx context.Context, digest string) (*i
}
func (c *nativeOCIClient) ResolveRevision(ctx context.Context, revision string, noCache bool) (string, error) {
defer c.OnResolveRevision(c.repoURL)()
digest, err := c.resolveDigest(ctx, revision) // Lookup explicit revision
if err != nil {
// If the revision is not a semver constraint, just return the error
@@ -334,6 +361,7 @@ func (c *nativeOCIClient) ResolveRevision(ctx context.Context, revision string,
}
func (c *nativeOCIClient) GetTags(ctx context.Context, noCache bool) ([]string, error) {
defer c.OnGetTags(c.repoURL)()
indexLock.Lock(c.repoURL)
defer indexLock.Unlock(c.repoURL)
@@ -349,6 +377,7 @@ func (c *nativeOCIClient) GetTags(ctx context.Context, noCache bool) ([]string,
start := time.Now()
result, err := c.tagsFunc(ctx, "")
if err != nil {
defer c.OnDigestMetadataFail(c.repoURL)
return nil, fmt.Errorf("failed to get tags: %w", err)
}
@@ -378,6 +407,7 @@ func (c *nativeOCIClient) GetTags(ctx context.Context, noCache bool) ([]string,
func (c *nativeOCIClient) resolveDigest(ctx context.Context, revision string) (string, error) {
descriptor, err := c.repo.Resolve(ctx, revision)
if err != nil {
defer c.OnResolveRevisionFail(c.repoURL)(revision)
return "", fmt.Errorf("cannot get digest for revision %s: %w", revision, err)
}
@@ -611,3 +641,10 @@ func getOCIManifest(ctx context.Context, digest string, repo oras.ReadOnlyTarget
return &manifest, nil
}
// WithEventHandlers sets the git client event handlers
func WithEventHandlers(handlers EventHandlers) ClientOpts {
return func(c *nativeOCIClient) {
c.EventHandlers = handlers
}
}

34
util/oci/client_test.go
View File

@@ -270,7 +270,11 @@ func Test_nativeOCIClient_Extract(t *testing.T) {
store := memory.New()
c := newClientWithLock(fields.repoURL, globalLock, store, fields.tagsFunc, func(_ context.Context) error {
return nil
}, fields.allowedMediaTypes, WithImagePaths(cacheDir), WithManifestMaxExtractedSize(args.manifestMaxExtractedSize), WithDisableManifestMaxExtractedSize(args.disableManifestMaxExtractedSize))
}, fields.allowedMediaTypes,
WithImagePaths(cacheDir),
WithManifestMaxExtractedSize(args.manifestMaxExtractedSize),
WithDisableManifestMaxExtractedSize(args.disableManifestMaxExtractedSize),
WithEventHandlers(fakeEventHandlers(t, fields.repoURL)))
_, gotCloser, err := c.Extract(t.Context(), sha)
require.NoError(t, err)
require.NoError(t, gotCloser.Close())
@@ -286,7 +290,11 @@ func Test_nativeOCIClient_Extract(t *testing.T) {
c := newClientWithLock(tt.fields.repoURL, globalLock, store, tt.fields.tagsFunc, func(_ context.Context) error {
return nil
}, tt.fields.allowedMediaTypes, WithImagePaths(cacheDir), WithManifestMaxExtractedSize(tt.args.manifestMaxExtractedSize), WithDisableManifestMaxExtractedSize(tt.args.disableManifestMaxExtractedSize))
}, tt.fields.allowedMediaTypes,
WithImagePaths(cacheDir),
WithManifestMaxExtractedSize(tt.args.manifestMaxExtractedSize),
WithDisableManifestMaxExtractedSize(tt.args.disableManifestMaxExtractedSize),
WithEventHandlers(fakeEventHandlers(t, tt.fields.repoURL)))
path, gotCloser, err := c.Extract(t.Context(), sha)
if tt.expectedError != nil {
@@ -436,7 +444,7 @@ func Test_nativeOCIClient_ResolveRevision(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
c := newClientWithLock(tt.fields.repoURL, globalLock, tt.fields.repo, tt.fields.tagsFunc, func(_ context.Context) error {
return nil
}, tt.fields.allowedMediaTypes)
}, tt.fields.allowedMediaTypes, WithEventHandlers(fakeEventHandlers(t, tt.fields.repoURL)))
got, err := c.ResolveRevision(t.Context(), tt.revision, tt.noCache)
if tt.expectedError != nil {
require.EqualError(t, err, tt.expectedError.Error())
@@ -450,3 +458,23 @@ func Test_nativeOCIClient_ResolveRevision(t *testing.T) {
})
}
}
func fakeEventHandlers(t *testing.T, repoURL string) EventHandlers {
t.Helper()
return EventHandlers{
OnExtract: func(repo string) func() { return func() { require.Equal(t, repoURL, repo) } },
OnResolveRevision: func(repo string) func() { return func() { require.Equal(t, repoURL, repo) } },
OnDigestMetadata: func(repo string) func() { return func() { require.Equal(t, repoURL, repo) } },
OnTestRepo: func(repo string) func() { return func() { require.Equal(t, repoURL, repo) } },
OnGetTags: func(repo string) func() { return func() { require.Equal(t, repoURL, repo) } },
OnExtractFail: func(repo string) func(revision string) {
return func(_ string) { require.Equal(t, repoURL, repo) }
},
OnResolveRevisionFail: func(repo string) func(revision string) {
return func(_ string) { require.Equal(t, repoURL, repo) }
},
OnDigestMetadataFail: func(repo string) func(revision string) {
return func(_ string) { require.Equal(t, repoURL, repo) }
},
}
}