datadog-agent icon indicating copy to clipboard operation
datadog-agent copied to clipboard

convert remote SFTP paths to forward slashes for Windows hosts

Open clarkb7 opened this issue 11 months ago • 1 comments

What does this PR do?

Convert backslashes to forward slashes in any remote paths used in Windows E2E remote hosts.

Motivation

Some methods in the go sftp package use the go path package for path parsing, this causes errors with Windows paths of the form C:\\Windows\\Temp. The issue was first noticed with MkdirAll.

Additional Notes

Possible Drawbacks / Trade-offs

backslashes are a valid Linux filename character, so I chose to put the path conversion in RemoteHost rather than ssh/client.go so we can check the OSFamily. This means direct usage of ssh/client.go could still be impacted by this issue. At the moment only RemoteHost uses ssh/client.go.

The go path package also does not support drive letter paths, so for example IsAbs("C:\\Windows") will return false. At the moment go sftp package does not appear to use IsAbs or other functions that may be affected by this.

I've added the conversion to all SFTP functions, even if the go sftp function does not currently use a path function that could throw an error. The converted path will still work, and we won't have to keep our code up to date with any changes to the go sftp package.

Describe how to test/QA your changes

clarkb7 avatar Feb 27 '24 16:02 clarkb7

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: a1846252-d8c1-4157-b659-bcb72b549d01 Baseline: abd73bd710368b81f627dbbcbd12dbd6216a762a Comparison: 0f217b5d5ee2fcb8cc166ddae48b0e204f2d470e Total CPUs: 7

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

Experiments with missing or malformed data

  • basic_py_check

Usually, this warning means that there is no usable optimization goal data for that experiment, which could be a result of misconfiguration.

No significant changes in experiment optimization goals

Confidence level: 90.00% Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

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

perf experiment goal Δ mean % Δ mean % CI
file_to_blackhole % cpu utilization +0.86 [-5.75, +7.47]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
file_to_blackhole % cpu utilization +0.86 [-5.75, +7.47]
uds_dogstatsd_to_api_cpu % cpu utilization +0.68 [-0.77, +2.13]
process_agent_real_time_mode memory utilization +0.64 [+0.60, +0.69]
file_tree memory utilization +0.41 [+0.29, +0.52]
idle memory utilization +0.23 [+0.19, +0.27]
trace_agent_msgpack ingress throughput +0.01 [-0.01, +0.02]
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.00, +0.00]
uds_dogstatsd_to_api ingress throughput +0.00 [-0.00, +0.00]
trace_agent_json ingress throughput -0.00 [-0.04, +0.04]
process_agent_standard_check_with_stats memory utilization -0.13 [-0.18, -0.08]
otel_to_otel_logs ingress throughput -0.19 [-0.83, +0.45]
process_agent_standard_check memory utilization -0.32 [-0.37, -0.28]
tcp_syslog_to_blackhole ingress throughput -0.43 [-0.48, -0.38]

Explanation

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

pr-commenter[bot] avatar Feb 27 '24 17:02 pr-commenter[bot]

/merge

clarkb7 avatar Feb 28 '24 16:02 clarkb7

:steam_locomotive: MergeQueue

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals. Note: if you pushed new commits since the last approval, you may need additional approval. You can remove it from the waiting list with /remove command.

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Feb 28 '24 16:02 dd-devflow[bot]

:steam_locomotive: MergeQueue

Added to the queue.

There are 7 builds ahead of this PR! (estimated merge in less than 2h)

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Feb 28 '24 18:02 dd-devflow[bot]