-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Fix fileMutator reinjecting leftovers from temporary files
#43875
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
base: main
Are you sure you want to change the base?
Conversation
When the original file doesn't exist, `fileMutator.mutate()` was still reading the temporary file (`.datadog.prep`) which could contain leftover data from previous failed operations. This caused the transformation to be applied to stale content instead of starting from empty data. Found by investigating test flakiness in `e2e-installer` job (`TestPackages/apm_inject_*_install_script/TestInstrumentDockerInactive`), this pollution could occur in production after failed install attempts. The fix ensures `pathTmp` is only read when `originalFileExists` is `true`, i.e., only when the current operation created the temporary file. Added `TestFileTransform_No_original_ignores_leftovers` to verify that leftover temporary files are properly ignored when the original file doesn't exist.
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 79e7768 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +1.83 | [-1.19, +4.85] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +1.83 | [-1.19, +4.85] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | +1.42 | [+1.34, +1.49] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | +1.33 | [+1.12, +1.54] | 1 | Logs bounds checks dashboard |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | +0.18 | [+0.01, +0.34] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.08 | [-0.30, +0.46] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | +0.07 | [-0.00, +0.15] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.05 | [+0.01, +0.09] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.05 | [-0.00, +0.10] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.00 | [-0.13, +0.14] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.08, +0.08] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.00 | [-0.13, +0.12] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.03 | [-0.45, +0.38] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.05 | [-0.46, +0.35] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.17 | [-0.40, +0.06] | 1 | Logs |
| ➖ | file_tree | memory utilization | -0.23 | [-0.29, -0.18] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | -0.36 | [-0.42, -0.31] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | -0.38 | [-0.52, -0.23] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.38 | [-0.42, -0.33] | 1 | Logs bounds checks dashboard |
| ➖ | ddot_metrics_sum_delta | memory utilization | -0.39 | [-0.60, -0.17] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | -0.56 | [-0.61, -0.50] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -0.65 | [-2.12, +0.83] | 1 | Logs bounds checks dashboard |
| ➖ | otlp_ingest_logs | memory utilization | -0.73 | [-0.85, -0.62] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | -0.96 | [-1.17, -0.76] | 1 | Logs |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ✅ | docker_containers_cpu | simple_check_run | 10/10 | |
| ✅ | docker_containers_memory | memory_usage | 10/10 | |
| ✅ | docker_containers_memory | simple_check_run | 10/10 | |
| ✅ | file_to_blackhole_0ms_latency | lost_bytes | 10/10 | |
| ✅ | file_to_blackhole_0ms_latency | memory_usage | 10/10 | |
| ✅ | file_to_blackhole_1000ms_latency | lost_bytes | 10/10 | |
| ✅ | file_to_blackhole_1000ms_latency | 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_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 | bounds checks dashboard |
| ✅ | quality_gate_logs | lost_bytes | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | lost_bytes | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 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_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_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check lost_bytes: 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, 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_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.
Motivation
When the original file doesn't exist,
fileMutator.mutate()still tries to read the corresponding.datadog.preptemporary file which, if still present, contains leftover data from a previous operation.This would cause the transformation to be applied to stale content instead of starting from empty data.
Found by investigating test flakiness in
e2e-installerjob (TestPackages/apm_inject_*_install_script/TestInstrumentDockerInactive), but this pollution could occur in production after failed install attempts.What does this PR do?
The fix ensures
pathTmpis only read whenoriginalFileExistsistrue, i.e., only when the current operation created the temporary file.Describe how you validated your changes
Added
TestFileTransform_No_original_ignores_leftoversto verify that a leftover temporary file is properly ignored when the original file doesn't exist.Additional Notes
There are error cases where temporary files won't be deleted at all, for instance:
... which the present change does not address.