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: Include PathId in debug traced program list #32329

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

vitkyrka
Copy link
Contributor

What does this PR do?

Currently it's possible to see things like the below where the same paths are displayed as part of separate entries in the traced programs list with no hint as to why this is the case. Include the PathId to the traced programs list to make it clear exactly which file (dev/inode) is being traced.

Before:

 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
   "PIDs": [
     4275,
     1111324,
     3971,
     4240,
     4416,
     1110985
   ],
   "ProgramType": "shared_libraries"
 },
 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
   "PIDs": [
     7562
   ],
   "ProgramType": "shared_libraries"
 },

After:

 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
    "PathID": {
      "Dev": 64516,
      "Inode": 655961,
    },
   "PIDs": [
     4275,
     1111324,
     3971,
     4240,
     4416,
     1110985
   ],
   "ProgramType": "shared_libraries"
 },
 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
    "PathID": {
      "Dev": 130,
      "Inode": 4421665,
    },
   "PIDs": [
     7562
   ],
   "ProgramType": "shared_libraries"
 },

Motivation

Improve debugging.

Describe how you validated your changes

Manually verified by checking the output of sudo curl --unix /opt/datadog-agent/run/sysprobe.sock http://unix/network_tracer/debug/usm/traced_programs | jq .

Possible Drawbacks / Trade-offs

Additional Notes

Currently it's possible to see things like the below where the same
paths are displayed as part of separate entries in the traced programs
list with no hint as to why this is the case.  Include the PathId to the
traced programs list to make it clear exactly which file (dev/inode) is
being traced.

Before:

 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
   "PIDs": [
     4275,
     1111324,
     3971,
     4240,
     4416,
     1110985
   ],
   "ProgramType": "shared_libraries"
 },
 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
   "PIDs": [
     7562
   ],
   "ProgramType": "shared_libraries"
 },

After:

 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
    "PathID": {
      "Dev": 64516,
      "Inode": 655961,
    },
   "PIDs": [
     4275,
     1111324,
     3971,
     4240,
     4416,
     1110985
   ],
   "ProgramType": "shared_libraries"
 },
 {
   "FilePath": "/usr/lib64/libssl.so.1.0.2k",
    "PathID": {
      "Dev": 130,
      "Inode": 4421665,
    },
   "PIDs": [
     7562
   ],
   "ProgramType": "shared_libraries"
 },
@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 18, 2024
@vitkyrka vitkyrka marked this pull request as ready for review December 18, 2024 11:16
@vitkyrka vitkyrka requested a review from a team as a code owner December 18, 2024 11:16
@github-actions github-actions bot added component/system-probe short review PR is simple enough to be reviewed quickly labels Dec 18, 2024
@agent-platform-auto-pr
Copy link
Contributor

Uncompressed package size comparison

Comparison with ancestor 459aa24aad5a8903db6b58266b7497a7ecf33509

Diff per package
package diff status size ancestor threshold
datadog-dogstatsd-amd64-deb 0.00MB 78.59MB 78.59MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.67MB 78.67MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.67MB 78.67MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.79MB 55.79MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 505.06MB 505.06MB 70.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.31MB 113.31MB 10.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.38MB 113.38MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.38MB 113.38MB 10.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.78MB 108.78MB 10.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.85MB 108.85MB 10.00MB
datadog-agent-x86_64-rpm -0.01MB 1196.99MB 1197.01MB 140.00MB
datadog-agent-x86_64-suse -0.01MB 1196.99MB 1197.01MB 140.00MB
datadog-agent-amd64-deb -0.01MB 1187.76MB 1187.77MB 140.00MB
datadog-agent-aarch64-rpm -0.02MB 942.98MB 943.00MB 140.00MB
datadog-agent-arm64-deb -0.02MB 933.77MB 933.79MB 140.00MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

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=51428285 --os-family=ubuntu

Note: This applies to commit cbaa50d

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 19259b34-01b2-4818-8154-2575529366c7

Baseline: 459aa24
Comparison: cbaa50d
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 +2.55 [-0.43, +5.54] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.85 [+0.13, +1.57] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.51 [-0.25, +1.28] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.45 [-0.32, +1.21] 1 Logs
quality_gate_idle memory utilization +0.18 [+0.14, +0.23] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput +0.18 [+0.12, +0.24] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.10 [-0.81, +1.01] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.09 [-0.37, +0.56] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.05 [-0.85, +0.95] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.04 [-0.85, +0.92] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.10, +0.09] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.77, +0.70] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.04 [-0.67, +0.60] 1 Logs
quality_gate_idle_all_features memory utilization -0.14 [-0.27, -0.01] 1 Logs bounds checks dashboard
file_tree memory utilization -0.15 [-0.28, -0.02] 1 Logs
otel_to_otel_logs ingress throughput -1.51 [-2.19, -0.83] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
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 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_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.
  • 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.

@vitkyrka
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 18, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-18 13:16:17 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 29m.


2024-12-18 13:38:54 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 188825c into main Dec 18, 2024
332 checks passed
@dd-mergequeue dd-mergequeue bot deleted the vincent.whitchurch/debug-path-id branch December 18, 2024 13:38
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 18, 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 qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/usm The USM team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants