Skip to content

fix(par): surface rshell sandbox warnings via dedicated output field#50002

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits intomainfrom
matthew.deguzman/wire-rshell-sandbox-warnings
Apr 29, 2026
Merged

fix(par): surface rshell sandbox warnings via dedicated output field#50002
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits intomainfrom
matthew.deguzman/wire-rshell-sandbox-warnings

Conversation

@matt-dz
Copy link
Copy Markdown
Contributor

@matt-dz matt-dz commented Apr 28, 2026

What does this PR do?

  • Adds an optional sandboxWarnings: string[] field to RunCommandOutputs for the Private Action Runner runCommand action.
  • Routes rshell sandbox diagnostics into that field instead of the action's stderr, by passing interp.WarningsWriter(io.Discard) and reading runner.Warnings() after interp.New(...).

Motivation

When AllowedPaths for runCommand contains a path that does not exist on the host (e.g. /var/log on Windows, C:\var\log on Linux), rshell emits a non-fatal AllowedPaths: 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 in RunCommandOutputs.Stderr — making every script execution look like a failure (non-empty stderr) even though ExitCode == 0.

DataDog/rshell#200 (in v0.0.14) decoupled sandbox diagnostics from the runner's stderr writer behind an opt-in WarningsWriter option and a Runner.Warnings() accessor. This PR adopts both.

Closes DataDog/rshell#191 on the agent side. The matching contract change in dd-source — additive sandboxWarnings?: string[] on RunCommandOutputs — 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 missing AllowedPaths entry, runs echo hello, asserts Stderr is empty (no sandbox diagnostic leakage), and SandboxWarnings carries one AllowedPaths: skipping ... entry naming the missing path.
    • TestRunCommandSandboxWarningsNilWhenCleanConfig: a clean configuration must produce nil SandboxWarnings so the field is omitted from the JSON wire output.

Additional Notes

  • SandboxWarnings uses json:"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

@dd-octo-sts dd-octo-sts Bot added the internal Identify a non-fork PR label Apr 28, 2026
@matt-dz matt-dz added team/action-platform short review PR is simple enough to be reviewed quickly labels Apr 28, 2026
@datadog-prod-us1-6
Copy link
Copy Markdown

datadog-prod-us1-6 Bot commented Apr 28, 2026

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 93.10% (+42.89%)

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

@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented Apr 28, 2026

Files inventory check summary

File checks results against ancestor f0fb2d8e:

Results for datadog-agent_7.80.0~devel.git.339.a32aef2.pipeline.110428140-1_amd64.deb:

No change detected

@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented Apr 28, 2026

Static quality checks

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

30 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64 740.285 MiB
agent_deb_amd64_fips 698.688 MiB
agent_heroku_amd64 309.138 MiB
agent_rpm_amd64 740.269 MiB
agent_rpm_amd64_fips 698.672 MiB
agent_rpm_arm64 718.324 MiB
agent_rpm_arm64_fips 679.763 MiB
agent_suse_amd64 740.269 MiB
agent_suse_amd64_fips 698.672 MiB
agent_suse_arm64 718.324 MiB
agent_suse_arm64_fips 679.763 MiB
docker_agent_amd64 800.744 MiB
docker_agent_arm64 803.608 MiB
docker_agent_jmx_amd64 991.660 MiB
docker_agent_jmx_arm64 983.306 MiB
docker_cluster_agent_amd64 206.402 MiB
docker_cluster_agent_arm64 220.508 MiB
docker_cws_instrumentation_amd64 7.142 MiB
docker_cws_instrumentation_arm64 6.689 MiB
docker_dogstatsd_amd64 39.351 MiB
docker_dogstatsd_arm64 37.565 MiB
dogstatsd_deb_amd64 30.005 MiB
dogstatsd_deb_arm64 28.146 MiB
dogstatsd_rpm_amd64 30.005 MiB
dogstatsd_suse_amd64 30.005 MiB
iot_agent_deb_amd64 44.404 MiB
iot_agent_deb_arm64 41.392 MiB
iot_agent_deb_armhf 42.124 MiB
iot_agent_rpm_amd64 44.404 MiB
iot_agent_suse_amd64 44.404 MiB
On-wire sizes (compressed)
Quality gate Change Size (prev → curr → max)
agent_deb_amd64 +31.64 KiB (0.02% increase) 175.001 → 175.032 → 179.160
agent_deb_amd64_fips -13.86 KiB (0.01% reduction) 166.786 → 166.772 → 174.440
agent_heroku_amd64 +4.34 KiB (0.01% increase) 74.916 → 74.920 → 80.310
agent_rpm_amd64 -18.51 KiB (0.01% reduction) 177.053 → 177.035 → 182.080
agent_rpm_amd64_fips +6.04 KiB (0.00% increase) 168.208 → 168.214 → 174.140
agent_rpm_arm64 -25.7 KiB (0.02% reduction) 159.277 → 159.252 → 163.610
agent_rpm_arm64_fips +10.71 KiB (0.01% increase) 151.523 → 151.534 → 156.850
agent_suse_amd64 -18.51 KiB (0.01% reduction) 177.053 → 177.035 → 182.080
agent_suse_amd64_fips +6.04 KiB (0.00% increase) 168.208 → 168.214 → 174.140
agent_suse_arm64 -25.7 KiB (0.02% reduction) 159.277 → 159.252 → 163.610
agent_suse_arm64_fips +10.71 KiB (0.01% increase) 151.523 → 151.534 → 156.850
docker_agent_amd64 +9.72 KiB (0.00% increase) 267.359 → 267.368 → 272.990
docker_agent_arm64 +8.84 KiB (0.00% increase) 254.396 → 254.405 → 261.470
docker_agent_jmx_amd64 +8.87 KiB (0.00% increase) 336.022 → 336.031 → 341.610
docker_agent_jmx_arm64 neutral 319.044 MiB → 326.050
docker_cluster_agent_amd64 neutral 72.335 MiB → 73.460
docker_cluster_agent_arm64 neutral 67.807 MiB → 68.680
docker_cws_instrumentation_amd64 neutral 2.999 MiB → 3.330
docker_cws_instrumentation_arm64 neutral 2.729 MiB → 3.090
docker_dogstatsd_amd64 neutral 15.231 MiB → 15.870
docker_dogstatsd_arm64 neutral 14.546 MiB → 14.890
dogstatsd_deb_amd64 neutral 7.938 MiB → 8.830
dogstatsd_deb_arm64 neutral 6.817 MiB → 7.750
dogstatsd_rpm_amd64 neutral 7.947 MiB → 8.840
dogstatsd_suse_amd64 neutral 7.947 MiB → 8.840
iot_agent_deb_amd64 neutral 11.686 MiB → 13.210
iot_agent_deb_arm64 neutral 9.989 MiB → 11.620
iot_agent_deb_armhf neutral 10.192 MiB → 11.780
iot_agent_rpm_amd64 neutral 11.703 MiB → 13.230
iot_agent_suse_amd64 neutral 11.703 MiB → 13.230

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

cit-pr-commenter-54b7da Bot commented Apr 28, 2026

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 2aa94477-2d76-4289-9b56-99381b96d746

Baseline: f4d586e
Comparison: a55c3db
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 -0.48 [-3.36, +2.41] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_metrics_logs memory utilization +1.38 [+1.13, +1.62] 1 Logs bounds checks dashboard
otlp_ingest_logs memory utilization +0.56 [+0.47, +0.66] 1 Logs
quality_gate_idle_all_features memory utilization +0.20 [+0.16, +0.24] 1 Logs bounds checks dashboard
ddot_logs memory utilization +0.11 [+0.04, +0.18] 1 Logs
docker_containers_memory memory utilization +0.10 [-0.00, +0.20] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.06 [-0.43, +0.55] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.04 [-0.39, +0.47] 1 Logs
quality_gate_idle memory utilization +0.04 [-0.01, +0.09] 1 Logs bounds checks dashboard
ddot_metrics_sum_cumulativetodelta_exporter memory utilization +0.02 [-0.22, +0.27] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.02 [-0.09, +0.12] 1 Logs
ddot_metrics memory utilization +0.01 [-0.19, +0.21] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.09, +0.10] 1 Logs
uds_dogstatsd_to_api_v3 ingress throughput +0.00 [-0.19, +0.20] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.21, +0.19] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.06 [-0.45, +0.33] 1 Logs
ddot_metrics_sum_delta memory utilization -0.08 [-0.27, +0.12] 1 Logs
file_tree memory utilization -0.13 [-0.18, -0.08] 1 Logs
otlp_ingest_metrics memory utilization -0.24 [-0.40, -0.09] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.27 [-0.32, -0.23] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.45 [-0.63, -0.27] 1 Logs
docker_containers_cpu % cpu utilization -0.48 [-3.36, +2.41] 1 Logs
ddot_metrics_sum_cumulative memory utilization -0.53 [-0.69, -0.38] 1 Logs
quality_gate_logs % cpu utilization -1.79 [-2.76, -0.82] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
docker_containers_cpu simple_check_run 10/10 698 ≥ 26
docker_containers_memory memory_usage 10/10 241.34MiB ≤ 370MiB
docker_containers_memory simple_check_run 10/10 579 ≥ 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.19GiB ≤ 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.19MiB ≤ 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 466.60MiB ≤ 495MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_logs memory_usage 10/10 176.19MiB ≤ 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.22 ≤ 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 390.31MiB ≤ 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:

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

@matt-dz matt-dz added the qa/done QA done before merge and regressions are covered by tests label Apr 28, 2026
@matt-dz matt-dz marked this pull request as ready for review April 28, 2026 14:48
@matt-dz matt-dz requested a review from a team as a code owner April 28, 2026 14:48
@matt-dz matt-dz requested a review from asiya-sh April 28, 2026 14:48
@matt-dz matt-dz added the backport/7.79.x Automatically create a backport PR to the 7.79.x branch once the PR is merged label Apr 28, 2026
@matt-dz matt-dz requested a review from AlexandreYang April 28, 2026 14:50
@matt-dz
Copy link
Copy Markdown
Contributor Author

matt-dz commented Apr 28, 2026

@codex conduct a comprehensive security and code review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

ℹ️ 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".

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>
@matt-dz matt-dz force-pushed the matthew.deguzman/wire-rshell-sandbox-warnings branch from add7df6 to 391b9ab Compare April 29, 2026 13:12
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@matt-dz matt-dz added the changelog/no-changelog No changelog entry needed label Apr 29, 2026
@gh-worker-dd-mergequeue-cf854d gh-worker-dd-mergequeue-cf854d Bot merged commit a55c3db into main Apr 29, 2026
239 of 240 checks passed
@gh-worker-dd-mergequeue-cf854d gh-worker-dd-mergequeue-cf854d Bot deleted the matthew.deguzman/wire-rshell-sandbox-warnings branch April 29, 2026 15:11
@github-actions github-actions Bot added this to the 7.80.0 milestone Apr 29, 2026
gh-worker-dd-mergequeue-cf854d Bot pushed a commit that referenced this pull request Apr 29, 2026
…ated output field (#50100)

Backport a55c3db from #50002.

 ___

### What does this PR do?

- Adds an optional `sandboxWarnings: string[]` field to `RunCommandOutputs` for the Private Action Runner `runCommand` action.
- Routes rshell sandbox diagnostics into that field instead of the action's `stderr`, by passing `interp.WarningsWriter(io.Discard)` and reading `runner.Warnings()` after `interp.New(...)`.

### Motivation

When `AllowedPaths` for `runCommand` contains a path that does not exist on the host (e.g. `/var/log` on Windows, `C:\var\log` on Linux), rshell emits a non-fatal `AllowedPaths: 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 in `RunCommandOutputs.Stderr` — making every script execution look like a failure (non-empty stderr) even though `ExitCode == 0`.

[DataDog/rshell#200](DataDog/rshell#200) (in v0.0.14) decoupled sandbox diagnostics from the runner's stderr writer behind an opt-in `WarningsWriter` option and a `Runner.Warnings()` accessor. This PR adopts both.

Closes [DataDog/rshell#191](DataDog/rshell#191) on the agent side. The matching contract change in dd-source — additive `sandboxWarnings?: string[]` on `RunCommandOutputs` — is in [DataDog/dd-source#423305](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 missing `AllowedPaths` entry, runs `echo hello`, asserts `Stderr` is empty (no sandbox diagnostic leakage), and `SandboxWarnings` carries one `AllowedPaths: skipping ...` entry naming the missing path.
  - `TestRunCommandSandboxWarningsNilWhenCleanConfig`: a clean configuration must produce `nil` `SandboxWarnings` so the field is omitted from the JSON wire output.

### Additional Notes

- `SandboxWarnings` uses `json:"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](https://claude.com/claude-code)

Co-authored-by: spencer.gilbert <spencer.gilbert@datadoghq.com>
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 changelog/no-changelog No changelog entry needed 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/action-platform

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AllowedPaths warning pollutes stderr of every command when a configured path is missing (e.g. C:\var\log on Windows)

2 participants