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

[Dynamic Instrumentation] Rename DI environment variable #34501

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

Conversation

tylfin
Copy link
Contributor

@tylfin tylfin commented Feb 26, 2025

What does this PR do?

This pull request updates the environment variable DD_DYNAMIC_INSTRUMENTATION_ENABLED to DD_DYNAMIC_INSTRUMENTATION_GO_ENABLED across multiple files to ensure consistency and clarity in the codebase.

Motivation

We have evidence that Go DI is enabled and causing performance issues in at least one environment where it is not supposed to. This might be resolved by #34495, but would occur in any environment where (1) the agent is installed, (2) a Go application is running, (3) DI is enabled for another language like Python. To solve this for now, we'll make this environment variable unique and call it DD_DYNAMIC_INSTRUMENTATION_GO_ENABLED.

Describe how you validated your changes

  • Updated the environment variable in TestDynamicInstrumentation in cmd/system-probe/config/config_linux_test.go.
  • Modified the environment variable in TestGoDI in pkg/dynamicinstrumentation/testutil/e2e_test.go.

Possible Drawbacks / Trade-offs

Additional Notes

@tylfin tylfin requested review from a team as code owners February 26, 2025 21:03
@tylfin tylfin requested a review from dustmop February 26, 2025 21:03
@tylfin tylfin added the qa/done QA done before merge and regressions are covered by tests label Feb 26, 2025
@github-actions github-actions bot added the medium review PR review might take time label Feb 26, 2025
@tylfin tylfin requested a review from grantseltzer February 26, 2025 21:06
@tylfin tylfin changed the title [Dynamic Instrumentation] Rename Go DI environment variable [Dynamic Instrumentation] Rename DI environment variable Feb 26, 2025
@agent-platform-auto-pr
Copy link
Contributor

Uncompressed package size comparison

Comparison with ancestor 5d5b9ce7826bb2e6d08a8e5596df7b9dab5ddc61

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 818.00MB 818.00MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 827.80MB 827.80MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 827.80MB 827.80MB 0.50MB
datadog-agent-arm64-deb 0.00MB 808.97MB 808.97MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 818.75MB 818.75MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.42MB 39.42MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.50MB 39.50MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.50MB 39.50MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.96MB 37.96MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 443.42MB 443.42MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.05MB 62.05MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.12MB 62.12MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.12MB 62.12MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.29MB 59.29MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.36MB 59.36MB 0.50MB

Decision

✅ Passed

@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=57130931 --os-family=ubuntu

Note: This applies to commit 3ca11e3

@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 791.84MiB 801.8MiB 192.66MiB 202.62MiB
static_quality_gate_agent_deb_arm64 783.18MiB 793.14MiB 174.1MiB 184.51MiB
static_quality_gate_agent_rpm_amd64 791.87MiB 801.79MiB 195.02MiB 205.03MiB
static_quality_gate_agent_rpm_arm64 783.28MiB 793.09MiB 176.46MiB 186.44MiB
static_quality_gate_agent_suse_amd64 791.93MiB 801.81MiB 195.02MiB 205.03MiB
static_quality_gate_agent_suse_arm64 783.15MiB 793.14MiB 176.46MiB 186.44MiB
static_quality_gate_dogstatsd_deb_amd64 37.67MiB 47.67MiB 9.78MiB 19.78MiB
static_quality_gate_dogstatsd_deb_arm64 36.28MiB 46.27MiB 8.49MiB 18.49MiB
static_quality_gate_dogstatsd_rpm_amd64 37.67MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_dogstatsd_suse_amd64 37.67MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_iot_agent_deb_amd64 59.25MiB 69.0MiB 14.89MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.62MiB 66.4MiB 12.86MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.25MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.62MiB 66.4MiB 12.86MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.25MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_docker_agent_amd64 876.26MiB 886.12MiB 294.27MiB 304.21MiB
static_quality_gate_docker_agent_arm64 890.91MiB 900.79MiB 280.51MiB 290.47MiB
static_quality_gate_docker_agent_jmx_amd64 1.05GiB 1.06GiB 369.35MiB 379.33MiB
static_quality_gate_docker_agent_jmx_arm64 1.05GiB 1.06GiB 351.59MiB 361.55MiB
static_quality_gate_docker_dogstatsd_amd64 45.82MiB 55.78MiB 17.28MiB 27.28MiB
static_quality_gate_docker_dogstatsd_arm64 44.45MiB 54.45MiB 16.16MiB 26.16MiB
static_quality_gate_docker_cluster_agent_amd64 264.96MiB 274.78MiB 106.35MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.92MiB 290.82MiB 101.18MiB 111.12MiB

@grantseltzer
Copy link
Member

The variable needs to be updated in dd-trace-go as well, it uses the env variable to tell whether or not to enable subscribing to DI probe configs from remote config. This change would mean that we need to bring forward the required dd-trace-go version. Not the biggest deal, but maybe there's another way we can do this?

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: d571b78f-bb11-44d5-9bd4-4aa66eae4205

Baseline: 5d5b9ce
Comparison: 3ca11e3
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +4.83 [+1.86, +7.80] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.39 [-0.51, +1.28] 1 Logs
quality_gate_idle memory utilization +0.14 [+0.09, +0.18] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.06 [-0.73, +0.85] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.05 [-0.80, +0.89] 1 Logs
file_tree memory utilization +0.03 [-0.03, +0.08] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.02 [-0.61, +0.65] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.28, +0.30] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.00 [-0.70, +0.71] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.04, +0.04] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.89, +0.86] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.81, +0.78] 1 Logs
quality_gate_idle_all_features memory utilization -0.16 [-0.21, -0.11] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.26 [-0.73, +0.21] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.36 [-0.43, -0.29] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.38 [-1.15, +0.39] 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 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
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_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 intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog component/system-probe medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/dynamic-instrumentation Dynamic Instrumentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants