Skip to content

Warn about env vars the config stream did not reproduce - #55902

Draft
rahulkaukuntla wants to merge 1 commit into
configstream/consumer-override-remapfrom
configstream/deprecate-remote-env
Draft

Warn about env vars the config stream did not reproduce#55902
rahulkaukuntla wants to merge 1 commit into
configstream/consumer-override-remapfrom
configstream/deprecate-remote-env

Conversation

@rahulkaukuntla

Copy link
Copy Markdown
Contributor

What does this PR do?

Warns, once per remote agent at startup, about DD_* env vars that were set on that process and whose value the core Agent's snapshot did not reproduce. Names only, never values.

Motivation

DisableLocalEnvLayer wipes a remote agent's entire env layer, so a var set only on its container silently stops taking effect — the failure mode behind incident 60263. The warning is narrowed to settings whose effective source was SourceEnvVar and whose post-snapshot value actually differs: an unconditional list would name DD_API_KEY, DD_SITE and friends on every containerized start, all of which the core Agent streams back identically, and operators would learn to ignore it.

Describe how you validated your changes

Unit tests in pkg/configstreambootstrap, integration tests in the consumer, linter.go clean. Live: a trace-agent started with DD_APM_RECEIVER_PORT=8999 warned about exactly apm_config.receiver_port (DD_APM_RECEIVER_PORT), stayed silent about DD_API_KEY/DD_SITE, and went on to listen on the streamed 8126. Remote agents with no differing var warned about nothing.

Additional Notes

The report runs after the snapshot and after the per-agent remap in the previous branch — before it, a remapped log_level reads as a loss and false-positives.

DisableLocalEnvLayer previously warned about every DD_* var bound to a config
setting and set in this process. In a containerized deployment that names a
dozen variables the core Agent streams back unchanged, training operators to
ignore it.

Instead, capture the settings whose effective source is SourceEnvVar just
before the wipe, then after the first snapshot warn only about those whose
value the stream did not reproduce. A setting whose env var was already losing
to a higher-precedence source is never captured, and a setting the core Agent
does not stream reads back as its default, so it is reported.

The report runs after applyOverrides so a per-agent log_level remap is not
reported as a loss, and consumes the captured state so it fires once. It names
settings and env vars, never values.

Adds ntmConfig.ConfigEnvVars() so the capture can name the winning variable.
@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 92.59%
Overall Coverage: 55.31% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: f3f03dd | Docs | View more details | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor cbbd916
📊 Static Quality Gates Dashboard
🔗 SQG Job
SOME SIZE DELTAS ARE N/A (ANCESTOR METRICS NOT YET AVAILABLE). RETRY JOB

Successful checks

Info

Quality gate Change Size (prev → curr → max)
agent_deb_amd64 N/A N/A → 768.590 → 771.220
agent_deb_amd64_fips N/A N/A → 715.170 → 718.020
agent_heroku_amd64 N/A N/A → 316.156 → 322.460
agent_msi N/A N/A → 647.868 → 662.360
agent_rpm_amd64 N/A N/A → 768.574 → 771.190
agent_rpm_amd64_fips N/A N/A → 715.154 → 718.020
agent_rpm_arm64 N/A N/A → 740.491 → 744.370
agent_rpm_arm64_fips N/A N/A → 691.620 → 695.880
agent_suse_amd64 N/A N/A → 768.574 → 771.190
agent_suse_amd64_fips N/A N/A → 715.154 → 718.020
agent_suse_arm64 N/A N/A → 740.491 → 744.370
agent_suse_arm64_fips N/A N/A → 691.620 → 695.880
docker_agent_amd64 N/A N/A → 827.553 → 828.420
docker_agent_arm64 N/A N/A → 824.526 → 828.440
docker_agent_jmx_amd64 N/A N/A → 1018.466 → 1019.630
docker_agent_jmx_arm64 N/A N/A → 1004.218 → 1008.130
docker_cluster_agent_amd64 N/A N/A → 212.687 → 213.660
docker_cluster_agent_arm64 N/A N/A → 225.718 → 226.660
docker_cws_instrumentation_amd64 N/A N/A → 7.439 → 8.400
docker_cws_instrumentation_arm64 N/A N/A → 6.877 → 7.110
docker_dogstatsd_amd64 N/A N/A → 39.557 → 40.440
docker_dogstatsd_arm64 N/A N/A → 37.623 → 38.580
docker_host_profiler_amd64 N/A N/A → 307.574 → 319.480
docker_host_profiler_arm64 N/A N/A → 318.792 → 330.690
dogstatsd_deb_amd64 N/A N/A → 30.303 → 31.220
dogstatsd_deb_arm64 N/A N/A → 28.315 → 29.590
dogstatsd_rpm_amd64 N/A N/A → 30.303 → 31.220
dogstatsd_suse_amd64 N/A N/A → 30.303 → 31.220
iot_agent_deb_amd64 N/A N/A → 46.651 → 47.550
iot_agent_deb_arm64 N/A N/A → 43.280 → 44.220
iot_agent_deb_armhf N/A N/A → 44.094 → 45.020
iot_agent_rpm_amd64 N/A N/A → 46.652 → 47.550
iot_agent_suse_amd64 N/A N/A → 46.651 → 47.550

@cit-pr-commenter-54b7da

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Job ID: 0796598e-d9fb-4c98-b52c-fe8fef52a3b1

Baseline: cbbd916
Comparison: f3f03dd
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
dsd_uds_10mb_3k_timestamped_contexts_cpu % cpu utilization +1.00 [+0.76, +1.24] 1 Logs
dsd_uds_10mb_3k_timestamped_contexts_memory memory utilization +0.76 [+0.53, +0.98] 1 Logs
quality_gate_metrics_logs memory utilization +0.61 [+0.38, +0.85] 1 Logs bounds checks dashboard
quality_gate_security_idle memory utilization +0.52 [+0.48, +0.55] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization +0.27 [+0.20, +0.34] 1 Logs bounds checks dashboard
quality_gate_private_action_runner memory utilization +0.06 [-0.06, +0.19] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization -0.10 [-0.13, -0.06] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.25 [-0.30, -0.21] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization -0.35 [-0.41, -0.30] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -0.91 [-1.76, -0.06] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
quality_gate_idle intake_connections 10/10 4 ≤ 5 bounds checks dashboard
quality_gate_idle memory_usage 10/10 175.72MiB ≤ 179MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 747.19KiB ≤ 819.20KiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 4 ≤ 5 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 523.01MiB ≤ 537MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 1.14MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 20 ≤ 40 bounds checks dashboard
quality_gate_logs memory_usage 10/10 212.20MiB ≤ 228MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_logs total_bytes_received 10/10 263.40MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 423.79 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 18 ≤ 40 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 431.54MiB ≤ 455MiB bounds checks dashboard
quality_gate_metrics_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_metrics_logs total_bytes_received 10/10 0.94GiB ≤ 1.04GiB bounds checks dashboard
quality_gate_private_action_runner memory_usage 10/10 72.16MiB ≤ 75MiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 35.99 ≤ 100 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 328.34MiB ≤ 355MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 66.42 ≤ 200 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 308.90MiB ≤ 335MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 23.75 ≤ 100 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 316.89MiB ≤ 345MiB 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

Passed. All Quality Gates passed.

  • quality_gate_private_action_runner, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, 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_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check cpu_usage: 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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant