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

[Dynamic Instrumentation] refactor loadFunctionDefinitions to use one reader #34594

Closed
wants to merge 1 commit into from

Conversation

tylfin
Copy link
Contributor

@tylfin tylfin commented Feb 28, 2025

What does this PR do?

This pull request includes several changes to the pkg/dynamicinstrumentation/diconfig/dwarf.go file to streamline the process of reading and expanding type data from DWARF debug information. The modifications focus on optimizing the use of the DWARF reader and improving the handling of type offsets.

Improvements to DWARF data reading and type expansion:

  • Consolidated the use of DWARF readers by removing the separate entryReader and typeReader and using a single reader instead. [1] [2]
  • Introduced a new slice offsets to collect offsets of type entries, which are then processed in a separate loop to expand type data. [1] [2]
  • Modified the expandTypeData function to accept a reader parameter, allowing it to use the same reader instance for seeking and reading type entries.
  • Updated the resolveTypedefToRealType function calls to use the consolidated reader instead of the removed typeReader.

Motivation

As part of incident-35560, we noticed that the loadFunctionDefinitions had a higher start-up cost than expected. This reduces the number of open readers and is a first step to a smaller memory footprint.

Describe how you validated your changes

unit / e2e

Possible Drawbacks / Trade-offs

Additional Notes

@tylfin tylfin added changelog/no-changelog team/dynamic-instrumentation Dynamic Instrumentation qa/done QA done before merge and regressions are covered by tests labels Feb 28, 2025
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Feb 28, 2025
@tylfin
Copy link
Contributor Author

tylfin commented Feb 28, 2025

@grantseltzer I know it's not a priority now, but I wanted to get it down while it was still in my head. I think for particularly large DWARF objects, we're performing DFS which means we keep everything in memory until the traversal halts. If we switch this to BFS, that should allow the GC to cleanup objects and avoid potential OOM problems.

It gets a lot more complicated further down the chain, so I limited the scope of this refactor to just the loadFunctionDefinitions method.

@tylfin tylfin force-pushed the tyler.finethy/DEBUG-3566-dwarf-refactor branch 4 times, most recently from 8c5f6c9 to 04f116b Compare February 28, 2025 19:26
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 28, 2025

[Fast Unit Tests Report]

On pipeline 57403993 (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 Feb 28, 2025

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

Note: This applies to commit d44dae0

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 28, 2025

Uncompressed package size comparison

Comparison with ancestor 734ced837a83277442029071c06b490590cd0e15

Diff per package
package diff status size ancestor threshold
datadog-agent-x86_64-rpm 0.00MB 825.02MB 825.02MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 825.02MB 825.02MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 815.97MB 815.97MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.16MB 62.16MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.16MB 62.16MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.40MB 59.40MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.50MB 39.50MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.50MB 39.50MB 0.50MB
datadog-agent-amd64-deb 0.00MB 815.22MB 815.22MB 0.50MB
datadog-agent-arm64-deb 0.00MB 806.19MB 806.19MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.42MB 39.42MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.96MB 37.96MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 440.65MB 440.65MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.09MB 62.09MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.33MB 59.33MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 28, 2025

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 788.47MiB 801.8MiB 192.29MiB 202.62MiB
static_quality_gate_agent_deb_arm64 779.83MiB 793.14MiB 174.88MiB 184.51MiB
static_quality_gate_agent_rpm_amd64 788.46MiB 801.79MiB 194.32MiB 205.03MiB
static_quality_gate_agent_rpm_arm64 779.82MiB 793.09MiB 175.91MiB 186.44MiB
static_quality_gate_agent_suse_amd64 788.46MiB 801.81MiB 194.32MiB 205.03MiB
static_quality_gate_agent_suse_arm64 779.82MiB 793.14MiB 175.91MiB 186.44MiB
static_quality_gate_dogstatsd_deb_amd64 37.67MiB 47.67MiB 9.78MiB 19.78MiB
static_quality_gate_dogstatsd_deb_arm64 36.28MiB 46.27MiB 8.48MiB 18.49MiB
static_quality_gate_dogstatsd_rpm_amd64 37.67MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_dogstatsd_suse_amd64 37.67MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_iot_agent_deb_amd64 59.29MiB 69.0MiB 14.89MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.65MiB 66.4MiB 12.87MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.29MiB 69.0MiB 14.92MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.65MiB 66.4MiB 12.86MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.29MiB 69.0MiB 14.92MiB 24.8MiB
static_quality_gate_docker_agent_amd64 873.61MiB 886.12MiB 293.87MiB 304.21MiB
static_quality_gate_docker_agent_arm64 888.26MiB 900.79MiB 280.11MiB 290.47MiB
static_quality_gate_docker_agent_jmx_amd64 1.05GiB 1.06GiB 368.96MiB 379.33MiB
static_quality_gate_docker_agent_jmx_arm64 1.05GiB 1.06GiB 351.2MiB 361.55MiB
static_quality_gate_docker_dogstatsd_amd64 45.82MiB 55.78MiB 17.28MiB 27.28MiB
static_quality_gate_docker_dogstatsd_arm64 44.45MiB 54.45MiB 16.16MiB 26.16MiB
static_quality_gate_docker_cluster_agent_amd64 264.99MiB 274.78MiB 106.36MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.95MiB 290.82MiB 101.19MiB 111.12MiB

Copy link

cit-pr-commenter bot commented Feb 28, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 2ee186e8-0044-486d-84d5-da669e486f0f

Baseline: 734ced8
Comparison: d44dae0
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_idle memory utilization +0.46 [+0.42, +0.50] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.10 [-0.68, +0.88] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.07 [+0.01, +0.13] 1 Logs
quality_gate_idle_all_features memory utilization +0.02 [-0.05, +0.08] 1 Logs bounds checks dashboard
file_to_blackhole_100ms_latency egress throughput +0.01 [-0.67, +0.69] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.78, +0.80] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.30, +0.31] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.00 [-0.63, +0.63] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.02] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.00 [-0.48, +0.47] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.84, +0.82] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.79, +0.77] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.11 [-0.99, +0.76] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.52 [-1.30, +0.25] 1 Logs
file_tree memory utilization -0.53 [-0.59, -0.48] 1 Logs
quality_gate_logs % cpu utilization -0.84 [-3.72, +2.04] 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 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
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_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_idle, 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_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.

@tylfin tylfin force-pushed the tyler.finethy/DEBUG-3566-dwarf-refactor branch from 04f116b to d44dae0 Compare February 28, 2025 20:42
@tylfin tylfin closed this Mar 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/dynamic-instrumentation Dynamic Instrumentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant