feat(tagger): implement caching for GenerateContainerIDFromOriginInfo

Signed-off-by: Wassim DHIF <wassim.dhif@datadoghq.com>
DataDog · Dec 19, 2024 · a9a05e8 · a9a05e8
1 parent 1b160f4
commit a9a05e8
Showing 1 changed file with 67 additions and 51 deletions.
diff --git a/comp/core/tagger/impl-remote/remote.go b/comp/core/tagger/impl-remote/remote.go
@@ -36,6 +36,7 @@ import (
 	pb "github.com/DataDog/datadog-agent/pkg/proto/pbgo/core"
 	taggertypes "github.com/DataDog/datadog-agent/pkg/tagger/types"
 	"github.com/DataDog/datadog-agent/pkg/tagset"
+	"github.com/DataDog/datadog-agent/pkg/util/cache"
 	"github.com/DataDog/datadog-agent/pkg/util/common"
 	grpcutil "github.com/DataDog/datadog-agent/pkg/util/grpc"
 	httputils "github.com/DataDog/datadog-agent/pkg/util/http"
@@ -44,11 +45,13 @@ import (
 const (
 	noTimeout         = 0 * time.Minute
 	streamRecvTimeout = 10 * time.Minute
+	cacheExpiration   = 1 * time.Minute
 )
 
-var errTaggerStreamNotStarted = errors.New("tagger stream not started")
-
-var errTaggerFailedGenerateContainerIDFromOriginInfo = errors.New("tagger failed to generate container ID from origin info")
+var (
+	errTaggerStreamNotStarted                        = errors.New("tagger stream not started")
+	errTaggerFailedGenerateContainerIDFromOriginInfo = errors.New("tagger failed to generate container ID from origin info")
+)
 
 // Requires defines the dependencies for the remote tagger.
 type Requires struct {
@@ -269,65 +272,78 @@ func (t *remoteTagger) GenerateContainerIDFromOriginInfo(originInfo origindetect
 		}
 	}()
 
-	expBackoff := backoff.NewExponentialBackOff()
-	expBackoff.InitialInterval = 500 * time.Millisecond
-	expBackoff.MaxInterval = 1 * time.Second
-	expBackoff.MaxElapsedTime = 15 * time.Second
-
-	var containerID string
+	// Generate cache key
+	initPrefix := ""
+	if originInfo.ExternalData.Init {
+		initPrefix = "i/"
+	}
+	key := cache.BuildAgentKey(
+		"remoteTagger",
+		"container_id",
+		initPrefix+originInfo.ExternalData.PodUID+"/"+originInfo.ExternalData.ContainerName,
+	)
 
-	err := backoff.Retry(func() error {
-		select {
-		case <-t.ctx.Done():
-			return &backoff.PermanentError{Err: errTaggerFailedGenerateContainerIDFromOriginInfo}
-		default:
-		}
+	cachedContainerID, err := cache.GetWithExpiration(key, func() (containerID string, err error) {
+		expBackoff := backoff.NewExponentialBackOff()
+		expBackoff.InitialInterval = 500 * time.Millisecond
+		expBackoff.MaxInterval = 1 * time.Second
+		expBackoff.MaxElapsedTime = 15 * time.Second
+
+		err = backoff.Retry(func() error {
+			select {
+			case <-t.ctx.Done():
+				return &backoff.PermanentError{Err: errTaggerFailedGenerateContainerIDFromOriginInfo}
+			default:
+			}
 
-		// Fetch the auth token
-		if t.token == "" {
-			var authError error
-			t.token, authError = t.options.TokenFetcher()
-			if authError != nil {
-				_ = t.log.Errorf("unable to fetch auth token, will possibly retry: %s", authError)
-				return authError
+			// Fetch the auth token
+			if t.token == "" {
+				var authError error
+				t.token, authError = t.options.TokenFetcher()
+				if authError != nil {
+					_ = t.log.Errorf("unable to fetch auth token, will possibly retry: %s", authError)
+					return authError
+				}
 			}
-		}
 
-		// Create the context with the auth token
-		t.queryCtx, t.queryCancel = context.WithCancel(
-			metadata.NewOutgoingContext(t.ctx, metadata.MD{
-				"authorization": []string{fmt.Sprintf("Bearer %s", t.token)},
-			}),
-		)
+			// Create the context with the auth token
+			t.queryCtx, t.queryCancel = context.WithCancel(
+				metadata.NewOutgoingContext(t.ctx, metadata.MD{
+					"authorization": []string{fmt.Sprintf("Bearer %s", t.token)},
+				}),
+			)
+
+			// Call the gRPC method to get the container ID from the origin info
+			containerIDResponse, err := t.client.TaggerGenerateContainerIDFromOriginInfo(t.queryCtx, &pb.GenerateContainerIDFromOriginInfoRequest{
+				ExternalData: &pb.GenerateContainerIDFromOriginInfoRequest_ExternalData{
+					Init:          &originInfo.ExternalData.Init,
+					ContainerName: &originInfo.ExternalData.ContainerName,
+					PodUID:        &originInfo.ExternalData.PodUID,
+				},
+			})
+			if err != nil {
+				_ = t.log.Errorf("unable to generate container ID from origin info, will retry: %s", err)
+				return err
+			}
 
-		// Call the gRPC method to get the container ID from the origin info
-		containerIDResponse, err := t.client.TaggerGenerateContainerIDFromOriginInfo(t.queryCtx, &pb.GenerateContainerIDFromOriginInfoRequest{
-			ExternalData: &pb.GenerateContainerIDFromOriginInfoRequest_ExternalData{
-				Init:          &originInfo.ExternalData.Init,
-				ContainerName: &originInfo.ExternalData.ContainerName,
-				PodUID:        &originInfo.ExternalData.PodUID,
-			},
-		})
-		if err != nil {
-			_ = t.log.Errorf("unable to generate container ID from origin info, will retry: %s", err)
-			return err
-		}
+			if containerIDResponse == nil {
+				_ = t.log.Warnf("unable to generate container ID from origin info, will retry: %s", err)
+				return errors.New("containerIDResponse is nil")
+			}
+			containerID = containerIDResponse.ContainerID
 
-		if containerIDResponse == nil {
-			_ = t.log.Warnf("unable to generate container ID from origin info, will retry: %s", err)
-			return errors.New("containerIDResponse is nil")
-		}
-		containerID = containerIDResponse.ContainerID
+			t.log.Debugf("Container ID generated successfully from origin info %+v: %s", originInfo, containerID)
+			return nil
+		}, expBackoff)
 
-		fail = false
-		t.log.Debugf("Container ID generated successfully from origin info %+v: %s", originInfo, containerID)
-		return nil
-	}, expBackoff)
+		return containerID, err
+	}, cacheExpiration)
 
 	if err != nil {
 		return "", err
 	}
-	return containerID, nil
+	fail = false
+	return cachedContainerID, nil
 }
 
 // AccumulateTagsFor returns tags for a given entity at the desired cardinality.