Skip to content

macos: fix system-probe.yaml being overwritten on upgrade#51176

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into
mainfrom
brian.tu/macos-preserve-extra-yaml-on-upgrade
May 21, 2026
Merged

macos: fix system-probe.yaml being overwritten on upgrade#51176
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into
mainfrom
brian.tu/macos-preserve-extra-yaml-on-upgrade

Conversation

@briantu
Copy link
Copy Markdown
Contributor

@briantu briantu commented May 21, 2026

What does this PR do?

Saves and restores system-probe.yaml across DMG upgrades, mirroring the existing datadog.yaml save/restore in the pre/postinst scripts.

Motivation

The Bazel //cmd/agent/dist:config_files rule ships a bare system-probe.yaml (generated from system-probe_template.yaml) in the pkg payload — verified by running bazel run //packages/agent/product:post_build_install, which writes both etc/system-probe.yaml and etc/datadog.yaml to the destdir. The pkg installer overwrites those exact paths during extraction. datadog.yaml survives upgrade because preinst saves it and postinst restores it after extraction; system-probe.yaml had 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/check and confirmed etc/system-probe.yaml is present as a bare file in the payload. Verified the new cp lines follow the existing pattern (cp -vf … 2>/dev/null || true), so a missing source file (the common case where the user never touched system-probe.yaml) doesn't fail the install. Full macOS install/upgrade E2E coverage runs on merge to main, not on PR branches.

Additional Notes

security-agent.yaml is shipped only as *.yaml.example (via the omnibus move from pkg/config/example/security-agent.yaml.example) and therefore survives upgrade without explicit save/restore — out of scope here. Same for ai_usage_native_host.yaml, which postinst seeds from .example when missing.

@briantu briantu requested review from a team as code owners May 21, 2026 16:47
@github-actions github-actions Bot added the short review PR is simple enough to be reviewed quickly label May 21, 2026
@datadog-datadog-prod-us1-2
Copy link
Copy Markdown
Contributor

datadog-datadog-prod-us1-2 Bot commented May 21, 2026

Pipelines

Fix all issues with BitsAI

⚠️ Warnings

🚦 2 Pipeline jobs failed

DataDog/datadog-agent | oracle: [21.3.0-xe]   View in Datadog   GitLab

🛟 This job is unlikely to succeed on retry. Please review your pipeline configuration. 5 failed tests. Error: failed to ping oracle instance: ORA-12514: TNS:listener does not currently know of service requested in connect descriptor at /go/src/github.com/DataDog/datadog-agent/pkg/collector/corechecks/oracle/oracle_dictionary_test.go:19

DataDog/datadog-agent | unit_tests_notify   View in Datadog   GitLab

🛟 This job is unlikely to succeed on retry. Please review your pipeline configuration. Command 'ls junit-tests_*.tgz' failed with exit code 2: No such file or directory.

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 5680c08 | Docs | Datadog PR Page | Give us feedback!

@briantu briantu changed the title macos: preserve system-probe.yaml and security-agent.yaml on upgrade macos: fix system-probe.yaml being clobbered on upgrade; also preserve security-agent.yaml May 21, 2026
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.
@briantu briantu force-pushed the brian.tu/macos-preserve-extra-yaml-on-upgrade branch from cf224bd to 25d8d30 Compare May 21, 2026 17:09
@briantu briantu changed the title macos: fix system-probe.yaml being clobbered on upgrade; also preserve security-agent.yaml macos: fix system-probe.yaml being clobbered on upgrade May 21, 2026
@briantu briantu added changelog/no-changelog No changelog entry needed qa/done QA done before merge and regressions are covered by tests labels May 21, 2026
@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented May 21, 2026

Files inventory check summary

File checks results against ancestor 4395789a:

Results for datadog-agent_7.81.0~devel.git.122.5680c08.pipeline.114594188-1_amd64.deb:

No change detected

@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented May 21, 2026

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 4395789
📊 Static Quality Gates Dashboard
🔗 SQG Job

Successful checks

Info

Quality gate Change Size (prev → curr → max)
docker_agent_amd64 +2.08 KiB (0.00% increase) 805.324 → 805.326 → 806.340
docker_agent_jmx_amd64 +2.08 KiB (0.00% increase) 996.244 → 996.246 → 997.060
docker_host_profiler_amd64 +4.56 KiB (0.00% increase) 302.183 → 302.188 → 315.880
docker_host_profiler_arm64 +4.55 KiB (0.00% increase) 313.670 → 313.674 → 327.470
29 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64 745.185 MiB
agent_deb_amd64_fips 702.951 MiB
agent_heroku_amd64 310.238 MiB
agent_msi 609.143 MiB
agent_rpm_amd64 745.168 MiB
agent_rpm_amd64_fips 702.935 MiB
agent_rpm_arm64 722.731 MiB
agent_rpm_arm64_fips 683.667 MiB
agent_suse_amd64 745.168 MiB
agent_suse_amd64_fips 702.935 MiB
agent_suse_arm64 722.731 MiB
agent_suse_arm64_fips 683.667 MiB
docker_agent_arm64 807.709 MiB
docker_agent_jmx_arm64 987.408 MiB
docker_cluster_agent_amd64 206.991 MiB
docker_cluster_agent_arm64 220.952 MiB
docker_cws_instrumentation_amd64 7.154 MiB
docker_cws_instrumentation_arm64 6.689 MiB
docker_dogstatsd_amd64 39.487 MiB
docker_dogstatsd_arm64 37.690 MiB
dogstatsd_deb_amd64 30.143 MiB
dogstatsd_deb_arm64 28.268 MiB
dogstatsd_rpm_amd64 30.143 MiB
dogstatsd_suse_amd64 30.143 MiB
iot_agent_deb_amd64 44.578 MiB
iot_agent_deb_arm64 41.535 MiB
iot_agent_deb_armhf 42.243 MiB
iot_agent_rpm_amd64 44.578 MiB
iot_agent_suse_amd64 44.578 MiB

@cit-pr-commenter-54b7da
Copy link
Copy Markdown

cit-pr-commenter-54b7da Bot commented May 21, 2026

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 2f3235ee-d803-4119-9efc-bf8ba37dc685

Baseline: 824cf28
Comparison: 2c81359
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

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:

  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_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.

@briantu briantu added backport/7.79.x Automatically create a backport PR to the 7.79.x branch once the PR is merged backport/7.80.x Automatically create a backport PR to the 7.80.x branch once the PR is merged labels May 21, 2026
@briantu briantu changed the title macos: fix system-probe.yaml being clobbered on upgrade macos: fix system-probe.yaml being overwritten on upgrade May 21, 2026
@briantu briantu removed the changelog/no-changelog No changelog entry needed label May 21, 2026
@gh-worker-dd-mergequeue-cf854d gh-worker-dd-mergequeue-cf854d Bot merged commit 2c81359 into main May 21, 2026
338 checks passed
@gh-worker-dd-mergequeue-cf854d gh-worker-dd-mergequeue-cf854d Bot deleted the brian.tu/macos-preserve-extra-yaml-on-upgrade branch May 21, 2026 22:54
@github-actions github-actions Bot added this to the 7.81.0 milestone May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/7.79.x Automatically create a backport PR to the 7.79.x branch once the PR is merged backport/7.80.x Automatically create a backport PR to the 7.80.x branch once the PR is merged internal Identify a non-fork PR qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/agent-build team/windows-products

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants