Skip to content

[Dynamic Instrumentation] Improved Go DI e2e tests #36790

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GreenMatan
Copy link
Contributor

What does this PR do?

Go DI e2e tests make a heavy use on timers. There are a couple of drawbacks from using them:

  • Slows things down: We have a 4 seconds wait between every probe (a wait to receive snapshots).
  • Non-deterministic: Since Go DI is inherently asynchronous - with process tracking and remote config (RC) handling occurring via channels and goroutines - tests didn't verify that the sample process was actually tracked or that snapshots were produced for each probe. As a result, some tests could pass even when no snapshot was received/validated.

This PR improves test robustness by:

  • Making the async code paths for process tracking and RC processing synchronous during tests.
  • Adding validation to ensure a snapshot is actually received for each probe.

With these changes, we were able to eliminate the use of arbitrary timers and gain a clearer, more deterministic picture of test behavior.

With these changes in place, the tests now run over twice as fast.

Motivation

Making DI's e2e tests faster and more reliable.

Describe how you validated your changes

Existing e2e tests: I compared the original Go DI E2E test results with the updated ones. The outcome remains the same, with test execution now more than twice as fast. Some test failures still exist, but they are unrelated to this PR and were present beforehand.

@GreenMatan GreenMatan force-pushed the matang/boost-go-di-e2e-tests branch from a2158de to 17ad730 Compare May 8, 2025 13:27
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label May 8, 2025
@GreenMatan GreenMatan marked this pull request as ready for review May 8, 2025 13:28
@GreenMatan GreenMatan requested a review from a team as a code owner May 8, 2025 13:28
@GreenMatan GreenMatan changed the title [Exception Replay] Improved e2e tests - made them more consistent and fast [Dynamic Instrumentation] Speed Up and Stabilize Go DI E2E Tests May 8, 2025
@GreenMatan GreenMatan changed the title [Dynamic Instrumentation] Speed Up and Stabilize Go DI E2E Tests [Dynamic Instrumentation] Improved Go DI e2e tests May 8, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 8, 2025

Uncompressed package size comparison

Comparison with ancestor 5917145d8996506ebed41d9a52de51c49093db93

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 776.02MB 776.02MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 784.96MB 784.96MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 784.96MB 784.96MB 0.50MB
datadog-agent-arm64-deb 0.00MB 765.81MB 765.81MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 774.74MB 774.74MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 31.20MB 31.20MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 31.28MB 31.28MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 31.28MB 31.28MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 30.03MB 30.03MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 377.88MB 377.88MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 60.52MB 60.52MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 60.60MB 60.60MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 60.60MB 60.60MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 57.81MB 57.81MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 57.89MB 57.89MB 0.50MB

Decision

✅ Passed

@GreenMatan GreenMatan force-pushed the matang/boost-go-di-e2e-tests branch from 17ad730 to 975a851 Compare May 8, 2025 13:59
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: cf04b972-788e-42a0-817d-7c3688a095b1

Baseline: 5917145
Comparison: 975a851
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +3.56 [-0.24, +7.35] 1 Logs
file_tree memory utilization +2.94 [+2.75, +3.14] 1 Logs
quality_gate_idle_all_features memory utilization +1.39 [+1.25, +1.53] 1 Logs bounds checks dashboard
otlp_ingest_logs memory utilization +0.47 [+0.34, +0.61] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.29 [+0.23, +0.35] 1 Logs
quality_gate_idle memory utilization +0.28 [+0.22, +0.35] 1 Logs bounds checks dashboard
docker_containers_memory memory utilization +0.22 [+0.14, +0.31] 1 Logs
ddot_logs memory utilization +0.06 [-0.06, +0.18] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.05 [-0.58, +0.69] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.02 [-0.63, +0.67] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.02 [-0.64, +0.67] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.01 [-0.22, +0.24] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.29, +0.29] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.01] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.02 [-0.64, +0.61] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.06 [-0.69, +0.56] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.06 [-0.71, +0.59] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.07 [-0.70, +0.55] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.08 [-0.16, +0.00] 1 Logs
ddot_metrics memory utilization -0.35 [-0.47, -0.23] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.53 [-1.38, +0.31] 1 Logs
otlp_ingest_metrics memory utilization -0.62 [-0.76, -0.47] 1 Logs
quality_gate_logs % cpu utilization -2.01 [-4.76, +0.75] 1 Logs bounds checks dashboard

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
quality_gate_logs memory_usage 9/10 bounds checks dashboard
docker_containers_cpu simple_check_run 10/10
docker_containers_memory memory_usage 10/10
docker_containers_memory simple_check_run 10/10
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 intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10 bounds checks dashboard

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

Failed. Some Quality Gates were violated.

  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 9/10 replicas passed. Failed 1 which is > 0. Gate FAILED.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.

@agent-platform-auto-pr
Copy link
Contributor

Static quality checks

✅ Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 750.3 MiB 778.06 MiB 185.01 MiB 191.06 MiB
static_quality_gate_agent_deb_amd64_fips 748.14 MiB 776.09 MiB 184.64 MiB 190.72 MiB
static_quality_gate_agent_heroku_amd64 367.94 MiB 434.99 MiB 98.07 MiB 114.34 MiB
static_quality_gate_agent_msi 968.2 MiB 978.45 MiB 146.84 MiB 151.65 MiB
static_quality_gate_agent_rpm_amd64 750.29 MiB 778.06 MiB 186.86 MiB 193.42 MiB
static_quality_gate_agent_rpm_amd64_fips 748.13 MiB 776.06 MiB 185.74 MiB 192.61 MiB
static_quality_gate_agent_rpm_arm64 740.54 MiB 768.33 MiB 169.3 MiB 174.71 MiB
static_quality_gate_agent_rpm_arm64_fips 738.59 MiB 766.55 MiB 168.06 MiB 173.92 MiB
static_quality_gate_agent_suse_amd64 750.29 MiB 778.08 MiB 186.86 MiB 193.42 MiB
static_quality_gate_agent_suse_amd64_fips 748.13 MiB 776.11 MiB 185.74 MiB 192.78 MiB
static_quality_gate_agent_suse_arm64 740.54 MiB 768.31 MiB 169.3 MiB 174.71 MiB
static_quality_gate_agent_suse_arm64_fips 738.59 MiB 766.5 MiB 168.06 MiB 173.92 MiB
static_quality_gate_docker_agent_amd64 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_arm64 858.37 MiB 876.0 MiB 272.02 MiB 278.3 MiB
static_quality_gate_docker_agent_jmx_amd64 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_jmx_arm64 858.37 MiB 876.63 MiB 272.02 MiB 278.4 MiB
static_quality_gate_docker_agent_windows1809 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows1809_core 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows1809_core_jmx 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows1809_jmx 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows2022 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows2022_core 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows2022_core_jmx 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_agent_windows2022_jmx 844.97 MiB 862.5 MiB 285.21 MiB 292.0 MiB
static_quality_gate_docker_cluster_agent_amd64 259.65 MiB 263.4 MiB 101.94 MiB 104.07 MiB
static_quality_gate_docker_cluster_agent_arm64 275.65 MiB 279.38 MiB 96.89 MiB 98.95 MiB
static_quality_gate_docker_cws_instrumentation_amd64 6.66 MiB 7.12 MiB 2.82 MiB 3.29 MiB
static_quality_gate_docker_cws_instrumentation_arm64 6.44 MiB 6.92 MiB 2.6 MiB 3.07 MiB
static_quality_gate_docker_dogstatsd_amd64 37.97 MiB 46.39 MiB 14.64 MiB 17.78 MiB
static_quality_gate_docker_dogstatsd_arm64 36.88 MiB 45.05 MiB 13.72 MiB 16.65 MiB
static_quality_gate_dogstatsd_deb_amd64 29.83 MiB 38.4 MiB 7.89 MiB 10.26 MiB
static_quality_gate_dogstatsd_deb_arm64 28.71 MiB 36.98 MiB 6.87 MiB 8.96 MiB
static_quality_gate_dogstatsd_rpm_amd64 29.83 MiB 38.4 MiB 7.9 MiB 10.27 MiB
static_quality_gate_dogstatsd_suse_amd64 29.83 MiB 38.4 MiB 7.9 MiB 10.27 MiB
static_quality_gate_iot_agent_deb_amd64 57.8 MiB 58.51 MiB 14.55 MiB 15.02 MiB
static_quality_gate_iot_agent_deb_arm64 55.22 MiB 55.94 MiB 12.57 MiB 13.05 MiB
static_quality_gate_iot_agent_deb_armhf 53.98 MiB 54.32 MiB 12.57 MiB 13.05 MiB
static_quality_gate_iot_agent_rpm_amd64 57.8 MiB 58.51 MiB 14.57 MiB 15.04 MiB
static_quality_gate_iot_agent_rpm_arm64 55.22 MiB 55.94 MiB 12.59 MiB 13.07 MiB
static_quality_gate_iot_agent_suse_amd64 57.8 MiB 58.51 MiB 14.57 MiB 15.04 MiB

@grantseltzer grantseltzer added changelog/no-changelog team/dynamic-instrumentation Dynamic Instrumentation qa/done QA done before merge and regressions are covered by tests labels May 9, 2025
@grantseltzer
Copy link
Member

grantseltzer commented May 9, 2025

@brycekahle simultaneously handled some of this in #36770, can you fix merge conflict and PR description accordingly? Otherwise looks good

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/dynamic-instrumentation Dynamic Instrumentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants