Skip to content

APM: Add top level support for span events (AIDM-403) #32479

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

Merged
merged 8 commits into from
Jan 10, 2025

Conversation

ajgajg1134
Copy link
Contributor

@ajgajg1134 ajgajg1134 commented Dec 23, 2024

What does this PR do?

Adds span events to the proto and message pack data formats for a span. Tracers can detect support for this new feature via the /info endpoint and new field span_events which will be set to true. See RFC for more details.

Motivation

This allows us to properly handle span events with a fully typed field, deprecating previous work-around methods that had issues related to tag size limits.

Additionally this change treats these span events more consistently: e.g. Span Event attributes will have replace_tags configuration applied to them, have stacktraces removed (when enabled), and have possible credit cards obfuscated (when enabled)

Describe how you validated your changes

I have unit and integration tests here that verify the support of span events

Possible Drawbacks / Trade-offs

To maintain consistency with how stack trace obfuscation is enabled today this change also introduces a minor change to obfuscation outside of span events: The tag exception.stacktrace will now also be redacted when apm_config.obfuscation.remove_stack_traces is set to true.

Additional Notes

@github-actions github-actions bot added team/agent-apm trace-agent long review PR is complex, plan time to review it labels Dec 23, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 23, 2024

Uncompressed package size comparison

Comparison with ancestor 16238ca336fe0d640e5691830d08090cae506f3f

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.27MB ⚠️ 1013.05MB 1012.78MB 0.50MB
datadog-agent-x86_64-rpm 0.27MB ⚠️ 1022.37MB 1022.10MB 0.50MB
datadog-agent-x86_64-suse 0.27MB ⚠️ 1022.37MB 1022.10MB 0.50MB
datadog-heroku-agent-amd64-deb 0.25MB ⚠️ 506.82MB 506.57MB 0.50MB
datadog-agent-aarch64-rpm 0.25MB ⚠️ 951.49MB 951.24MB 0.50MB
datadog-agent-arm64-deb 0.24MB ⚠️ 942.19MB 941.95MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.12MB ⚠️ 114.19MB 114.08MB 0.50MB
datadog-iot-agent-x86_64-suse 0.12MB ⚠️ 114.19MB 114.08MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.12MB ⚠️ 109.62MB 109.51MB 0.50MB
datadog-iot-agent-amd64-deb 0.12MB ⚠️ 114.12MB 114.01MB 0.50MB
datadog-iot-agent-arm64-deb 0.12MB ⚠️ 109.55MB 109.44MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 58.83MB 58.83MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 58.90MB 58.90MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 58.90MB 58.90MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.33MB 56.33MB 0.50MB

Decision

⚠️ Warning

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 23, 2024

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

Note: This applies to commit 53336ad

@ajgajg1134 ajgajg1134 marked this pull request as ready for review January 9, 2025 19:08
@ajgajg1134 ajgajg1134 requested review from a team as code owners January 9, 2025 19:08
@ajgajg1134 ajgajg1134 changed the title APM: Add top level support for span events APM: Add top level support for span events (AIDM-403) Jan 9, 2025
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 2f13786b-976b-442d-906d-2902f48b6b88

Baseline: 16238ca
Comparison: 53336ad
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 +1.72 [+1.03, +2.41] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.72 [+0.60, +0.84] 1 Logs
file_tree memory utilization +0.48 [+0.34, +0.62] 1 Logs
quality_gate_idle_all_features memory utilization +0.40 [+0.31, +0.49] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization +0.18 [+0.14, +0.22] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http2 egress throughput +0.08 [-0.78, +0.95] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.08 [-0.38, +0.55] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.05 [-0.73, +0.84] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.62, +0.65] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.01 [-0.76, +0.78] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.12, +0.13] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.73, +0.67] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.08 [-0.82, +0.66] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.13 [-0.93, +0.67] 1 Logs
quality_gate_logs % cpu utilization -4.53 [-7.69, -1.37] 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 memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
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 lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 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 memory_usage: 10/10 replicas passed. Gate passed.

@ajgajg1134 ajgajg1134 added the qa/done QA done before merge and regressions are covered by tests label Jan 9, 2025
Copy link
Contributor

@ichinaski ichinaski left a comment

Choose a reason for hiding this comment

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

LGTM

@ajgajg1134
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 10, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-10 13:39:45 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2025-01-10 14:15:06 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit ed755e5 into main Jan 10, 2025
238 of 239 checks passed
@dd-mergequeue dd-mergequeue bot deleted the andrew.glaude/spanEvents branch January 10, 2025 14:15
@github-actions github-actions bot added this to the 7.63.0 milestone Jan 10, 2025
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.

3 participants