Skip to content
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

usm: watcher: Add periodic scan #32400

Merged
merged 6 commits into from
Dec 24, 2024
Merged

Conversation

vitkyrka
Copy link
Contributor

@vitkyrka vitkyrka commented Dec 19, 2024

What does this PR do?

There are cases where the eBPF shared library watcher can miss hooking shared libraries in running processes. For example:

(1) When a process such as nginx daemonizes itself by forking.
Depending on timing, the parent process may exit before the hooking is
complete leading to the hooking of the library failing, and the child
process will never be noticied by the watcher since it never opens the
shared library (since it's inherited from the parent).

(2) When the path length is longer than what the eBPF program supports.

To ensure that we don't miss these kind of cases, introduce a periodic scan to try to attach to running processes. We maintain a map to ensure that we don't scan processes over and over again to limit CPU usage. We scan every processes twice in order to avoid races with startup where we may scan a process' maps file before it has opened its shared libraries.

Motivation

https://datadoghq.atlassian.net/wiki/spaces/UT/pages/4105764896

Describe how you validated your changes

Automated test added.

Also verified manually that with the fix nginx is monitored if launched like this

$ docker run -v /proc:/proc -it --entrypoint /bin/bash nginx
root@1d70122a9e6c:/# nginx

By checking the debug endpoint sudo curl --unix /opt/datadog-agent/run/sysprobe.sock http://unix/network_tracer/debug/usm/traced_programs | jq | gron

Possible Drawbacks / Trade-offs

Additional Notes

Profile on deployment in staging. The sync function takes 0.18% of CPU time in this profile.

There are cases where the eBPF shared library watcher can miss hooking
shared libraries in running processes.  For example:

 (1) When a process such as nginx daemonizes itself by forking.
 Depending on timing, the parent process may exit before the hooking is
 complete leading to the hooking of the library failing, and the child
 process will never be noticied by the watcher since it never opens the
 shared library (since it's inherited from the parent).

 (2) When the path length is longer than what the eBPF program supports.

To ensure that we don't miss these kind of cases, introduce a periodic
scan to try to attach to running processes.  We maintain a map to ensure
that we don't scan processes over and over again to limit CPU usage.  We
scan every processes twice in order to avoid races with startup where we
may scan a process' maps file before it has opened its shared libraries.
@github-actions github-actions bot added component/system-probe medium review PR review might take time labels Dec 19, 2024
@vitkyrka vitkyrka added changelog/no-changelog team/usm The USM team qa/done QA done before merge and regressions are covered by tests labels Dec 19, 2024
@vitkyrka vitkyrka marked this pull request as ready for review December 19, 2024 14:28
@vitkyrka vitkyrka requested a review from a team as a code owner December 19, 2024 14:28
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 19, 2024

[Fast Unit Tests Report]

On pipeline 51762414 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_deb-arm64-py3
  • tests_deb-x64-py3
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64
  • tests_rpm-arm64-py3
  • tests_rpm-x64-py3
  • tests_windows-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 19, 2024

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=51762414 --os-family=ubuntu

Note: This applies to commit 4cf293d

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 19, 2024

Uncompressed package size comparison

Comparison with ancestor 9648c1bba641a4bab12c59423793d45a8e015473

Diff per package
package diff status size ancestor threshold
datadog-agent-x86_64-rpm 0.01MB ⚠️ 1197.24MB 1197.23MB 140.00MB
datadog-agent-x86_64-suse 0.01MB ⚠️ 1197.24MB 1197.23MB 140.00MB
datadog-agent-amd64-deb 0.01MB ⚠️ 1187.98MB 1187.97MB 140.00MB
datadog-agent-aarch64-rpm 0.01MB ⚠️ 943.14MB 943.13MB 140.00MB
datadog-agent-arm64-deb 0.01MB ⚠️ 933.89MB 933.89MB 140.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.57MB 78.57MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.77MB 55.77MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 504.88MB 504.88MB 70.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.34MB 113.34MB 10.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.41MB 113.41MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.41MB 113.41MB 10.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.80MB 108.80MB 10.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.87MB 108.87MB 10.00MB

Decision

⚠️ Warning

Copy link

cit-pr-commenter bot commented Dec 19, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: b9225328-55ed-414e-81a3-cb51b2c8920a

Baseline: 9648c1b
Comparison: 4cf293d
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +0.97 [-2.27, +4.21] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.88 [+0.18, +1.57] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.84 [+0.02, +1.65] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.24 [-0.51, +1.00] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.13 [-0.33, +0.60] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.13 [-0.65, +0.91] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.06 [-0.84, +0.95] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.11, +0.12] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_tree memory utilization -0.01 [-0.14, +0.12] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.01 [-0.91, +0.89] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.06 [-0.70, +0.58] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.06 [-0.90, +0.77] 1 Logs
quality_gate_idle_all_features memory utilization -0.33 [-0.41, -0.25] 1 Logs bounds checks dashboard
otel_to_otel_logs ingress throughput -0.43 [-1.10, +0.25] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.61 [-0.66, -0.56] 1 Logs
quality_gate_idle memory utilization -0.66 [-0.70, -0.63] 1 Logs bounds checks dashboard

Bounds Checks: ❌ Failed

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

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

Copy link
Contributor

@guyarb guyarb left a comment

Choose a reason for hiding this comment

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

LGTM, the only comments I "insist" about are the documentation, the rest are just suggestions

@vitkyrka
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 24, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-24 12:06:00 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 34m.


2024-12-24 12:41:17 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit ba35e2a into main Dec 24, 2024
302 checks passed
@dd-mergequeue dd-mergequeue bot deleted the vincent.whitchurch/watcher-periodic branch December 24, 2024 12:41
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 24, 2024
louis-cqrl pushed a commit that referenced this pull request Dec 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog component/system-probe medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/usm The USM team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants