Run system-probe config fixups after BuildSchema - #54738
Conversation
fixupInitSystemProbe reads/writes system-probe config keys, but it was being called before BuildSchema() marks the config ready. Under HOST_ETC (containerized deployments), the readiness guard causes GetSource/GetString to silently no-op, so apt/yum/zypper repo dirs never got rewritten to point under the host filesystem, and agents logged "attempt to read key before config is constructed" errors. Move the call into a new fixupPostBuildConfig(), run after BuildSchema() on both config objects.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6c273e78f0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
🎯 Code Coverage (details) 🔗 Commit SHA: 9abe4f6 | Docs | Datadog PR Page | Give us feedback! |
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: ca45c2b Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_security_idle | memory utilization | +0.15 | [+0.04, +0.25] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_metrics_logs | memory utilization | +0.08 | [-0.16, +0.33] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_no_fs_load | memory utilization | +0.01 | [-0.14, +0.15] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle | memory utilization | -0.04 | [-0.16, +0.07] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_mean_fs_load | memory utilization | -0.07 | [-0.14, +0.01] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_private_action_runner | memory utilization | -0.07 | [-0.19, +0.04] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.33 | [-0.37, -0.28] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_logs | % cpu utilization | -1.08 | [-1.92, -0.23] | 1 | Logs bounds checks dashboard |
Bounds Checks: ❌ Failed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | quality_gate_idle | intake_connections | 10/10 | 4 = 4 | bounds checks dashboard |
| ❌ | quality_gate_idle | memory_usage | 0/10 | 173.10MiB > 154MiB | bounds checks dashboard |
| ✅ | quality_gate_idle | total_bytes_received | 10/10 | 731.88KiB ≤ 819.20KiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 4 = 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 511.01MiB ≤ 512MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | total_bytes_received | 10/10 | 1.13MiB ≤ 1.25MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 17 ≤ 40 | bounds checks dashboard |
| ❌ | quality_gate_logs | memory_usage | 0/10 | 204.55MiB > 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.17MiB ≤ 292MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 353.88 ≤ 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 | 403.36MiB ≤ 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 |
| ✅ | quality_gate_private_action_runner | memory_usage | 10/10 | 71.66MiB ≤ 75MiB | bounds checks dashboard |
| ✅ | quality_gate_security_idle | cpu_usage | 10/10 | 24.77 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_idle | memory_usage | 10/10 | 326.62MiB ≤ 330MiB | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | cpu_usage | 10/10 | 61.34 ≤ 200 | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | memory_usage | 10/10 | 300.76MiB ≤ 310MiB | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | cpu_usage | 10/10 | 21.27 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | memory_usage | 10/10 | 312.05MiB ≤ 320MiB | 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".
Replicate Execution Details
We run multiple replicates for each experiment/variant. However, we allow replicates to be automatically retried if there are any failures, up to 8 times, at which point the replicate is marked dead and we are unable to run analysis for the entire experiment. We call each of these attempts at running replicates a replicate execution. This section lists all replicate executions that failed due to the target crashing or being oom killed.
Note: In the below tables we bucket failures by experiment, variant, and failure type. For each of these buckets we list out the replicate indexes that failed with an annotation signifying how many times said replicate failed with the given failure mode. In the below example the baseline variant of the experiment named experiment_with_failures had two replicates that failed by oom kills. Replicate 0, which failed 8 executions, and replicate 1 which failed 6 executions, all with the same failure mode.
| Experiment | Variant | Replicates | Failure | Logs | Debug Dashboard |
|---|---|---|---|---|---|
| experiment_with_failures | baseline | 0 (x8) 1 (x6) | Oom killed | Debug Dashboard |
The debug dashboard links will take you to a debugging dashboard specifically designed to investigate replicate execution failures.
❌ Retried Profiling Replicate Execution Failures (ddprof)
Note: Profiling replicas may still be executing. See the debug dashboard for up to date status.
| Experiment | Variant | Replicates | Failure | Debug Dashboard |
|---|---|---|---|---|
| quality_gate_idle | comparison | 10 | Oom killed | Debug Dashboard |
| quality_gate_metrics_logs | baseline | 10 | Oom killed | Debug Dashboard |
| quality_gate_metrics_logs | comparison | 10 | Oom killed | Debug Dashboard |
| quality_gate_security_idle | baseline | 10 | Crashed (exit code: 134) | Debug Dashboard |
| quality_gate_security_no_fs_load | comparison | 10 | Crashed (exit code: 134) | Debug Dashboard |
CI Pass/Fail Decision
❌ Failed. Some Quality Gates were violated.
- 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: 0/10 replicas passed. Failed 10 which is > 0. Gate FAILED.
- quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check cpu_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_mean_fs_load, bounds check cpu_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_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.
- quality_gate_idle_all_features, bounds check memory_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_idle, bounds check memory_usage: 0/10 replicas passed. Failed 10 which is > 0. Gate FAILED.
- 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_metrics_logs, 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 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 intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_private_action_runner, bounds check memory_usage: 10/10 replicas passed. Gate passed.
Address review feedback: the fixup needs to run after HOST_ETC has been determined (useHostEtc), not just after BuildSchema, otherwise auto-detected HOST_ETC (as opposed to an env var set ahead of time) is never picked up. Move the call into LoadDatadog, right after useHostEtc, and rename fixupInitSystemProbe to postProcessSystemProbe since it no longer runs during the fixupInit phase.
d019929
into
main
|
Backport evaluation: View Slack thread |
…54752) Backport d019929 from #54738. ___ ### What does this PR do? Renames `fixupInitSystemProbe` to `postProcessSystemProbe` and moves the call from `fixupInitConfig` into `LoadDatadog`, right after `useHostEtc`. ### Motivation `postProcessSystemProbe` reads and writes system-probe config keys (`apt_config_dir`, `yum_repos_dir`, `zypper_repos_dir`) to rewrite them under `HOST_ETC`. It was being called too early on two counts: - Before `BuildSchema()` marks the config ready, so the readiness guard in the getters kicks in and `GetSource`/`GetString` silently no-op. Agents logged `attempt to read key before config is constructed: system_probe_config.apt_config_dir` (and the yum/zypper equivalents) on every start, and the rewrite never applied since `GetSource` returns `SourceUnknown` instead of `SourceDefault` while the config isn't ready. - Before `useHostEtc` runs, so even once that readiness issue is fixed, auto-detected `HOST_ETC` (as opposed to one set in the env ahead of time) still wouldn't be picked up. This was introduced in #53983, which changed the function from a no-op into a real implementation without accounting for either ordering constraint. ### Describe how you validated your changes Added a regression test (`TestPostProcessSystemProbeRunsAfterConfigIsReady`) that runs the real `InitConfigObjects()` + `LoadDatadog()` flow with `HOST_ETC` set and asserts the three keys get rewritten. Confirmed it fails against the old code (reproducing the exact error messages seen in the field) and passes with the fix. Also ran the full `pkg/config/setup` test suite and linter, no regressions. ### Additional Notes Serverless builds don't call this at all, since they have no system-probe config. Co-authored-by: sabrina.lu <sabrina.lu@datadoghq.com>
What does this PR do?
Renames
fixupInitSystemProbetopostProcessSystemProbeand moves the call fromfixupInitConfigintoLoadDatadog, right afteruseHostEtc.Motivation
postProcessSystemProbereads and writes system-probe config keys (apt_config_dir,yum_repos_dir,zypper_repos_dir) to rewrite them underHOST_ETC. It was being called too early on two counts:BuildSchema()marks the config ready, so the readiness guard in the getters kicks in andGetSource/GetStringsilently no-op. Agents loggedattempt to read key before config is constructed: system_probe_config.apt_config_dir(and the yum/zypper equivalents) on every start, and the rewrite never applied sinceGetSourcereturnsSourceUnknowninstead ofSourceDefaultwhile the config isn't ready.useHostEtcruns, so even once that readiness issue is fixed, auto-detectedHOST_ETC(as opposed to one set in the env ahead of time) still wouldn't be picked up.This was introduced in #53983, which changed the function from a no-op into a real implementation without accounting for either ordering constraint.
Describe how you validated your changes
Added a regression test (
TestPostProcessSystemProbeRunsAfterConfigIsReady) that runs the realInitConfigObjects()+LoadDatadog()flow withHOST_ETCset and asserts the three keys get rewritten. Confirmed it fails against the old code (reproducing the exact error messages seen in the field) and passes with the fix. Also ran the fullpkg/config/setuptest suite and linter, no regressions.Additional Notes
Serverless builds don't call this at all, since they have no system-probe config.