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

Implement caching for GenerateContainerIDFromOriginInfo #32351

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

wdhif
Copy link
Member

@wdhif wdhif commented Dec 18, 2024

What does this PR do?

Implement caching for GenerateContainerIDFromOriginInfo using the github.com/DataDog/datadog-agent/pkg/util/cache implementation.

Motivation

This is needed to fully support GenerateContainerIDFromOriginInfo use cases.

Describe how you validated your changes

Validated using the following patch:

diff --git a/comp/core/tagger/impl-remote/remote.go b/comp/core/tagger/impl-remote/remote.go
index 7dd668b18a..da9c5ed25e 100644
--- a/comp/core/tagger/impl-remote/remote.go
+++ b/comp/core/tagger/impl-remote/remote.go
@@ -45,7 +45,7 @@ import (
 const (
        noTimeout         = 0 * time.Minute
        streamRecvTimeout = 10 * time.Minute
-       cacheExpiration   = 1 * time.Minute
+       cacheExpiration   = 10 * time.Second
 )

 var (
diff --git a/pkg/util/cache/cache.go b/pkg/util/cache/cache.go
index e78a1562fd..f2c751d12a 100644
--- a/pkg/util/cache/cache.go
+++ b/pkg/util/cache/cache.go
@@ -7,6 +7,7 @@
 package cache

 import (
+       "github.com/DataDog/datadog-agent/pkg/util/log"
        "strings"
        "time"

@@ -88,8 +89,10 @@ func Get[T any](key string, cb func() (T, error)) (T, error) {
 //     cached with the given expire duration and returned.
 func GetWithExpiration[T any](key string, cb func() (T, error), expire time.Duration) (T, error) {
        if x, found := Cache.Get(key); found {
+               log.Errorf("w: hit for key %s", key)
                return x.(T), nil
        }
+       log.Errorf("w: miss for key %s", key)

        res, err := cb()
        // We don't cache errors

And with the same QA process as #32295
We can see the logs:

2024-12-19 09:59:01 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:02 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:02 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:06 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:07 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:95 in ]) | w: miss for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:10 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:12 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py
2024-12-19 09:59:14 UTC | TRACE | ERROR | (pkg/util/cache/cache.go:92 in ]) | w: hit for key agent/remoteTagger/container_id/7c61e76f-5e3c-4989-b479-b977dd9cfe48/dd-trace-py

And that we still have the traces correctly tagged:
image

Possible Drawbacks / Trade-offs

N/A

Additional Notes

N/A

Copy link

Go Package Import Differences

Baseline: 52f0517
Comparison: 6bfd3b9

binaryosarchchange
trace-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/util/cache
trace-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/util/cache
trace-agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/util/cache
trace-agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/util/cache
trace-agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/util/cache
heroku-trace-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/util/cache

@agent-platform-auto-pr
Copy link
Contributor

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=51468842 --os-family=ubuntu

Note: This applies to commit 6bfd3b9

@agent-platform-auto-pr
Copy link
Contributor

Uncompressed package size comparison

Comparison with ancestor 52f0517517169d661a94895a296c73b85424c86d

Diff per package
package diff status size ancestor threshold
datadog-heroku-agent-amd64-deb 0.21MB ⚠️ 505.27MB 505.06MB 70.00MB
datadog-agent-aarch64-rpm 0.19MB ⚠️ 943.19MB 943.00MB 140.00MB
datadog-agent-arm64-deb 0.19MB ⚠️ 933.97MB 933.78MB 140.00MB
datadog-agent-x86_64-rpm 0.18MB ⚠️ 1197.18MB 1197.00MB 140.00MB
datadog-agent-x86_64-suse 0.18MB ⚠️ 1197.18MB 1197.00MB 140.00MB
datadog-agent-amd64-deb 0.18MB ⚠️ 1187.95MB 1187.76MB 140.00MB
datadog-iot-agent-aarch64-rpm 0.00MB ⚠️ 108.85MB 108.85MB 10.00MB
datadog-iot-agent-x86_64-rpm 0.00MB ⚠️ 113.38MB 113.38MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB ⚠️ 113.38MB 113.38MB 10.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.59MB 78.59MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.67MB 78.67MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.67MB 78.67MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.79MB 55.79MB 10.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.31MB 113.31MB 10.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.78MB 108.78MB 10.00MB

Decision

⚠️ Warning

@wdhif wdhif added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Dec 18, 2024
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: ddfec111-bdb2-47ef-bbb9-6c42d8e2f570

Baseline: 52f0517
Comparison: 6bfd3b9
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +2.86 [+2.13, +3.59] 1 Logs
quality_gate_logs % cpu utilization +0.87 [-2.06, +3.80] 1 Logs
quality_gate_idle memory utilization +0.60 [+0.56, +0.64] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +0.57 [+0.45, +0.69] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.05 [-0.72, +0.81] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.03 [-0.76, +0.82] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.03 [-0.60, +0.66] 1 Logs
file_tree memory utilization +0.02 [-0.12, +0.16] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.86, +0.88] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.11, +0.12] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.77, +0.71] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.04 [-0.93, +0.85] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.05 [-0.90, +0.80] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.07 [-0.13, -0.01] 1 Logs
otel_to_otel_logs ingress throughput -0.12 [-0.84, +0.61] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.25 [-0.71, +0.21] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.

@wdhif wdhif force-pushed the CONTP-15/wassim.dhif/external-data-caching branch from 6bfd3b9 to 0eedc89 Compare December 19, 2024 09:58
@github-actions github-actions bot added short review PR is simple enough to be reviewed quickly and removed medium review PR review might take time labels Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/agent-shared-components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant