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

Read 'datadog.' namespaced fields when mapping OTLP->DD span #33753

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

Conversation

IbraheemA
Copy link
Contributor

@IbraheemA IbraheemA commented Feb 5, 2025

What does this PR do?

Link to RFC

Link to the datadogsemanticsprocessor PR

We will be introducing a component datadogsemanticsprocessor into the OpenTelemetry collector. That component takes in an OTLP record, computes the fields that will be used to construct the corresponding DD record, and puts said fields in the OTLP record's attributes under the datadog. namespace.

This PR adds the functionality to construct a DD span from datadog. attributes on an incoming span. By default, look for a span attribute starting with datadog.; if it's present, it's used to compute the corresponding datadog field (e.g., datadog.service is used to set ddspan.Service). It will override other sources of the same field (e.g., if both datadog.service and service.name are present, datadog.service is used).

By default, if a field is missing, it will be recomputed (e.g., if there's no datadog.env, look for env in deployment.environment). However, if the config option IgnoreMissingDatadogFields is specified, then the field will not be recomputed. This option is given so that users can explicitly specify blank fields if they like (e.g. specify that datadog.env = "").

Describe how you validated your changes

Added 2 test cases - one where every field is populated from datadog. attributes, and one where there are no datadog. attributes, and the fields could be recomputed, but IgnoreMissingDatadogFields is specified so they are not.

Also, sent traces from the datadogsemanticsprocessor (not published yet, running locally) to the agent and validated that fields are populated correctly E2E.

Possible Drawbacks / Trade-offs

NOTE: in refactoring the code to incorporate the new changes, I introduced a breaking change:

Previously, the code was written so that if both http.response.status_code and http.status_code were present in the span attributes, the former was preferred over the latter; this was to enforce the new OTLP semantic convention, since the former was added in a later version. I decided that we've given people enough time to migrate to the new convention, and prefer cleaner code over preserving that corner case. I removed the test cases related to that case (similar for http.method)

@IbraheemA IbraheemA requested review from a team as code owners February 5, 2025 16:40
@github-actions github-actions bot added team/agent-apm trace-agent long review PR is complex, plan time to review it labels Feb 5, 2025
@IbraheemA IbraheemA force-pushed the ibraheem/use-dd-namespaced-fields-in-otlp-receiver branch from 36cdaff to 642bd1f Compare February 5, 2025 16:43
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

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

Left some minor suggestions from Docs and approved the PR.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 5, 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 812.93MiB 847.49MiB 196.89MiB 212.33MiB
static_quality_gate_agent_deb_arm64 803.48MiB 836.66MiB 177.25MiB 192.5MiB
static_quality_gate_agent_rpm_amd64 812.85MiB 847.82MiB 199.25MiB 215.76MiB
static_quality_gate_agent_rpm_arm64 803.45MiB 836.66MiB 180.85MiB 194.24MiB
static_quality_gate_agent_suse_amd64 812.91MiB 847.82MiB 199.25MiB 215.76MiB
static_quality_gate_agent_suse_arm64 803.46MiB 836.66MiB 180.85MiB 194.24MiB
static_quality_gate_dogstatsd_deb_amd64 37.67MiB 49.7MiB 9.78MiB 20.6MiB
static_quality_gate_dogstatsd_deb_arm64 36.27MiB 48.1MiB 8.48MiB 19.1MiB
static_quality_gate_dogstatsd_rpm_amd64 37.67MiB 49.7MiB 9.79MiB 20.6MiB
static_quality_gate_dogstatsd_suse_amd64 37.67MiB 49.7MiB 9.79MiB 20.6MiB
static_quality_gate_iot_agent_deb_amd64 59.23MiB 69.0MiB 14.88MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.59MiB 66.4MiB 12.86MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.22MiB 69.0MiB 14.9MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.6MiB 66.4MiB 12.85MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.22MiB 69.0MiB 14.9MiB 24.8MiB
static_quality_gate_docker_agent_amd64 897.28MiB 931.7MiB 300.91MiB 318.67MiB
static_quality_gate_docker_agent_arm64 911.1MiB 944.08MiB 286.43MiB 303.0MiB
static_quality_gate_docker_agent_jmx_amd64 1.07GiB 1.1GiB 376.0MiB 393.75MiB
static_quality_gate_docker_agent_jmx_arm64 1.07GiB 1.1GiB 357.49MiB 373.71MiB
static_quality_gate_docker_dogstatsd_amd64 45.81MiB 57.88MiB 17.28MiB 28.29MiB
static_quality_gate_docker_dogstatsd_arm64 44.45MiB 56.27MiB 16.16MiB 27.06MiB
static_quality_gate_docker_cluster_agent_amd64 264.95MiB 274.78MiB 106.34MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.91MiB 290.82MiB 101.19MiB 111.12MiB

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 5, 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=56819706 --os-family=ubuntu

Note: This applies to commit 411c55f

@agent-platform-auto-pr
Copy link
Contributor

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

Uncompressed package size comparison

Comparison with ancestor 526645bb889d540d8ce7a39fb6cc932b8ea58ca6

Diff per package
package diff status size ancestor threshold
datadog-heroku-agent-amd64-deb 0.01MB ⚠️ 443.29MB 443.28MB 0.50MB
datadog-agent-arm64-deb 0.01MB ⚠️ 830.17MB 830.17MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 839.92MB 839.92MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 849.84MB 849.83MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 849.84MB 849.83MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.33MB 59.33MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.27MB 59.26MB 0.50MB
datadog-agent-amd64-deb 0.00MB 840.07MB 840.07MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.42MB 39.42MB 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-dogstatsd-arm64-deb 0.00MB 37.96MB 37.96MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.02MB 62.02MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.09MB 62.09MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.09MB 62.09MB 0.50MB

Decision

⚠️ Warning

@IbraheemA IbraheemA added the qa/done QA done before merge and regressions are covered by tests label Feb 5, 2025
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

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

Left a couple of suggestions on the release notes and approved the PR.

Copy link

cit-pr-commenter bot commented Feb 5, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 7d8a564e-0b6f-4821-aa99-efa607ed6c0d

Baseline: 526645b
Comparison: 411c55f
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +2.42 [+1.50, +3.34] 1 Logs
quality_gate_idle memory utilization +0.59 [+0.55, +0.63] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.09 [-0.70, +0.89] 1 Logs
file_tree memory utilization +0.08 [+0.02, +0.14] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.04 [-0.43, +0.51] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.03 [-0.76, +0.81] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.82, +0.85] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.01 [-0.69, +0.71] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.62, +0.64] 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.30, +0.30] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.77, +0.75] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.49 [-0.55, -0.43] 1 Logs
quality_gate_idle_all_features memory utilization -0.60 [-0.66, -0.55] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput -1.27 [-2.05, -0.49] 1 Logs
quality_gate_logs % cpu utilization -2.13 [-5.03, +0.76] 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 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, 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.

@IbraheemA IbraheemA force-pushed the ibraheem/use-dd-namespaced-fields-in-otlp-receiver branch from 66a38a6 to aa052df Compare February 24, 2025 20:50
@agent-platform-auto-pr
Copy link
Contributor

Static quality checks ❌

Please find below the results from static quality gates

Error

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_suse_arm64 DataNotFound 836.66MiB DataNotFound 194.24MiB
Gate failure full details
Quality gate Error type Error message
static_quality_gate_agent_suse_arm64 StackTrace Traceback (most recent call last):
File "/go/src/github.com/DataDog/datadog-agent/tasks/quality_gates.py", line 121, in parse_and_trigger_gates
gate_mod.entrypoint(**gate_inputs)
File "/go/src/github.com/DataDog/datadog-agent/tasks/static_quality_gates/static_quality_gate_agent_suse_arm64.py", line 5, in entrypoint
generic_package_agent_quality_gate(
File "/go/src/github.com/DataDog/datadog-agent/tasks/static_quality_gates/lib/package_agent_lib.py", line 69, in generic_package_agent_quality_gate
package_on_wire_size, package_on_disk_size = calculate_package_size(
^^^^^^^^^^^^^^^^^^^^^^^
File "/go/src/github.com/DataDog/datadog-agent/tasks/static_quality_gates/lib/package_agent_lib.py", line 10, in calculate_package_size
extract_package(ctx=ctx, package_os=package_os, package_path=package_path, extract_dir=extract_dir)
File "/go/src/github.com/DataDog/datadog-agent/tasks/libs/package/size.py", line 72, in extract_package
return extract_rpm_package(ctx, package_path, extract_dir)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/go/src/github.com/DataDog/datadog-agent/tasks/libs/package/size.py", line 65, in extract_rpm_package
ctx.run(f"rpm2cpio {package_path}
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 812.97MiB 847.49MiB 196.9MiB 212.33MiB
static_quality_gate_agent_deb_arm64 803.4MiB 836.66MiB 177.79MiB 192.5MiB
static_quality_gate_agent_rpm_amd64 812.95MiB 847.82MiB 199.29MiB 215.76MiB
static_quality_gate_agent_rpm_arm64 803.41MiB 836.66MiB 180.85MiB 194.24MiB
static_quality_gate_agent_suse_amd64 812.97MiB 847.82MiB 199.29MiB 215.76MiB
static_quality_gate_dogstatsd_deb_amd64 37.67MiB 49.7MiB 9.78MiB 20.6MiB
static_quality_gate_dogstatsd_deb_arm64 36.27MiB 48.1MiB 8.49MiB 19.1MiB
static_quality_gate_dogstatsd_rpm_amd64 37.67MiB 49.7MiB 9.79MiB 20.6MiB
static_quality_gate_dogstatsd_suse_amd64 37.67MiB 49.7MiB 9.79MiB 20.6MiB
static_quality_gate_iot_agent_deb_amd64 59.23MiB 69.0MiB 14.88MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.59MiB 66.4MiB 12.82MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.23MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.6MiB 66.4MiB 12.85MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.23MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_docker_agent_amd64 897.28MiB 931.7MiB 300.92MiB 318.67MiB
static_quality_gate_docker_agent_arm64 911.1MiB 944.08MiB 286.42MiB 303.0MiB
static_quality_gate_docker_agent_jmx_amd64 1.07GiB 1.1GiB 376.0MiB 393.75MiB
static_quality_gate_docker_agent_jmx_arm64 1.07GiB 1.1GiB 357.49MiB 373.71MiB
static_quality_gate_docker_dogstatsd_amd64 45.81MiB 57.88MiB 17.28MiB 28.29MiB
static_quality_gate_docker_dogstatsd_arm64 44.45MiB 56.27MiB 16.16MiB 27.06MiB
static_quality_gate_docker_cluster_agent_amd64 264.95MiB 274.78MiB 106.34MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.91MiB 290.82MiB 101.19MiB 111.12MiB

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-apm trace-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants