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

[AGENTRUN-40] add dependency audit for all binaries and flavors #35116

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

Conversation

GustavoCaso
Copy link
Member

@GustavoCaso GustavoCaso commented Mar 14, 2025

What does this PR do?

This PR introduces an audit check at CI for dependencies for all the binaries, expect serverless.

Our codebase is complex and many packages are used by many binaries that have being the cause of numerous issues with regards of binary size and RSS utilization.

Currently, we have a few checks SMP and the package compression. Also, we have the import diff GH comment. None of those checks forces the creator of the PR nor the owner of the binary to reflect on a change that adds a new package to the binary, no it blocks CI.

The inv -e go-deps.test-dependency-list blocks CI if a new package is added or removed, it adds enough friction that requires a codewoner reviewing the change. With the hopes that of the addition is not desire it would start a conversation to figure out the best path forward. In the case of a deletion running the inv -e go-deps.generate-dependency-list task would update all the relevant files.

Another useful usage is that we have a single place to look for what is included in the final binary (dependencies_*.text) files. That way if we are investigating a particular binary to reduce its overhead, we can start by looking at the dependency file and look for outliers.

This check is far from perfect, and there is room for improvement, but I think is a nice step in the right direction. I'm open to suggestion and feedback.

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 14, 2025

Gitlab CI Configuration Changes

Added Jobs

golang_deps_test
golang_deps_test:
  before_script:
  - source /root/.bashrc
  - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache.tar.xz -C $GOPATH/pkg/mod/cache
    || exit 101
  - rm -f modcache.tar.xz
  image: registry.ddbuild.io/ci/datadog-agent-buildimages/deb_x64$DATADOG_AGENT_BUILDIMAGES_SUFFIX:$DATADOG_AGENT_BUILDIMAGES
  needs:
  - go_deps
  rules:
  - when: on_success
  script:
  - inv -e go-deps.test-dependency-list
  stage: source_test
  tags:
  - arch:amd64

Changes Summary

Removed Modified Added Renamed
0 0 1 0

ℹ️ Diff available in the job log.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 14, 2025

Uncompressed package size comparison

Comparison with ancestor 1a4e43dd588520ec34e9a5b648ce84e1153a9b23

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 808.79MB 808.79MB 0.50MB
datadog-agent-arm64-deb 0.00MB 799.78MB 799.78MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 818.58MB 818.58MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 818.58MB 818.58MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 809.56MB 809.56MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.33MB 39.33MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.41MB 39.41MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.41MB 39.41MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.86MB 37.86MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 441.27MB 441.27MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.19MB 62.19MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.26MB 62.26MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.26MB 62.26MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.42MB 59.42MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.49MB 59.49MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 14, 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 782.34 MiB 801.8 MiB 190.95 MiB 202.62 MiB
static_quality_gate_agent_deb_arm64 773.73 MiB 793.14 MiB 172.9 MiB 184.51 MiB
static_quality_gate_agent_rpm_amd64 782.33 MiB 801.79 MiB 193.27 MiB 205.03 MiB
static_quality_gate_agent_rpm_arm64 773.72 MiB 793.09 MiB 174.86 MiB 186.44 MiB
static_quality_gate_agent_suse_amd64 782.33 MiB 801.81 MiB 193.27 MiB 205.03 MiB
static_quality_gate_agent_suse_arm64 773.72 MiB 793.14 MiB 174.86 MiB 186.44 MiB
static_quality_gate_dogstatsd_deb_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.78 MiB
static_quality_gate_dogstatsd_deb_arm64 36.18 MiB 46.27 MiB 8.45 MiB 18.49 MiB
static_quality_gate_dogstatsd_rpm_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_dogstatsd_suse_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_iot_agent_deb_amd64 59.38 MiB 69.0 MiB 14.92 MiB 24.8 MiB
static_quality_gate_iot_agent_deb_arm64 56.74 MiB 66.4 MiB 12.88 MiB 22.8 MiB
static_quality_gate_iot_agent_rpm_amd64 59.38 MiB 69.0 MiB 14.94 MiB 24.8 MiB
static_quality_gate_iot_agent_rpm_arm64 56.74 MiB 66.4 MiB 12.88 MiB 22.8 MiB
static_quality_gate_iot_agent_suse_amd64 59.38 MiB 69.0 MiB 14.94 MiB 24.8 MiB
static_quality_gate_docker_agent_amd64 867.47 MiB 886.12 MiB 291.72 MiB 304.21 MiB
static_quality_gate_docker_agent_arm64 882.14 MiB 900.79 MiB 278.12 MiB 290.47 MiB
static_quality_gate_docker_agent_jmx_amd64 1.04 GiB 1.06 GiB 366.82 MiB 379.33 MiB
static_quality_gate_docker_agent_jmx_arm64 1.04 GiB 1.06 GiB 349.2 MiB 361.55 MiB
static_quality_gate_docker_dogstatsd_amd64 45.73 MiB 55.78 MiB 17.25 MiB 27.28 MiB
static_quality_gate_docker_dogstatsd_arm64 44.36 MiB 54.45 MiB 16.12 MiB 26.16 MiB
static_quality_gate_docker_cluster_agent_amd64 264.87 MiB 274.78 MiB 106.3 MiB 116.28 MiB
static_quality_gate_docker_cluster_agent_arm64 280.81 MiB 290.82 MiB 101.13 MiB 111.12 MiB

Copy link

cit-pr-commenter bot commented Mar 14, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 53fc006a-fbb7-4697-ba8c-47846f9011e6

Baseline: 1a4e43d
Comparison: ee71f37
Diff

Optimization Goals: ✅ Improvement(s) detected

perf experiment goal Δ mean % Δ mean % CI trials links
file_tree memory utilization -9.44 [-9.61, -9.28] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +2.90 [+2.01, +3.79] 1 Logs
quality_gate_logs % cpu utilization +2.41 [-0.48, +5.29] 1 Logs
quality_gate_idle memory utilization +1.45 [+1.38, +1.52] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +1.41 [+1.28, +1.54] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput +0.68 [+0.63, +0.74] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.39 [-0.08, +0.85] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.87, +0.89] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.02, +0.03] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.31, +0.30] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.78, +0.77] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.84, +0.82] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.70, +0.68] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.01 [-0.64, +0.62] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.02 [-0.80, +0.77] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.07 [-0.85, +0.71] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.34 [-0.39, -0.29] 1 Logs
file_tree memory utilization -9.44 [-9.61, -9.28] 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_logs, bounds check intake_connections: 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_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.

@GustavoCaso GustavoCaso force-pushed the check-binary-dependencies-for-all-binaries branch from c7af764 to 529ad85 Compare March 14, 2025 11:31
@GustavoCaso GustavoCaso changed the title add dependency check for all binaries and flavors [AGENTRUN-40] add dependency check for all binaries and flavors Mar 14, 2025
@GustavoCaso GustavoCaso added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Mar 14, 2025
@GustavoCaso GustavoCaso changed the title [AGENTRUN-40] add dependency check for all binaries and flavors [AGENTRUN-40] add dependency audit for all binaries and flavors Mar 14, 2025
@GustavoCaso GustavoCaso marked this pull request as ready for review March 14, 2025 13:15
@GustavoCaso GustavoCaso requested review from a team as code owners March 14, 2025 13:15
@GustavoCaso GustavoCaso requested a review from hush-hush March 14, 2025 13:15
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 long review PR is complex, plan time to review it qa/no-code-change No code change in Agent code requiring validation team/agent-configuration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant