Skip to content

Add labeled Python Agent telemetry bridge#53751

Draft
nubtron wants to merge 2 commits into
mainfrom
nubtron/ai-7012-coat-allowlist
Draft

Add labeled Python Agent telemetry bridge#53751
nubtron wants to merge 2 commits into
mainfrom
nubtron/ai-7012-coat-allowlist

Conversation

@nubtron

@nubtron nubtron commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

  • Add an additive datadog_agent.emit_agent_telemetry_with_labels(...) API through rtloader and the Go Python collector bridge while leaving the existing unlabeled API unchanged.
  • Validate deterministic fixed label schemas and use labeled counter, gauge, and histogram telemetry operations.
  • Add openmetrics.max_returned_metrics_reached to the existing Agent Telemetry checks profile, preserving only check_name.

Motivation

OpenMetrics checks can silently drop metric contexts after reaching max_returned_metrics. The companion integrations-core change emits one structured event per limiter warning. This Agent foundation carries the stable check name through Agent Telemetry so the signal can be monitored without adding endpoint or instance cardinality.

Describe how you validated your changes

  • dda inv test --targets=./pkg/collector/python
  • dda inv test --targets=./comp/core/agenttelemetry/impl
  • dda inv rtloader.test
  • dda inv linter.go --targets=./pkg/collector/python,./comp/core/agenttelemetry/impl
  • bazel run //:gazelle -- -mode=diff
  • Built the Agent and ran combined OpenMetrics v1/v2 smoke tests against the companion integrations-core source. Both produced a raw cumulative value of 1 and a filtered payload containing only check_name=openmetrics.

Additional Notes

@github-actions

Copy link
Copy Markdown
Contributor

@codex review

@github-actions

Copy link
Copy Markdown
Contributor

COAT metric reminder

This PR changes comp/core/agenttelemetry/impl/defaultProfiles.yaml, which reports metrics via Cross-Org Agent Telemetry (COAT). Per the COAT: Report a telemetry metric guide, please confirm before merging:

  • Validated the metric via e2e tests or a dev VM, and checked it appears correctly in ddcoat (see Observing telemetry — a ready-to-run VM command will be posted in a separate comment once this pipeline's build finishes)
  • Updated the public docs in DataDog/documentation
  • Filed a new tracking ticket on the ASUP Jira board using the template for the added metric(s): openmetrics.max_returned_metrics_reached
  • After merge: noted the target Agent release and will confirm GA before considering the metric live

Automated reminder — does not block merging. Updates automatically if this file changes again.

@dd-octo-sts dd-octo-sts Bot added the internal Identify a non-fork PR label Jul 16, 2026
@github-actions github-actions Bot added the long review PR is complex, plan time to review it label Jul 16, 2026
@dd-octo-sts

dd-octo-sts Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

COAT metric validation VM

The agent package for this pipeline is ready. Create a VM with that package installed using:

dda inv aws.create-vm --pipeline-id=125050872

Need Windows instead? Add --os-family=windows — but note Windows packages are only
built for this pipeline if it touched a Windows-related path, ran with
RUN_E2E_TESTS/DEPLOY_AGENT, or is on main/a release branch. If yours doesn't
qualify, no Windows build will ever exist for this pipeline id — push an unrelated
Windows-path change, or open a fresh pipeline with RUN_E2E_TESTS=on.

See Observing telemetry for how to find the metric once the agent is running.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6f6c09d539

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

double metric_value;
char *metric_type = NULL;
PyObject *labels = NULL;
if (!PyArg_ParseTuple(args, "ssdsO", &check_name, &metric_name, &metric_value, &metric_type, &labels)) {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Parse keyword arguments for labeled telemetry

When a Python integration calls the new datadog_agent.emit_agent_telemetry_with_labels method with keyword arguments, this parser ignores kwargs even though the method is registered with METH_KEYWORDS, so calls like emit_agent_telemetry_with_labels(check_name=..., labels=...) fail as if no positional args were provided, and extra/typoed keywords are silently ignored when five positional args are present. Use PyArg_ParseTupleAndKeywords with a kwlist, or register the method without METH_KEYWORDS so the exposed API matches the supported call style.

Useful? React with 👍 / 👎.

@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 84.80%
Overall Coverage: 51.90%

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 6f6c09d | Docs | Datadog PR Page | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Files inventory check summary

File checks results against ancestor aba12fbd:

Results for datadog-agent_7.83.0~devel.git.155.6f6c09d.pipeline.125050872-1_amd64.deb:

No change detected

@dd-octo-sts

dd-octo-sts Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor aba12fb
📊 Static Quality Gates Dashboard
🔗 SQG Job

Successful checks

Info

Quality gate Change Size (prev → curr → max)
agent_deb_amd64 +17.14 KiB (0.00% increase, -0.23% of buffer) 750.991 → 751.008 → 758.200
agent_deb_amd64_fips +13.14 KiB (0.00% increase, -0.32% of buffer) 705.880 → 705.893 → 709.840
agent_heroku_amd64 +17.14 KiB (0.01% increase, -0.22% of buffer) 307.701 → 307.718 → 315.230
agent_msi +13.16 KiB (0.00% increase, -0.12% of buffer) 645.658 → 645.670 → 656.640
agent_rpm_amd64 +17.14 KiB (0.00% increase, -0.23% of buffer) 750.975 → 750.992 → 758.170
agent_rpm_amd64_fips +13.14 KiB (0.00% increase, -0.32% of buffer) 705.864 → 705.877 → 709.840
agent_rpm_arm64 +13.17 KiB (0.00% increase, -0.36% of buffer) 726.060 → 726.073 → 729.660
agent_rpm_arm64_fips +13.17 KiB (0.00% increase, -0.30% of buffer) 684.634 → 684.647 → 688.860
agent_suse_amd64 +17.14 KiB (0.00% increase, -0.23% of buffer) 750.975 → 750.992 → 758.170
agent_suse_amd64_fips +13.14 KiB (0.00% increase, -0.32% of buffer) 705.864 → 705.877 → 709.840
agent_suse_arm64 +13.17 KiB (0.00% increase, -0.36% of buffer) 726.060 → 726.073 → 729.660
agent_suse_arm64_fips +13.17 KiB (0.00% increase, -0.30% of buffer) 684.634 → 684.647 → 688.860
docker_agent_amd64 +17.14 KiB (0.00% increase, -0.41% of buffer) 809.698 → 809.715 → 813.790
docker_agent_arm64 +13.17 KiB (0.00% increase, -0.25% of buffer) 809.787 → 809.800 → 815.030
docker_agent_jmx_amd64 +17.14 KiB (0.00% increase, -0.42% of buffer) 1000.595 → 1000.612 → 1004.550
docker_agent_jmx_arm64 +13.17 KiB (0.00% increase, -0.24% of buffer) 989.337 → 989.350 → 994.710
17 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
docker_cluster_agent_amd64 209.881 MiB
docker_cluster_agent_arm64 222.952 MiB
docker_cws_instrumentation_amd64 7.447 MiB
docker_cws_instrumentation_arm64 6.877 MiB
docker_dogstatsd_amd64 39.216 MiB
docker_dogstatsd_arm64 37.367 MiB
docker_host_profiler_amd64 303.100 MiB
docker_host_profiler_arm64 314.593 MiB
dogstatsd_deb_amd64 29.955 MiB
dogstatsd_deb_arm64 27.994 MiB
dogstatsd_rpm_amd64 29.955 MiB
dogstatsd_suse_amd64 29.955 MiB
iot_agent_deb_amd64 46.194 MiB
iot_agent_deb_arm64 42.882 MiB
iot_agent_deb_armhf 43.647 MiB
iot_agent_rpm_amd64 46.195 MiB
iot_agent_suse_amd64 46.194 MiB

@cit-pr-commenter-54b7da

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 37bff2b2-6ab2-4a99-a943-2da4694182b8

Baseline: aba12fb
Comparison: 6f6c09d
Diff

❌ Experiments with retried target crashes

This is a critical error. One or more replicates failed with a non-zero exit code. These replicates may have been retried. See Replicate Execution Details for more information.

  • quality_gate_idle_all_features

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_security_idle memory utilization +0.33 [+0.27, +0.39] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +0.18 [+0.12, +0.25] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization +0.04 [-0.06, +0.14] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.07 [-0.12, -0.01] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization -0.21 [-0.25, -0.18] 1 Logs bounds checks dashboard
quality_gate_metrics_logs memory utilization -0.58 [-0.83, -0.33] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -4.33 [-5.32, -3.34] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
quality_gate_idle intake_connections 10/10 3 ≤ 4 bounds checks dashboard
quality_gate_idle memory_usage 10/10 145.98MiB ≤ 154MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 732.29KiB ≤ 819.20KiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 3 ≤ 4 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 491.58MiB ≤ 495MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 1.12MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_logs memory_usage 10/10 183.91MiB ≤ 195MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_logs total_bytes_received 10/10 264.17MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 381.75 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 403.88MiB ≤ 430MiB bounds checks dashboard
quality_gate_metrics_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_metrics_logs total_bytes_received 10/10 0.94GiB ≤ 1.04GiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 30.88 ≤ 40 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 297.60MiB ≤ 330MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 64.45 ≤ 80 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 273.01MiB ≤ 310MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 23.54 ≤ 40 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 283.87MiB ≤ 320MiB 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".

Replicate Execution Details

We run multiple replicates for each experiment/variant. However, we allow replicates to be automatically retried if there are any failures, up to 8 times, at which point the replicate is marked dead and we are unable to run analysis for the entire experiment. We call each of these attempts at running replicates a replicate execution. This section lists all replicate executions that failed due to the target crashing or being oom killed.

Note: In the below tables we bucket failures by experiment, variant, and failure type. For each of these buckets we list out the replicate indexes that failed with an annotation signifying how many times said replicate failed with the given failure mode. In the below example the baseline variant of the experiment named experiment_with_failures had two replicates that failed by oom kills. Replicate 0, which failed 8 executions, and replicate 1 which failed 6 executions, all with the same failure mode.

Experiment Variant Replicates Failure Logs Debug Dashboard
experiment_with_failures baseline 0 (x8) 1 (x6) Oom killed Debug Dashboard

The debug dashboard links will take you to a debugging dashboard specifically designed to investigate replicate execution failures.

❌ Retried Normal Replicate Execution Failures (non-profiling)

Experiment Variant Replicates Failure Debug Dashboard
quality_gate_idle_all_features comparison 9 Oom killed Debug Dashboard

❌ Retried Profiling Replicate Execution Failures (ddprof)

Note: Profiling replicas may still be executing. See the debug dashboard for up to date status.

Experiment Variant Replicates Failure Debug Dashboard
quality_gate_idle baseline 10 Oom killed Debug Dashboard
quality_gate_idle comparison 10 Oom killed Debug Dashboard
quality_gate_idle_all_features baseline 10 Oom killed Debug Dashboard
quality_gate_idle_all_features comparison 10 Oom killed Debug Dashboard
quality_gate_logs baseline 10 Oom killed Debug Dashboard
quality_gate_logs comparison 10 Oom killed Debug Dashboard
quality_gate_metrics_logs baseline 10 Oom killed Debug Dashboard
quality_gate_metrics_logs comparison 10 Oom killed Debug Dashboard
quality_gate_security_idle baseline 10 Oom killed Debug Dashboard
quality_gate_security_idle comparison 10 Oom killed Debug Dashboard
quality_gate_security_mean_fs_load baseline 10 Crashed (exit code: 134) Debug Dashboard
quality_gate_security_mean_fs_load comparison 10 Oom killed Debug Dashboard
quality_gate_security_no_fs_load baseline 10 Oom killed Debug Dashboard
quality_gate_security_no_fs_load comparison 10 Oom killed Debug Dashboard

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check cpu_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 total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 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 missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check total_bytes_received: 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 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_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant