Skip to content

APM: Reduce likelihood of receiver shutdown panic #37832

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 12, 2025
Merged

APM: Reduce likelihood of receiver shutdown panic #37832

merged 2 commits into from
Jun 12, 2025

Conversation

ajgajg1134
Copy link
Contributor

@ajgajg1134 ajgajg1134 commented Jun 10, 2025 •
edited
Loading

What does this PR do?

Move our usage of waitgroup to cover the entire process function to ensure that the Stop() function doesn't close the out channel until we've processed all payloads

Motivation

This should reduce the incidence of panics during shutdown

Describe how you validated your changes

I ran this locally with a test tracer to ensure it still functions correctly and saw it was successful. I also attempted to recreate the send after close panic (before and after) and could not do so locally.

Possible Drawbacks / Trade-offs

This does not fully resolve this issue, there is still a narrow window in which this issue can still occur. I have been unable to identify the underlying issue that is causing server.Shutdown() to not block until all handlers return, so this is a stop-gap measure to reduce incidence while continuing investigation.

The use of a wait group here for ever incoming trace payload will incur a very small performance cost.

Additional Notes

@github-actions github-actions bot added team/agent-apm trace-agent short review PR is simple enough to be reviewed quickly labels Jun 10, 2025
@cit-pr-commenter cit-pr-commenter
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: f4860687-624a-4462-807c-0a34339b357b

Baseline: f78cfdf
Comparison: a8cd487
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.10 [+1.25, +2.94] 1 Logs
➖ otlp_ingest_metrics memory utilization +0.75 [+0.57, +0.94] 1 Logs
➖ ddot_logs memory utilization +0.59 [+0.45, +0.73] 1 Logs
➖ quality_gate_idle_all_features memory utilization +0.51 [+0.44, +0.59] 1 Logs bounds checks dashboard
➖ quality_gate_logs % cpu utilization +0.51 [-2.24, +3.27] 1 Logs bounds checks dashboard
➖ file_tree memory utilization +0.45 [+0.31, +0.60] 1 Logs
➖ quality_gate_idle memory utilization +0.34 [+0.28, +0.40] 1 Logs bounds checks dashboard
➖ tcp_syslog_to_blackhole ingress throughput +0.19 [+0.13, +0.25] 1 Logs
➖ uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.07 [-0.01, +0.14] 1 Logs
➖ tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.02] 1 Logs
➖ file_to_blackhole_0ms_latency_http1 egress throughput +0.00 [-0.60, +0.61] 1 Logs
➖ file_to_blackhole_300ms_latency egress throughput -0.01 [-0.62, +0.60] 1 Logs
➖ uds_dogstatsd_to_api ingress throughput -0.02 [-0.30, +0.27] 1 Logs
➖ file_to_blackhole_500ms_latency egress throughput -0.03 [-0.68, +0.63] 1 Logs
➖ file_to_blackhole_1000ms_latency_linear_load egress throughput -0.05 [-0.28, +0.19] 1 Logs
➖ file_to_blackhole_100ms_latency egress throughput -0.06 [-0.63, +0.52] 1 Logs
➖ file_to_blackhole_0ms_latency_http2 egress throughput -0.07 [-0.65, +0.52] 1 Logs
➖ file_to_blackhole_0ms_latency egress throughput -0.08 [-0.70, +0.53] 1 Logs
➖ file_to_blackhole_1000ms_latency egress throughput -0.09 [-0.68, +0.49] 1 Logs
➖ ddot_metrics memory utilization -0.19 [-0.30, -0.07] 1 Logs
➖ otlp_ingest_logs memory utilization -0.20 [-0.32, -0.07] 1 Logs
➖ docker_containers_memory memory utilization -0.49 [-0.58, -0.40] 1 Logs
➖ docker_containers_cpu % cpu utilization -0.69 [-3.68, +2.30] 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_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 bounds checks dashboard
✅ quality_gate_logs lost_bytes 10/10 bounds checks dashboard
✅ quality_gate_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 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, 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.

@agent-platform-auto-pr
Copy link
Contributor

Static quality checks

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

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
✅ agent_deb_amd64 $${-0.03}$$ $${696.06}$$ < $${752.99}$$ $${-0.06}$$ $${176.03}$$ < $${187.44}$$
✅ agent_deb_amd64_fips $${-0.03}$$ $${694.29}$$ < $${751.36}$$ $${+0}$$ $${175.55}$$ < $${187.06}$$
✅ agent_heroku_amd64 $${-0.03}$$ $${358.56}$$ < $${369.68}$$ $${-0.01}$$ $${96.5}$$ < $${99.55}$$
✅ agent_msi $${-0.02}$$ $${959.87}$$ < $${987.01}$$ $${-0.02}$$ $${146.43}$$ < $${150.72}$$
✅ agent_rpm_amd64 $${-0.03}$$ $${696.05}$$ < $${752.98}$$ $${-0.07}$$ $${177.53}$$ < $${190.03}$$
✅ agent_rpm_amd64_fips $${-0.03}$$ $${694.28}$$ < $${751.35}$$ $${+0.03}$$ $${177.46}$$ < $${189.81}$$
✅ agent_rpm_arm64 $${-0.06}$$ $${686.0}$$ < $${739.42}$$ $${+0.01}$$ $${161.08}$$ < $${171.23}$$
✅ agent_rpm_arm64_fips $${-0.06}$$ $${684.35}$$ < $${737.91}$$ $${-0.01}$$ $${160.11}$$ < $${170.22}$$
✅ agent_suse_amd64 $${-0.03}$$ $${696.05}$$ < $${752.98}$$ $${-0.07}$$ $${177.53}$$ < $${190.03}$$
✅ agent_suse_amd64_fips $${-0.03}$$ $${694.28}$$ < $${751.35}$$ $${+0.03}$$ $${177.46}$$ < $${189.81}$$
✅ agent_suse_arm64 $${-0.06}$$ $${686.0}$$ < $${739.42}$$ $${+0.01}$$ $${161.08}$$ < $${171.23}$$
✅ agent_suse_arm64_fips $${-0.06}$$ $${684.35}$$ < $${737.91}$$ $${-0.01}$$ $${160.11}$$ < $${170.22}$$
✅ docker_agent_amd64 $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_arm64 $${-0.06}$$ $${793.25}$$ < $${858.97}$$ $${-0.03}$$ $${255.98}$$ < $${274.36}$$
✅ docker_agent_jmx_amd64 $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_jmx_arm64 $${-0.06}$$ $${793.25}$$ < $${858.97}$$ $${-0.03}$$ $${255.98}$$ < $${274.36}$$
✅ docker_agent_windows1809 $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows1809_core $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows1809_core_jmx $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows1809_jmx $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows2022 $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows2022_core $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows2022_core_jmx $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_agent_windows2022_jmx $${-0.03}$$ $${779.85}$$ < $${849.39}$$ $${-0.03}$$ $${268.59}$$ < $${288.34}$$
✅ docker_cluster_agent_amd64 $${-0}$$ $${259.2}$$ < $${259.73}$$ $${+0}$$ $${102.88}$$ < $${103.68}$$
✅ docker_cluster_agent_arm64 $${0}$$ $${273.58}$$ < $${274.24}$$ $${-0}$$ $${97.61}$$ < $${98.45}$$
✅ docker_cws_instrumentation_amd64 $${0}$$ $${7.08}$$ < $${7.12}$$ $${-0}$$ $${2.95}$$ < $${3.29}$$
✅ docker_cws_instrumentation_arm64 $${0}$$ $${6.69}$$ < $${6.92}$$ $${-0}$$ $${2.7}$$ < $${3.07}$$
✅ docker_dogstatsd_amd64 $${0}$$ $${38.93}$$ < $${39.57}$$ $${+0}$$ $${14.95}$$ < $${15.76}$$
✅ docker_dogstatsd_arm64 $${0}$$ $${37.52}$$ < $${38.2}$$ $${+0}$$ $${13.96}$$ < $${14.83}$$
✅ dogstatsd_deb_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${+0}$$ $${8.03}$$ < $${8.97}$$
✅ dogstatsd_deb_arm64 $${0}$$ $${29.16}$$ < $${30.08}$$ $${+0}$$ $${6.98}$$ < $${7.92}$$
✅ dogstatsd_rpm_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.04}$$ < $${8.98}$$
✅ dogstatsd_suse_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.04}$$ < $${8.98}$$
✅ iot_agent_deb_amd64 $${0}$$ $${50.49}$$ < $${60.17}$$ $${+0}$$ $${12.85}$$ < $${15.82}$$
✅ iot_agent_deb_arm64 $${0}$$ $${47.94}$$ < $${56.94}$$ $${-0}$$ $${11.14}$$ < $${13.86}$$
✅ iot_agent_deb_armhf $${0}$$ $${47.52}$$ < $${56.41}$$ $${-0}$$ $${11.21}$$ < $${13.86}$$
✅ iot_agent_rpm_amd64 $${0}$$ $${50.49}$$ < $${60.18}$$ $${+0}$$ $${12.87}$$ < $${15.84}$$
✅ iot_agent_rpm_arm64 $${0}$$ $${47.94}$$ < $${56.94}$$ $${+0}$$ $${11.16}$$ < $${13.76}$$
✅ iot_agent_suse_amd64 $${0}$$ $${50.49}$$ < $${60.18}$$ $${+0}$$ $${12.87}$$ < $${15.84}$$

@ajgajg1134 ajgajg1134 added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Jun 11, 2025
@ajgajg1134 ajgajg1134 marked this pull request as ready for review June 11, 2025 17:21
@ajgajg1134 ajgajg1134 requested a review from a team as a code owner June 11, 2025 17:21
ekump
ekump reviewed Jun 11, 2025
View reviewed changes
Copy link

@ekump ekump left a comment

Choose a reason for hiding this comment

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

LGTM FWIW

@ajgajg1134
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 12, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-06-12 15:24:01 UTC ℹ️ Start processing command /merge

2025-06-12 15:24:27 UTC ℹ️ MergeQueue: pull request added to the queue

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

2025-06-12 16:11:50 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit b6b9700 into main Jun 12, 2025
263 of 265 checks passed
@dd-mergequeue dd-mergequeue bot deleted the andrew.glaude/receiverPanic branch June 12, 2025 16:11
@github-actions github-actions bot added this to the 7.68.0 milestone Jun 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ekump ekump ekump left review comments

@ichinaski ichinaski ichinaski approved these changes

Assignees
No one assigned
Labels
changelog/no-changelog qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/agent-apm trace-agent
Projects
None yet
Milestone
7.68.0
Development

Successfully merging this pull request may close these issues.
3 participants
@ajgajg1134 @ichinaski @ekump