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

apm: fix span event msgpk deserialization, add test #35033

Merged
merged 3 commits into from
Mar 11, 2025

Conversation

ajgajg1134
Copy link
Contributor

What does this PR do?

Fixes the message pack serialization code for SpanEvents, we use camel_case for these. The protobuf definition is still correct so no changes needed there.

Motivation

Span Events sent via messagepack were not successfully being decoded if they were sent using the new span_events field.

Describe how you validated your changes

I used message pack payloads from the ruby tracer to verify this change and have added an automated test to ensure this payload is properly serialized.

Possible Drawbacks / Trade-offs

Additional Notes

@ajgajg1134 ajgajg1134 requested a review from a team as a code owner March 11, 2025 19:49
@github-actions github-actions bot added medium review PR review might take time team/agent-apm trace-agent labels Mar 11, 2025
@ajgajg1134 ajgajg1134 requested a review from a team as a code owner March 11, 2025 19:54
@ajgajg1134 ajgajg1134 added the qa/done QA done before merge and regressions are covered by tests label Mar 11, 2025
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

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

Small suggestions, but approving to not block merge

---
fixes:
- |
APM: fix issue where new span field for span events wasn't properly serialized when received as message pack.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
APM: fix issue where new span field for span events wasn't properly serialized when received as message pack.
APM: fix issue where a new span field for span events wasn't properly serialized when received as a message pack.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I updated the release note a bit from this suggestion as I realized when looking it up that message pack is written as MessagePack (as it's the name of the format)

@ajgajg1134
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Mar 11, 2025

View all feedbacks in Devflow UI.
2025-03-11 20:21:16 UTC ℹ️ Start processing command /merge


2025-03-11 20:21:24 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-03-11 21:38:11 UTC ℹ️ MergeQueue: merge request added to the queue

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


2025-03-11 22:03:23 UTC ℹ️ MergeQueue: This merge request was merged

@agent-platform-auto-pr
Copy link
Contributor

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

Uncompressed package size comparison

Comparison with ancestor 01c0789ea87298c492a2f4215f16fcb973c3a52a

Size reduction summary
package diff status size ancestor threshold
datadog-agent-aarch64-rpm -0.00MB 810.57MB 810.57MB 0.50MB
datadog-agent-x86_64-rpm -0.00MB 819.59MB 819.59MB 0.50MB
datadog-agent-x86_64-suse -0.00MB 819.59MB 819.59MB 0.50MB
datadog-agent-amd64-deb -0.00MB 809.80MB 809.80MB 0.50MB
Diff per package
package diff status size ancestor threshold
datadog-agent-arm64-deb 0.00MB 800.79MB 800.79MB 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.85MB 37.85MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 440.62MB 440.62MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.17MB 62.17MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.24MB 62.24MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.24MB 62.24MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.40MB 59.40MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.47MB 59.47MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

dda inv aws.create-vm --pipeline-id=58491095 --os-family=ubuntu

Note: This applies to commit bcf2071

@agent-platform-auto-pr
Copy link
Contributor

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 783.78 MiB 801.8 MiB 191.04 MiB 202.62 MiB
static_quality_gate_agent_deb_arm64 775.18 MiB 793.14 MiB 173.83 MiB 184.51 MiB
static_quality_gate_agent_rpm_amd64 783.81 MiB 801.79 MiB 193.13 MiB 205.03 MiB
static_quality_gate_agent_rpm_arm64 775.15 MiB 793.09 MiB 175.41 MiB 186.44 MiB
static_quality_gate_agent_suse_amd64 783.69 MiB 801.81 MiB 193.13 MiB 205.03 MiB
static_quality_gate_agent_suse_arm64 775.06 MiB 793.14 MiB 175.41 MiB 186.44 MiB
static_quality_gate_dogstatsd_deb_amd64 37.58 MiB 47.67 MiB 9.74 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.58 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_dogstatsd_suse_amd64 37.58 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_iot_agent_deb_amd64 59.37 MiB 69.0 MiB 14.91 MiB 24.8 MiB
static_quality_gate_iot_agent_deb_arm64 56.72 MiB 66.4 MiB 12.88 MiB 22.8 MiB
static_quality_gate_iot_agent_rpm_amd64 59.37 MiB 69.0 MiB 14.93 MiB 24.8 MiB
static_quality_gate_iot_agent_rpm_arm64 56.72 MiB 66.4 MiB 12.87 MiB 22.8 MiB
static_quality_gate_iot_agent_suse_amd64 59.37 MiB 69.0 MiB 14.93 MiB 24.8 MiB
static_quality_gate_docker_agent_amd64 868.43 MiB 886.12 MiB 292.17 MiB 304.21 MiB
static_quality_gate_docker_agent_arm64 883.11 MiB 900.79 MiB 278.5 MiB 290.47 MiB
static_quality_gate_docker_agent_jmx_amd64 1.04 GiB 1.06 GiB 367.27 MiB 379.33 MiB
static_quality_gate_docker_agent_jmx_arm64 1.04 GiB 1.06 GiB 349.58 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.37 MiB 54.45 MiB 16.12 MiB 26.16 MiB
static_quality_gate_docker_cluster_agent_amd64 264.87 MiB 274.78 MiB 106.29 MiB 116.28 MiB
static_quality_gate_docker_cluster_agent_arm64 280.8 MiB 290.82 MiB 101.12 MiB 111.12 MiB

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 02014a77-499e-48c9-a160-56e50dbe988a

Baseline: 01c0789
Comparison: bcf2071
Diff

Optimization Goals: ✅ Improvement(s) detected

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_idle memory utilization -6.92 [-6.99, -6.85] 1 Logs bounds checks dashboard
file_tree memory utilization -6.93 [-7.11, -6.76] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.59 [+0.79, +2.39] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.34 [-0.13, +0.81] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.09 [-0.70, +0.87] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.06 [-0.78, +0.89] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.00 [-0.82, +0.82] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.00 [-0.63, +0.63] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.00 [-0.83, +0.83] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.32, +0.30] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.03, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.67, +0.65] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.18 [-0.96, +0.59] 1 Logs
quality_gate_logs % cpu utilization -0.61 [-3.34, +2.13] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.79 [-0.86, -0.73] 1 Logs
quality_gate_idle_all_features memory utilization -4.75 [-4.85, -4.65] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -6.92 [-6.99, -6.85] 1 Logs bounds checks dashboard
file_tree memory utilization -6.93 [-7.11, -6.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 memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 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.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@dd-mergequeue dd-mergequeue bot merged commit dd75660 into main Mar 11, 2025
247 checks passed
@dd-mergequeue dd-mergequeue bot deleted the andrew.glaude/fixspanEvents branch March 11, 2025 22:03
@github-actions github-actions bot added this to the 7.65.0 milestone Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
medium review PR review might take time 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.

4 participants