macos: fix system-probe.yaml being overwritten on upgrade#51176
Conversation
|
The Bazel //cmd/agent/dist:config_files rule ships a bare system-probe.yaml (generated from system-probe_template.yaml) in the pkg payload, so the installer overwrites it on extraction. datadog.yaml survives upgrade because preinst saves it and postinst restores it after the payload lands; system-probe.yaml had no such save/restore, so any user customization (NPM, USM, CWS settings, etc.) was lost on every agent upgrade. Mirror the existing datadog.yaml save/restore for system-probe.yaml, using cp -vf … 2>/dev/null || true so a missing file (the common case) doesn't fail the install.
cf224bd to
25d8d30
Compare
Files inventory check summaryFile checks results against ancestor 4395789a: Results for datadog-agent_7.81.0~devel.git.122.5680c08.pipeline.114594188-1_amd64.deb:No change detected |
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
29 successful checks with minimal change (< 2 KiB)
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 824cf28 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | -1.45 | [-4.38, +1.47] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | ddot_metrics | memory utilization | +0.29 | [+0.09, +0.49] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | +0.26 | [+0.10, +0.42] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | +0.20 | [+0.11, +0.29] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | +0.06 | [-0.01, +0.13] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | +0.05 | [-0.05, +0.15] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.03 | [-0.01, +0.08] | 1 | Logs bounds checks dashboard |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.03 | [-0.17, +0.23] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.02 | [-0.18, +0.23] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.01 | [-0.38, +0.41] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.10, +0.10] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.01 | [-0.45, +0.43] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.02 | [-0.16, +0.11] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.02 | [-0.51, +0.47] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | -0.16 | [-0.35, +0.03] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | -0.24 | [-0.29, -0.18] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.32 | [-0.56, -0.09] | 1 | Logs |
| ➖ | file_tree | memory utilization | -0.39 | [-0.43, -0.34] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.44 | [-0.50, -0.38] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_metrics_logs | memory utilization | -0.44 | [-0.68, -0.20] | 1 | Logs bounds checks dashboard |
| ➖ | otlp_ingest_metrics | memory utilization | -0.60 | [-0.75, -0.44] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | -1.45 | [-4.38, +1.47] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -2.02 | [-3.01, -1.03] | 1 | Logs bounds checks dashboard |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -2.04 | [-2.21, -1.86] | 1 | Logs |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | docker_containers_cpu | simple_check_run | 10/10 | 725 ≥ 26 | |
| ✅ | docker_containers_memory | memory_usage | 10/10 | 246.50MiB ≤ 370MiB | |
| ✅ | docker_containers_memory | simple_check_run | 10/10 | 717 ≥ 26 | |
| ✅ | file_to_blackhole_0ms_latency | memory_usage | 10/10 | 0.16GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_0ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_1000ms_latency | memory_usage | 10/10 | 0.20GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_1000ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_100ms_latency | memory_usage | 10/10 | 0.17GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_100ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_500ms_latency | memory_usage | 10/10 | 0.18GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_500ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | quality_gate_idle | intake_connections | 10/10 | 3 ≤ 4 | bounds checks dashboard |
| ✅ | quality_gate_idle | memory_usage | 10/10 | 142.57MiB ≤ 147MiB | bounds checks dashboard |
| ✅ | quality_gate_idle | total_bytes_received | 10/10 | 738.24KiB ≤ 819.20KiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 2 ≤ 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 424.45MiB ≤ 495MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | total_bytes_received | 10/10 | 1.12MiB ≤ 1.25MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 4 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 175.38MiB ≤ 195MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_logs | total_bytes_received | 10/10 | 264.35MiB ≤ 292MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 352.69 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 3 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 378.10MiB ≤ 430MiB | 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 |
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:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
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.
-
Its configuration does not mark it "erratic".
CI Pass/Fail Decision
✅ Passed. All Quality Gates passed.
- quality_gate_logs, 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_metrics_logs, bounds check memory_usage: 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 intake_connections: 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 cpu_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 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_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_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
What does this PR do?
Saves and restores
system-probe.yamlacross DMG upgrades, mirroring the existingdatadog.yamlsave/restore in the pre/postinst scripts.Motivation
The Bazel
//cmd/agent/dist:config_filesrule ships a baresystem-probe.yaml(generated fromsystem-probe_template.yaml) in the pkg payload — verified by runningbazel run //packages/agent/product:post_build_install, which writes bothetc/system-probe.yamlandetc/datadog.yamlto the destdir. The pkg installer overwrites those exact paths during extraction.datadog.yamlsurvives upgrade because preinst saves it and postinst restores it after extraction;system-probe.yamlhad no such save/restore, so any user customization (NPM, USM, CWS settings, etc.) was lost on every agent upgrade.Describe how you validated your changes
Ran
bazel run //packages/agent/product:post_build_install -- --destdir=/tmp/checkand confirmedetc/system-probe.yamlis present as a bare file in the payload. Verified the newcplines follow the existing pattern (cp -vf … 2>/dev/null || true), so a missing source file (the common case where the user never touchedsystem-probe.yaml) doesn't fail the install. Full macOS install/upgrade E2E coverage runs on merge tomain, not on PR branches.Additional Notes
security-agent.yamlis shipped only as*.yaml.example(via the omnibusmovefrompkg/config/example/security-agent.yaml.example) and therefore survives upgrade without explicit save/restore — out of scope here. Same forai_usage_native_host.yaml, which postinst seeds from.examplewhen missing.