[CNM-4440] Add TCP SYN traceroute driver #37433

pimlu · 2025-05-27T22:13:41Z

Stacked on [NPM-4440] Move packet capture to separate package, add Sink interface

What does this PR do?

Adds tcpDriver, an implementation of TracerouteDriver for TCP SYN.
Adds generated mocks for Source and Sink, the platform-agnostic packet interfaces tcpDriver uses.
Adds a test suite for correctness of tcpDriver which uses the mocks
Small changes to the common package to support this
Added a CLI tool portable_syn which runs a traceroute with tcpDriver.

Motivation

Working towards replacing the traceroute implementations with platform-agnostic and (mostly) IPv4/IPv6 agnostic versions.

Remaining work:

Add UDP driver which implements TracerouteDriver
Make our Windows RawConn implement Source and Sink so all our traceroutes work on Windows too

Describe how you validated your changes

I added a big test suite for tcpDriver in tcp_driver_test.go which you can run via:

go test -timeout 30s -tags linux,linux_bpf,npm,process,test github.com/DataDog/datadog-agent/pkg/networkpath/traceroute/tcp

Possible Drawbacks / Trade-offs

Tests don't cover paris traceroute mode right now, but hopefully we are removing that mode.

Additional Notes

cit-pr-commenter · 2025-05-27T22:28:35Z

Go Package Import Differences

Baseline: c24df94
Comparison: 65be31b

binary	os	arch	change
system-probe	windows	amd64	+1, -0 +github.com/DataDog/datadog-agent/pkg/networkpath/traceroute/packets

agent-platform-auto-pr · 2025-05-27T22:40:13Z

Uncompressed package size comparison

Comparison with ancestor e72db428cc3a791eefb13e5e8b5c81d228eb5d34

Diff per package

package	diff	status	size	ancestor	threshold
datadog-agent-aarch64-rpm	0.00MB	✅	768.33MB	768.33MB	0.50MB
datadog-agent-arm64-deb	0.00MB	✅	759.40MB	759.40MB	0.50MB
datadog-agent-x86_64-rpm	0.00MB	✅	782.41MB	782.41MB	0.50MB
datadog-agent-x86_64-suse	0.00MB	✅	782.41MB	782.41MB	0.50MB
datadog-agent-amd64-deb	0.00MB	✅	773.46MB	773.46MB	0.50MB
datadog-dogstatsd-amd64-deb	0.00MB	✅	31.99MB	31.99MB	0.50MB
datadog-dogstatsd-x86_64-rpm	0.00MB	✅	32.07MB	32.07MB	0.50MB
datadog-dogstatsd-x86_64-suse	0.00MB	✅	32.07MB	32.07MB	0.50MB
datadog-dogstatsd-arm64-deb	0.00MB	✅	30.47MB	30.47MB	0.50MB
datadog-heroku-agent-amd64-deb	0.00MB	✅	380.17MB	380.17MB	0.50MB
datadog-iot-agent-amd64-deb	0.00MB	✅	62.79MB	62.79MB	0.50MB
datadog-iot-agent-x86_64-rpm	0.00MB	✅	62.88MB	62.88MB	0.50MB
datadog-iot-agent-x86_64-suse	0.00MB	✅	62.87MB	62.87MB	0.50MB
datadog-iot-agent-arm64-deb	0.00MB	✅	59.37MB	59.37MB	0.50MB
datadog-iot-agent-aarch64-rpm	0.00MB	✅	59.45MB	59.45MB	0.50MB

Decision

✅ Passed

cit-pr-commenter · 2025-06-04T22:38:34Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: c7204b5e-e89d-4585-8b99-0c19ff436c37

Baseline: c24df94
Comparison: 65be31b
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+0.98	[+0.05, +1.91]	1	Logs
➖	uds_dogstatsd_20mb_12k_contexts_20_senders	memory utilization	+0.43	[+0.38, +0.48]	1	Logs
➖	ddot_metrics	memory utilization	+0.40	[+0.28, +0.51]	1	Logs
➖	docker_containers_cpu	% cpu utilization	+0.31	[-2.64, +3.25]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	+0.09	[-0.15, +0.32]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	+0.08	[-0.53, +0.69]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.04	[-0.54, +0.63]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	+0.01	[-0.63, +0.64]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.01	[-0.26, +0.28]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.01, +0.02]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	-0.00	[-0.61, +0.60]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	-0.02	[-0.61, +0.56]	1	Logs
➖	otlp_ingest_metrics	memory utilization	-0.02	[-0.18, +0.13]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.03	[-0.10, +0.04]	1	Logs bounds checks dashboard
➖	tcp_syslog_to_blackhole	ingress throughput	-0.04	[-0.11, +0.02]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.05	[-0.67, +0.57]	1	Logs
➖	file_to_blackhole_0ms_latency_http1	egress throughput	-0.07	[-0.68, +0.53]	1	Logs
➖	ddot_logs	memory utilization	-0.21	[-0.35, -0.08]	1	Logs
➖	quality_gate_idle	memory utilization	-0.22	[-0.29, -0.14]	1	Logs bounds checks dashboard
➖	file_tree	memory utilization	-0.24	[-0.38, -0.10]	1	Logs
➖	otlp_ingest_logs	memory utilization	-0.25	[-0.38, -0.13]	1	Logs
➖	docker_containers_memory	memory utilization	-1.39	[-1.57, -1.22]	1	Logs
➖	quality_gate_logs	% cpu utilization	-2.84	[-5.55, -0.12]	1	Logs bounds checks dashboard

Bounds Checks: ❌ Failed

perf	experiment	bounds_check_name	replicates_passed	links
❌	docker_containers_memory	memory_usage	0/10
✅	docker_containers_cpu	simple_check_run	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_0ms_latency_http1	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency_http1	memory_usage	10/10
✅	file_to_blackhole_0ms_latency_http2	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency_http2	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency_linear_load	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_300ms_latency	lost_bytes	10/10
✅	file_to_blackhole_300ms_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

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_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
quality_gate_logs, 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_idle, 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.

agent-platform-auto-pr · 2025-06-05T16:04:00Z

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor c24df94

Successful checks

Info

	Quality gate	Delta	On disk size (MiB)	Delta	On wire size (MiB)
✅	agent_deb_amd64	$${+0}$$	$${731.84}$$ < $${752.99}$$	$${-0}$$	$${181.36}$$ < $${187.44}$$
✅	agent_deb_amd64_fips	$${+0}$$	$${730.12}$$ < $${751.36}$$	$${-0.07}$$	$${180.73}$$ < $${187.06}$$
✅	agent_heroku_amd64	$${0}$$	$${358.52}$$ < $${369.68}$$	$${+0}$$	$${96.49}$$ < $${99.55}$$
✅	agent_msi	$${+0}$$	$${959.63}$$ < $${987.01}$$	$${-0.02}$$	$${146.4}$$ < $${150.72}$$
✅	agent_rpm_amd64	$${+0}$$	$${731.82}$$ < $${752.98}$$	$${-0.01}$$	$${183.54}$$ < $${190.03}$$
✅	agent_rpm_amd64_fips	$${+0}$$	$${730.11}$$ < $${751.35}$$	$${+0.02}$$	$${183.66}$$ < $${189.81}$$
✅	agent_rpm_arm64	$${-0}$$	$${719.22}$$ < $${739.42}$$	$${+0.01}$$	$${165.42}$$ < $${171.23}$$
✅	agent_rpm_arm64_fips	$${-0}$$	$${717.64}$$ < $${737.91}$$	$${-0.01}$$	$${164.76}$$ < $${170.22}$$
✅	agent_suse_amd64	$${+0}$$	$${731.82}$$ < $${752.98}$$	$${-0.01}$$	$${183.54}$$ < $${190.03}$$
✅	agent_suse_amd64_fips	$${+0}$$	$${730.11}$$ < $${751.35}$$	$${+0.02}$$	$${183.66}$$ < $${189.81}$$
✅	agent_suse_arm64	$${-0}$$	$${719.22}$$ < $${739.42}$$	$${+0.01}$$	$${165.42}$$ < $${171.23}$$
✅	agent_suse_arm64_fips	$${-0}$$	$${717.64}$$ < $${737.91}$$	$${-0.01}$$	$${164.76}$$ < $${170.22}$$
✅	docker_agent_amd64	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_arm64	$${-0}$$	$${826.47}$$ < $${858.97}$$	$${-0}$$	$${263.64}$$ < $${274.36}$$
✅	docker_agent_jmx_amd64	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_jmx_arm64	$${-0}$$	$${826.47}$$ < $${858.97}$$	$${-0}$$	$${263.64}$$ < $${274.36}$$
✅	docker_agent_windows1809	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows1809_core	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows1809_core_jmx	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows1809_jmx	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows2022	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows2022_core	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows2022_core_jmx	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_agent_windows2022_jmx	$${+0}$$	$${815.62}$$ < $${849.39}$$	$${+0}$$	$${277.08}$$ < $${288.34}$$
✅	docker_cluster_agent_amd64	$${-0}$$	$${259.13}$$ < $${259.73}$$	$${+0}$$	$${102.84}$$ < $${103.68}$$
✅	docker_cluster_agent_arm64	$${-0}$$	$${273.57}$$ < $${274.24}$$	$${+0}$$	$${97.58}$$ < $${98.45}$$
✅	docker_cws_instrumentation_amd64	$${0}$$	$${7.08}$$ < $${7.12}$$	$${-0}$$	$${2.95}$$ < $${3.29}$$
✅	docker_cws_instrumentation_arm64	$${-0}$$	$${6.69}$$ < $${6.92}$$	$${-0}$$	$${2.7}$$ < $${3.07}$$
✅	docker_dogstatsd_amd64	$${+0}$$	$${38.92}$$ < $${39.57}$$	$${0}$$	$${14.95}$$ < $${15.76}$$
✅	docker_dogstatsd_arm64	$${+0}$$	$${37.52}$$ < $${38.2}$$	$${+0}$$	$${13.96}$$ < $${14.83}$$
✅	dogstatsd_deb_amd64	$${0}$$	$${30.61}$$ < $${31.52}$$	$${+0}$$	$${8.03}$$ < $${8.97}$$
✅	dogstatsd_deb_arm64	$${0}$$	$${29.16}$$ < $${30.08}$$	$${-0}$$	$${6.97}$$ < $${7.92}$$
✅	dogstatsd_rpm_amd64	$${0}$$	$${30.61}$$ < $${31.52}$$	$${-0}$$	$${8.04}$$ < $${8.98}$$
✅	dogstatsd_suse_amd64	$${0}$$	$${30.61}$$ < $${31.52}$$	$${-0}$$	$${8.04}$$ < $${8.98}$$
✅	iot_agent_deb_amd64	$${0}$$	$${50.44}$$ < $${60.17}$$	$${+0}$$	$${12.85}$$ < $${15.82}$$
✅	iot_agent_deb_arm64	$${0}$$	$${47.9}$$ < $${56.94}$$	$${+0}$$	$${11.14}$$ < $${13.86}$$
✅	iot_agent_deb_armhf	$${0}$$	$${47.48}$$ < $${56.41}$$	$${+0.01}$$	$${11.21}$$ < $${13.86}$$
✅	iot_agent_rpm_amd64	$${0}$$	$${50.44}$$ < $${60.18}$$	$${+0}$$	$${12.87}$$ < $${15.84}$$
✅	iot_agent_rpm_arm64	$${0}$$	$${47.9}$$ < $${56.94}$$	$${-0}$$	$${11.16}$$ < $${13.76}$$
✅	iot_agent_suse_amd64	$${0}$$	$${50.44}$$ < $${60.18}$$	$${+0}$$	$${12.87}$$ < $${15.84}$$

hmahmood

One comment about file naming: e.g., for the files under tcp folder, the prefix tcp_ seems redundant. Same for the files under the packets folder.

pkg/networkpath/traceroute/packets/packet_sink_unix.go

pkg/networkpath/traceroute/tcp/tcp_driver.go

pimlu requested a review from a team as a code owner May 27, 2025 22:13

pimlu requested review from mbakht and a team and removed request for a team May 27, 2025 22:13

pimlu added changelog/no-changelog component/system-probe team/networks qa/done QA done before merge and regressions are covered by tests labels May 27, 2025

pimlu force-pushed the sgeipel/packet-sink branch from 2d8fcc7 to d410d19 Compare June 4, 2025 14:10

pimlu requested review from a team as code owners June 4, 2025 14:10

pimlu force-pushed the sgeipel/packet-sink branch from ecf7a0c to b460cd5 Compare June 4, 2025 17:19

Base automatically changed from sgeipel/packet-sink to main June 4, 2025 20:13

[CNM-4440] Add TCP traceroute driver

ed0ec1c

pimlu force-pushed the sgeipel/use-driver-squash branch from 53c0e92 to ed0ec1c Compare June 4, 2025 21:42

github-actions bot removed the component/system-probe label Jun 4, 2025

pimlu removed the request for review from a team June 4, 2025 21:43

github-actions bot added the long review PR is complex, plan time to review it label Jun 4, 2025

pimlu added 2 commits June 5, 2025 06:49

add fabrice's changes to packet sink

1ec10bd

fix build hopefully

65be31b

hmahmood reviewed Jun 16, 2025

View reviewed changes

pkg/networkpath/traceroute/packets/packet_sink_unix.go Show resolved Hide resolved

pkg/networkpath/traceroute/tcp/tcp_driver.go Show resolved Hide resolved

hmahmood approved these changes Jun 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[CNM-4440] Add TCP SYN traceroute driver #37433

[CNM-4440] Add TCP SYN traceroute driver #37433

Uh oh!

pimlu commented May 27, 2025 •

edited

Loading

Uh oh!

cit-pr-commenter bot commented May 27, 2025 •

edited

Loading

Uh oh!

agent-platform-auto-pr bot commented May 27, 2025

Uh oh!

cit-pr-commenter bot commented Jun 4, 2025 •

edited

Loading

Fine details of change detection per experiment

Explanation

Uh oh!

agent-platform-auto-pr bot commented Jun 5, 2025

Info

Uh oh!

hmahmood left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[CNM-4440] Add TCP SYN traceroute driver #37433

Are you sure you want to change the base?

[CNM-4440] Add TCP SYN traceroute driver #37433

Uh oh!

Conversation

pimlu commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

Uh oh!

cit-pr-commenter bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Go Package Import Differences

Uh oh!

agent-platform-auto-pr bot commented May 27, 2025

Uncompressed package size comparison

Decision

Uh oh!

cit-pr-commenter bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Regression Detector

Regression Detector Results

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

Bounds Checks: ❌ Failed

Explanation

CI Pass/Fail Decision

Uh oh!

agent-platform-auto-pr bot commented Jun 5, 2025

Static quality checks

Info

Uh oh!

hmahmood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pimlu commented May 27, 2025 •

edited

Loading

cit-pr-commenter bot commented May 27, 2025 •

edited

Loading

cit-pr-commenter bot commented Jun 4, 2025 •

edited

Loading