Skip to content

[AGENTRUN-866] Add ability to run Rust-based checks through shared libraries#39676

Merged
dd-mergequeue[bot] merged 144 commits intomainfrom
maxime.chambre/shared-library-check-cgo
Dec 12, 2025
Merged

[AGENTRUN-866] Add ability to run Rust-based checks through shared libraries#39676
dd-mergequeue[bot] merged 144 commits intomainfrom
maxime.chambre/shared-library-check-cgo

Conversation

@Enzu83
Copy link
Copy Markdown
Contributor

@Enzu83 Enzu83 commented Aug 8, 2025

What does this PR do?

⚠️ This new feature is experimental ⚠️

This PR introduces a new way of running checks, through shared libraries. They are Rust-based and loaded at runtime by a new checks loader. You can read the documentation here.

The Rust-based checks API is minimal for now, only the submit functions are available. The API can be expanded quite easily by adding new fields to the C structure aggregator_t.

Also, this PR moves the Go submit functions (like SubmitMetric) from the collector Python package to a new package (named aggregator). That way both Python and shared library checks can use callbacks from this package. These Go submit functions were in the Python package just because Python checks were the only ones using them, but their scope are larger than just Python checks

Motivation

Provide a new way of writing checks to improve Agent performances and to rely a bit less on the Python runtime.

Describe how you validated your changes

Few unit tests to test the new checks loader and the shared library checks implementation (for the Go part).
An e2e test for Linux and Windows to load and run a simple shared library check that submits one metric.

Possible Drawbacks / Trade-offs

Additional Notes

The Rust part of this feature (where shared libraries are compiled from) is on this PR:

@github-actions github-actions Bot added team/agent-runtimes long review PR is complex, plan time to review it labels Aug 8, 2025
@cit-pr-commenter
Copy link
Copy Markdown

cit-pr-commenter Bot commented Aug 8, 2025

Go Package Import Differences

Baseline: bb81be1
Comparison: e2db1e9

binaryosarchchange
agentlinuxamd64
+3, -0
+github.com/DataDog/datadog-agent/pkg/collector/aggregator
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/ffi
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
agentlinuxarm64
+3, -0
+github.com/DataDog/datadog-agent/pkg/collector/aggregator
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/ffi
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
agentwindowsamd64
+3, -0
+github.com/DataDog/datadog-agent/pkg/collector/aggregator
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/ffi
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
agentdarwinamd64
+3, -0
+github.com/DataDog/datadog-agent/pkg/collector/aggregator
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/ffi
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
agentdarwinarm64
+3, -0
+github.com/DataDog/datadog-agent/pkg/collector/aggregator
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/ffi
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
iot-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
iot-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
heroku-agentlinuxamd64
+3, -0
+github.com/DataDog/datadog-agent/pkg/collector/aggregator
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/ffi
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
cluster-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
cluster-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
cluster-agent-cloudfoundrylinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl
cluster-agent-cloudfoundrylinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/sharedlibrary/sharedlibraryimpl

@cit-pr-commenter
Copy link
Copy Markdown

cit-pr-commenter Bot commented Aug 8, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 86ea05d1-581d-49b3-b5f2-0b03c1d3be9f

Baseline: bb81be1
Comparison: e2db1e9
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization -1.63 [-4.68, +1.42] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
ddot_metrics_sum_delta memory utilization +0.83 [+0.62, +1.05] 1 Logs
otlp_ingest_logs memory utilization +0.79 [+0.68, +0.90] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.71 [+0.63, +0.79] 1 Logs
file_tree memory utilization +0.58 [+0.52, +0.64] 1 Logs
docker_containers_memory memory utilization +0.24 [+0.17, +0.32] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.21 [+0.15, +0.26] 1 Logs
ddot_metrics_sum_cumulative memory utilization +0.13 [-0.03, +0.29] 1 Logs
quality_gate_idle_all_features memory utilization +0.10 [+0.06, +0.14] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization +0.04 [-0.00, +0.08] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency egress throughput +0.04 [-0.35, +0.43] 1 Logs
uds_dogstatsd_to_api_v3 ingress throughput +0.01 [-0.11, +0.14] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.07, +0.08] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.00 [-0.41, +0.41] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.14, +0.13] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.06, +0.04] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.05 [-0.42, +0.32] 1 Logs
otlp_ingest_metrics memory utilization -0.08 [-0.23, +0.08] 1 Logs
ddot_metrics memory utilization -0.11 [-0.31, +0.10] 1 Logs
ddot_metrics_sum_cumulativetodelta_exporter memory utilization -0.25 [-0.48, -0.02] 1 Logs
quality_gate_logs % cpu utilization -0.29 [-1.77, +1.20] 1 Logs bounds checks dashboard
quality_gate_metrics_logs memory utilization -0.63 [-0.83, -0.43] 1 Logs bounds checks dashboard
ddot_logs memory utilization -0.64 [-0.71, -0.58] 1 Logs
docker_containers_cpu % cpu utilization -1.63 [-4.68, +1.42] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
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_1000ms_latency lost_bytes 10/10
file_to_blackhole_1000ms_latency 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_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
quality_gate_logs memory_usage 10/10 bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 bounds checks dashboard
quality_gate_metrics_logs lost_bytes 10/10 bounds checks dashboard
quality_gate_metrics_logs memory_usage 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

Passed. All Quality Gates passed.

  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 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: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 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_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.

@agent-platform-auto-pr
Copy link
Copy Markdown
Contributor

agent-platform-auto-pr Bot commented Aug 11, 2025

Static quality checks

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

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${+0.03}$$ $${705.43}$$ < $${706.32}$$ $${+0.06}$$ $${172.89}$$ < $${173.81}$$
agent_deb_amd64_fips $${+0.03}$$ $${700.77}$$ < $${701.16}$$ $${-0.07}$$ $${171.79}$$ < $${172.71}$$
agent_heroku_amd64 $${+0.03}$$ $${327.24}$$ < $${327.69}$$ $${-0.01}$$ $${87.23}$$ < $${88.19}$$
agent_msi $${+0.11}$$ $${979.94}$$ < $${982.08}$$ $${+0.02}$$ $${141.75}$$ < $${143.01}$$
agent_rpm_amd64 $${+0.03}$$ $${705.42}$$ < $${706.31}$$ $${+0.01}$$ $${175.92}$$ < $${176.86}$$
agent_rpm_amd64_fips $${+0.03}$$ $${700.76}$$ < $${701.15}$$ $${+0.01}$$ $${173.95}$$ < $${174.95}$$
agent_rpm_arm64 $${+0.04}$$ $${691.09}$$ < $${691.67}$$ $${-0.04}$$ $${159.65}$$ < $${160.7}$$
agent_rpm_arm64_fips $${+0.03}$$ $${687.31}$$ < $${687.54}$$ $${+0.1}$$ $${159.23}$$ < $${160.1}$$
agent_suse_amd64 $${+0.03}$$ $${705.42}$$ < $${706.31}$$ $${+0.01}$$ $${175.92}$$ < $${176.86}$$
agent_suse_amd64_fips $${+0.03}$$ $${700.76}$$ < $${701.15}$$ $${+0.01}$$ $${173.95}$$ < $${174.95}$$
agent_suse_arm64 $${+0.04}$$ $${691.09}$$ < $${691.67}$$ $${-0.04}$$ $${159.65}$$ < $${160.7}$$
agent_suse_arm64_fips $${+0.03}$$ $${687.31}$$ < $${687.54}$$ $${+0.1}$$ $${159.23}$$ < $${160.1}$$
docker_agent_amd64 $${+0.03}$$ $${767.76}$$ < $${768.66}$$ $${-0.01}$$ $${260.61}$$ < $${261.52}$$
docker_agent_arm64 $${+0.04}$$ $${777.71}$$ < $${778.35}$$ $${+0}$$ $${250.79}$$ < $${251.72}$$
docker_agent_jmx_amd64 $${+0.03}$$ $${958.64}$$ < $${959.54}$$ $${+0}$$ $${329.24}$$ < $${330.15}$$
docker_agent_jmx_arm64 $${+0.04}$$ $${957.31}$$ < $${957.95}$$ $${+0}$$ $${315.41}$$ < $${316.35}$$
docker_cluster_agent_amd64 $${+0}$$ $${179.09}$$ < $${179.28}$$ $${-0}$$ $${63.24}$$ < $${63.96}$$
docker_cluster_agent_arm64 $${-0}$$ $${196.58}$$ < $${196.79}$$ $${-0}$$ $${59.96}$$ < $${60.69}$$
docker_cws_instrumentation_amd64 $${0}$$ $${7.07}$$ < $${7.12}$$ $${+0}$$ $${2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${+0}$$ $${6.69}$$ < $${6.92}$$ $${+0}$$ $${2.71}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${0}$$ $${38.65}$$ < $${39.3}$$ $${+0}$$ $${14.92}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${0}$$ $${37.3}$$ < $${37.94}$$ $${-0}$$ $${14.37}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${0}$$ $${29.86}$$ < $${30.53}$$ $${+0}$$ $${7.87}$$ < $${8.75}$$
dogstatsd_deb_arm64 $${0}$$ $${28.38}$$ < $${29.11}$$ $${+0}$$ $${6.81}$$ < $${7.71}$$
dogstatsd_rpm_amd64 $${0}$$ $${29.86}$$ < $${30.53}$$ $${+0}$$ $${7.88}$$ < $${8.76}$$
dogstatsd_suse_amd64 $${0}$$ $${29.86}$$ < $${30.53}$$ $${+0}$$ $${7.88}$$ < $${8.76}$$
iot_agent_deb_amd64 $${0}$$ $${42.6}$$ < $${43.19}$$ $${+0}$$ $${11.12}$$ < $${11.98}$$
iot_agent_deb_arm64 $${0}$$ $${40.33}$$ < $${40.92}$$ $${-0}$$ $${9.58}$$ < $${10.45}$$
iot_agent_deb_armhf $${0}$$ $${40.24}$$ < $${40.86}$$ $${-0}$$ $${9.69}$$ < $${10.56}$$
iot_agent_rpm_amd64 $${0}$$ $${42.6}$$ < $${43.19}$$ $${-0}$$ $${11.14}$$ < $${12.0}$$
iot_agent_suse_amd64 $${0}$$ $${42.6}$$ < $${43.19}$$ $${-0}$$ $${11.14}$$ < $${12.0}$$

@Enzu83 Enzu83 changed the title [AGENTRUN-613] Running shared libraries check using Cgo Running shared libraries checks with Cgo Aug 13, 2025
@pgimalac pgimalac removed the request for review from fabbing November 14, 2025 15:44
@Enzu83 Enzu83 requested a review from pgimalac December 3, 2025 16:47
Copy link
Copy Markdown
Contributor

@aiuto aiuto left a comment

Choose a reason for hiding this comment

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

For agent-build

Copy link
Copy Markdown
Member

@pgimalac pgimalac left a comment

Choose a reason for hiding this comment

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

LGTM, mostly nitpicks !
Checking in the dll and so files for the e2e test is not great though, we should look for a workaround.

Comment thread pkg/collector/aggregator/inter.go
Comment thread pkg/collector/aggregator/check_context.go Outdated
Comment thread pkg/collector/aggregator/check_context.go Outdated
Comment thread pkg/collector/aggregator/helpers.go
Comment thread pkg/collector/sharedlibrary/sharedlibraryimpl/loader.go Outdated
Comment thread test/new-e2e/tests/agent-runtimes/checks/shared-library/common.go Outdated
@Enzu83
Copy link
Copy Markdown
Contributor Author

Enzu83 commented Dec 12, 2025

/merge

@dd-devflow-routing-codex
Copy link
Copy Markdown

dd-devflow-routing-codex Bot commented Dec 12, 2025

View all feedbacks in Devflow UI.

2025-12-12 12:16:23 UTC ℹ️ Start processing command /merge


2025-12-12 12:16:28 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in main is approximately 41m (p90).


2025-12-12 13:09:06 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue Bot merged commit 1b0b2b3 into main Dec 12, 2025
292 checks passed
@dd-mergequeue dd-mergequeue Bot deleted the maxime.chambre/shared-library-check-cgo branch December 12, 2025 13:09
@github-actions github-actions Bot added this to the 7.75.0 milestone Dec 12, 2025
gh-worker-dd-mergequeue-cf854d Bot pushed a commit that referenced this pull request Mar 6, 2026
…ample check (#45815)

### What does this PR do?

This PR adds the core part of Rust-based checks and an example of a Rust-based shared library check.

The core part acts as the glue code between the check implementation in Rust and the Agent (Running the check, passing configuration, sending metrics...). Each check includes the core part in their implementation.

### Motivation

Provide the source code for shared library checks used by the shared library loader implemented in:
- #39676

### Describe how you validated your changes

- Compile the example check (package `example`) and have it loaded, scheduled and run by the Agent.
- Verify that the metrics, service checks and events are correctly sent to the backend. 
They are defined in `pkg/collector/sharedlibrary/rustchecks/checks/example/src/check.rs`

### Additional Notes

This code isn't used in the build or in any jobs, it's put here to experiment with Rust-based shared library checks.

Co-authored-by: maxime.chambre <maxime.chambre@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/no-changelog No changelog entry needed long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-runtimes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants