fix(par): surface rshell sandbox warnings via dedicated output field#50002
fix(par): surface rshell sandbox warnings via dedicated output field#50002
Conversation
When the AllowedPaths list configured for the runCommand action contains a path that does not exist on the host (e.g. /var/log on Windows), rshell emits a non-fatal "AllowedPaths: skipping" diagnostic during runner construction. Until v0.0.13 those diagnostics flushed onto the runner's stderr, which the handler then surfaced in RunCommandOutputs.Stderr — making every script execution in the session look like a failure (non- empty stderr) even though ExitCode was 0. rshell v0.0.14 adds a dedicated WarningsWriter sink and a Warnings() accessor (DataDog/rshell#200). Wire both: - Pass interp.WarningsWriter(io.Discard) so sandbox diagnostics no longer fall through to the runner's stderr. - Add SandboxWarnings []string to RunCommandOutputs (json:"sandboxWarnings,omitempty") and populate it from runner.Warnings() in the response. nil/empty when the sandbox configuration is clean, so the field is omitted from the wire output. The dd-source contract change adding the field to the action manifest is at DataDog/dd-source#423305. Closes DataDog/rshell#191. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
🎯 Code Coverage (details) 🔗 Commit SHA: add7df6 | Docs | Datadog PR Page | Give us feedback! |
Files inventory check summaryFile checks results against ancestor c50d9eac: Results for datadog-agent_7.80.0~devel.git.280.add7df6.pipeline.110135741-1_amd64.deb:No change detected |
Static quality checks✅ Please find below the results from static quality gates 30 successful checks with minimal change (< 2 KiB)
On-wire sizes (compressed)
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 0a12b4b Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | -2.84 | [-5.76, +0.07] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_idle_all_features | memory utilization | +0.54 | [+0.50, +0.58] | 1 | Logs bounds checks dashboard |
| ➖ | docker_containers_memory | memory utilization | +0.09 | [-0.01, +0.19] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | +0.08 | [-0.07, +0.23] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.06 | [-0.33, +0.46] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.05 | [+0.00, +0.10] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | +0.03 | [-0.07, +0.13] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.00 | [-0.11, +0.12] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.00 | [-0.20, +0.20] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.01 | [-0.14, +0.11] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.02 | [-0.07, +0.03] | 1 | Logs bounds checks dashboard |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | -0.03 | [-0.24, +0.18] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.04 | [-0.48, +0.40] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.05 | [-0.54, +0.44] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | -0.06 | [-0.22, +0.10] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | -0.10 | [-0.30, +0.09] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | -0.12 | [-0.30, +0.07] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.20 | [-0.44, +0.04] | 1 | Logs |
| ➖ | file_tree | memory utilization | -0.52 | [-0.56, -0.47] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | -0.64 | [-0.71, -0.58] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -0.67 | [-1.62, +0.29] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_metrics_logs | memory utilization | -0.76 | [-1.00, -0.51] | 1 | Logs bounds checks dashboard |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -1.71 | [-1.91, -1.51] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | -2.84 | [-5.76, +0.07] | 1 | Logs |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | docker_containers_cpu | simple_check_run | 10/10 | 715 ≥ 26 | |
| ✅ | docker_containers_memory | memory_usage | 10/10 | 242.45MiB ≤ 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.21GiB ≤ 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 | 139.93MiB ≤ 147MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 3 ≤ 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 467.17MiB ≤ 495MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 3 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 174.36MiB ≤ 195MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 343.85 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 4 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 382.80MiB ≤ 430MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | missed_bytes | 10/10 | 0B = 0B | 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_idle, bounds check memory_usage: 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 memory_usage: 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 intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate 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_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.
|
@codex conduct a comprehensive security and code review |
|
Codex Review: Didn't find any major issues. 🚀 ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
What does this PR do?
sandboxWarnings: string[]field toRunCommandOutputsfor the Private Action RunnerrunCommandaction.stderr, by passinginterp.WarningsWriter(io.Discard)and readingrunner.Warnings()afterinterp.New(...).Motivation
When
AllowedPathsforrunCommandcontains a path that does not exist on the host (e.g./var/logon Windows,C:\var\logon Linux), rshell emits a non-fatalAllowedPaths: skipping ...diagnostic during runner construction. Up to v0.0.13 the library flushed those diagnostics onto the runner's stderr writer, which the handler surfaced inRunCommandOutputs.Stderr— making every script execution look like a failure (non-empty stderr) even thoughExitCode == 0.DataDog/rshell#200 (in v0.0.14) decoupled sandbox diagnostics from the runner's stderr writer behind an opt-in
WarningsWriteroption and aRunner.Warnings()accessor. This PR adopts both.Closes DataDog/rshell#191 on the agent side. The matching contract change in dd-source — additive
sandboxWarnings?: string[]onRunCommandOutputs— is in DataDog/dd-source#423305.Describe how you validated your changes
go build ./pkg/privateactionrunner/...— clean.go test -count=1 ./pkg/privateactionrunner/bundles/remoteaction/rshell/...— all tests pass, including two new ones:TestRunCommandSandboxWarningsKeepStderrClean: configures one valid + one missingAllowedPathsentry, runsecho hello, assertsStderris empty (no sandbox diagnostic leakage), andSandboxWarningscarries oneAllowedPaths: skipping ...entry naming the missing path.TestRunCommandSandboxWarningsNilWhenCleanConfig: a clean configuration must producenilSandboxWarningsso the field is omitted from the JSON wire output.Additional Notes
SandboxWarningsusesjson:"sandboxWarnings,omitempty". Old PAR consumers that don't know about the field continue to deserialize the response unchanged.interp.WarningsWriter(io.Discard)is the right choice here because we read messages back via the accessor — there's no value in also writing them to the runner's stderr buffer.🤖 Generated with Claude Code