8000 Extend setsockopt Tracking with Detailed Filter and Socket Data by theop-dd · Pull Request #38036 · DataDog/datadog-agent · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Extend setsockopt Tracking with Detailed Filter and Socket Data #38036

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

Open
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

theop-dd
Copy link
Contributor
@theop-dd theop-dd commented Jun 18, 2025

What does this PR do?

Adds additional information and data related to the setsockopt hook.

Socket Information:

  • Socket type
  • Socket family
  • Socket protocol

Filter Information:

  • Disassembled filter
  • Filter hash

In addition, this PR provides new helpers that can be used:

  • get_protocol_from_sock is able to get the socket protocol field from the struct sock and handle the different offset depending on the kernel version.

Motivation

To more accurately detect BPF doors, additional data was required from the setsockopt syscall. Specifically, we need to retrieve details about the socket to which the filter is attached, as well as key information from the filter itself. This data enables us to define more precise detection rules based on specific filter characteristics.

Describe how you validated your changes

The setsockopt test was updated to verify the tracking of the newly added information.

Possible Drawbacks / Trade-offs

Additional Notes

@theop-dd theop-dd added the qa/done QA done before merge and regressions are covered by tests label Jun 18, 2025
Copy link
cit-pr-commenter bot commented Jun 18, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 677f350d-077f-47b9-a54a-f4e343a3e83b

Baseline: a9e95a7
Comparison: 1c43b0b
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +2.25 [-0.91, +5.42] 1 Logs
otlp_ingest_logs memory utilization +0.68 [+0.55, +0.81] 1 Logs
docker_containers_memory memory utilization +0.44 [+0.37, +0.52] 1 Logs
otlp_ingest_metrics memory utilization +0.37 [+0.21, +0.54] 1 Logs
quality_gate_logs % cpu utilization +0.20 [-2.59, +2.99] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.07 [-0.49, +0.64] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.06 [-0.52, +0.64] 1 Logs
quality_gate_idle memory utilization +0.06 [-0.01, +0.12] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http1 egress throughput +0.04 [-0.56, +0.63] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.03 [-0.57, +0.64] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.03 [-0.06, +0.12] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.03 [-0.06, +0.12] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.02 [-0.59, +0.63] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.01 [-0.22, +0.25] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.01 [-0.59, +0.60] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.26, +0.27] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.02, +0.02] 1 Logs
ddot_metrics memory utilization -0.00 [-0.12, +0.12] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.04 [-0.64, +0.57] 1 Logs
ddot_logs memory utilization -0.60 [-0.70, -0.50] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -1.48 [-2.39, -0.57] 1 Logs
quality_gate_idle_all_features memory utilization -2.38 [-2.53, -2.23] 1 Logs bounds checks dashboard
file_tree memory utilization -4.49 [-4.70, -4.27] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
quality_gate_logs memory_usage 9/10 bounds checks dashboard
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_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

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

Failed. Some Quality Gates were violated.

  • 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.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 9/10 replicas passed. Failed 1 which is > 0. Gate FAILED.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.

@agent-platform-auto-pr
Copy link
Contributor
agent-platform-auto-pr bot commented Jun 18, 2025

Static quality checks

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

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${+0.04}$$ $${697.17}$$ < $${697.37}$$ $${+26.79}$$ $${176.11}$$ < $${177.03}$$
agent_deb_amd64_fips $${+0.04}$$ $${695.47}$$ < $${695.59}$$ $${+25.47}$$ $${175.56}$$ < $${176.51}$$
agent_heroku_amd64 $${+0}$$ $${358.71}$$ < $${359.67}$$ $${+11.33}$$ $${96.53}$$ < $${97.47}$$
agent_msi $${+0}$$ $${958.98}$$ < $${959.86}$$ $${-0}$$ $${146.3}$$ < $${147.27}$$
agent_rpm_amd64 $${+0.04}$$ $${697.16}$$ < $${697.36}$$ $${+25.89}$$ $${177.7}$$ < $${178.56}$$
agent_rpm_amd64_fips $${+0.04}$$ $${695.46}$$ < $${695.58}$$ $${+25.02}$$ $${177.61}$$ < $${178.43}$$
agent_rpm_arm64 $${+0.04}$$ $${687.18}$$ < $${687.37}$$ $${+22.91}$$ $${161.19}$$ < $${161.99}$$
agent_rpm_arm64_fips $${+0.04}$$ $${685.58}$$ < $${685.72}$$ $${+21.54}$$ $${160.33}$$ < $${161.11}$$
agent_suse_amd64 $${+0.04}$$ $${697.16}$$ < $${697.36}$$ $${+25.89}$$ $${177.7}$$ < $${178.56}$$
agent_suse_amd64_fips $${+0.04}$$ $${695.46}$$ < $${695.58}$$ $${+25.02}$$ $${177.61}$$ < $${178.43}$$
agent_suse_arm64 $${+0.04}$$ $${687.18}$$ < $${687.37}$$ $${+22.91}$$ $${161.19}$$ < $${161.99}$$
agent_suse_arm64_fips $${+0.04}$$ $${685.58}$$ < $${685.72}$$ $${+21.54}$$ $${160.33}$$ < $${161.11}$$
docker_agent_amd64 $${+0.04}$$ $${780.97}$$ < $${781.16}$$ $${-0}$$ $${268.83}$$ < $${269.63}$$
docker_agent_arm64 $${+0.04}$$ $${794.44}$$ < $${794.62}$$ $${+0}$$ $${256.2}$$ < $${257.0}$$
docker_agent_jmx_amd64 $${+0.04}$$ $${972.17}$$ < $${972.35}$$ $${+0.02}$$ $${337.81}$$ < $${338.6}$$
docker_agent_jmx_arm64 $${+0.04}$$ $${974.23}$$ < $${974.41}$$ $${+0.01}$$ $${321.14}$$ < $${321.97}$$
docker_agent_windows1809 $${-0.18}$$ $${1180.37}$$ < $${1488.0}$$ $${-0.08}$$ $${416.11}$$ < $${488.95}$$
docker_agent_windows1809_core $${+0}$$ $${5910.51}$$ < $${6218.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows1809_core_jmx $${+0.2}$$ $${6032.28}$$ < $${6361.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows1809_jmx $${+0}$$ $${1302.18}$$ < $${1609.5}$$ $${+0}$$ $${458.45}$$ < $${531.32}$$
docker_agent_windows2022 $${-0.1}$$ $${1199.88}$$ < $${1507.0}$$ $${-0.01}$$ $${428.92}$$ < $${501.7}$$
docker_agent_windows2022_core $${+0.66}$$ $${5883.77}$$ < $${6311.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows2022_core_jmx $${+0.21}$$ $${6005.43}$$ < $${6313.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows2022_jmx $${+0.17}$$ $${1321.6}$$ < $${1628.16}$$ $${+0}$$ $${471.2}$$ < $${543.98}$$
docker_cluster_agent_amd64 $${-0}$$ $${212.88}$$ < $${213.79}$$ $${+0}$$ $${72.39}$$ < $${73.33}$$
docker_cluster_agent_arm64 $${-0}$$ $${228.76}$$ < $${229.64}$$ $${+0}$$ $${68.67}$$ < $${69.6}$$
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}$$ $${39.22}$$ < $${39.57}$$ $${+0}$$ $${15.12}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${0}$$ $${37.88}$$ < $${38.2}$$ $${+0}$$ $${14.53}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${+0}$$ $${30.45}$$ < $${31.4}$$ $${+0.08}$$ $${8.0}$$ < $${8.95}$$
dogstatsd_deb_arm64 $${+0}$$ $${29.02}$$ < $${29.97}$$ $${+0.09}$$ $${6.94}$$ < $${7.89}$$
dogstatsd_rpm_amd64 $${+0}$$ $${30.45}$$ < $${31.4}$$ $${+0.08}$$ $${8.01}$$ < $${8.96}$$
dogstatsd_suse_amd64 $${+0}$$ $${30.45}$$ < $${31.4}$$ $${+0.08}$$ $${8.01}$$ < $${8.96}$$
iot_agent_deb_amd64 $${+0}$$ $${50.47}$$ < $${51.38}$$ $${+0.25}$$ $${12.85}$$ < $${13.79}$$
iot_agent_deb_arm64 $${+0}$$ $${47.94}$$ < $${48.85}$$ $${+0.22}$$ $${11.15}$$ < $${12.09}$$
iot_agent_deb_armhf $${+0}$$ $${47.51}$$ < $${48.42}$$ $${-0.01}$$ $${11.21}$$ < $${12.16}$$
iot_agent_rpm_amd64 $${+0}$$ $${50.47}$$ < $${51.38}$$ $${+0.25}$$ $${12.87}$$ < $${13.81}$$
iot_agent_rpm_arm64 $${+0}$$ $${47.94}$$ < $${48.85}$$ $${+0.22}$$ $${11.17}$$ < $${12.11}$$
iot_agent_suse_amd64 $${+0}$$ $${50.47}$$ < $${51.38}$$ $${+0.25}$$ $${12.87}$$ < $${13.81}$$

@theop-dd theop-dd marked this pull request as ready for review June 18, 2025 15:24
@theop-dd theop-dd requested review from a team as code owners June 18, 2025 15:24
if (syscall->setsockopt.filter_len > MAX_BPF_FILTER_LEN){
return 0;
}
send_event_with_size_ptr(ctx, EVENT_SETSOCKOPT, event, (offsetof(struct setsockopt_event_t, bpf_filters_buffer) + sizeof(struct sock_filter) * syscall->setsockopt.filter_len) );

// if the tail call fails, we need to pop the syscall cache entry
pop_syscall(EVENT_SETSOCKOPT);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to the changes of your PR but you don't need to pop the syscall here as you already do it at the beginning of the function

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are completely right, I'll delete that 👍

Copy link
Contributor
@buraizu buraizu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving with a couple of minor edits requested for casing consistency

| `level` | Level at which the option is defined |
| `optname` | Name of the option being set |
| `filter_len` | Length of the filter |
| `filter` | Filter data |
| `filter_hash` | Filter Hash |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `filter_hash` | Filter Hash |
| `filter_hash` | Filter hash |

},
"filter_hash": {
"type": "string",
"description": "Filter Hash"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Filter Hash"
"description": "Filter hash"

@theop-dd theop-dd force-pushed the theop-dd/setsockopt-2 branch from 5058f9f to 4bfc4be Compare June 19, 2025 08:25
@theop-dd theop-dd force-pushed the theop-dd/setsockopt-2 branch from b48c2d3 to f4e6606 Compare June 20, 2025 08:32
@theop-dd theop-dd force-pushed the theop-dd/setsockopt-2 branch from 41f445b to 4c721b4 Compare June 20, 2025 14:35
@theop-dd theop-dd force-pushed the theop-dd/setsockopt-2 branch from 4c721b4 to 1efbd65 Compare June 20, 2025 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/system-probe long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0