Sitelet https://github.com/DataDog/datadog-agent/pull/55356
Skip to content

fix(data-race): hold agentMapMu until callAgentsForService goroutines finish - #55356

Draft
pgimalac wants to merge 1 commit into
mainfrom
pgimalac/remoteagentregistry-callagents-race
Draft

fix(data-race): hold agentMapMu until callAgentsForService goroutines finish#55356
pgimalac wants to merge 1 commit into
mainfrom
pgimalac/remoteagentregistry-callagents-race

Conversation

@pgimalac

Copy link
Copy Markdown
Member

What does this PR do?

Holds agentMapMu in callAgentsForService until the per-agent goroutines finish (defer Unlock after wg.Wait()), instead of unlocking before wg.Wait().

Motivation

callAgentsForService spawned goroutines that read remoteAgent.RegisteredAgent fields (e.g. SanitizedDisplayName for telemetry) and then unlocked agentMapMu before wg.Wait(). The goroutines therefore raced with RefreshRemoteAgent, which writes RegisteredAgent.LastSeen under the same lock. Surfaced by the race-detector staging deployment (squirtle-a, dev-pgimalac-race-detector-*) in the agent container:

WARNING: DATA RACE
Read at ... by goroutine 33512:
  callAgentsForService[...].func1()  client.go:278
  ... GetRegisteredAgentsTelemetry -> registryCollector.Collect -> prometheus Registry.Gather
Previous write at ... by goroutine 33598:
  (*remoteAgentRegistry).RefreshRemoteAgent()  registry.go:247
  ... gRPC RemoteAgent.RefreshRemoteAgent handler

Describe how you validated your changes

  • dda inv test --targets=./comp/core/remoteagentregistry/... (83 tests pass)

Additional Notes

Found via the internal race-detector deployment documented in Agent Data Races in Internal Deployments.

… finish

callAgentsForService spawned per-agent goroutines that read
remoteAgent.RegisteredAgent fields (e.g. SanitizedDisplayName for
telemetry) and then unlocked agentMapMu before wg.Wait(). The goroutines
therefore raced with RefreshRemoteAgent, which writes
RegisteredAgent.LastSeen under the same lock.

Hold the lock until the goroutines finish (defer Unlock after wg.Wait)
so RefreshRemoteAgent cannot mutate RegisteredAgent while it is being read.
@github-actions

Copy link
Copy Markdown
Contributor

@codex review

@dd-octo-sts dd-octo-sts Bot added the internal Identify a non-fork PR label Aug 25, 2026
@github-actions github-actions Bot added the short review PR is simple enough to be reviewed quickly label Aug 25, 2026

@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: d427fab287

ℹ️ 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".

// Keep agentMapMu held until the goroutines finish. They read remoteAgent.RegisteredAgent
// fields (e.g. SanitizedDisplayName for telemetry) which race with RefreshRemoteAgent
// writing RegisteredAgent.LastSeen under the same lock.
defer registry.agentMapMu.Unlock()

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 Release the registry lock before remote RPCs

When a remote callback is slow or unreachable, this keeps the global registry mutex held for the entire RPC timeout and result processing, blocking RefreshRemoteAgent and new registrations. If multiple status, telemetry, or flare collections are queued, a healthy remote agent's refresh can wait longer than its own queryTimeout; refreshRegistration then treats the deadline as a lost registration, clears the session, and starts re-registering (serverhelper.go:236-244,542-545). Copy the agent pointers and protected RegisteredAgent values while holding the mutex, then release it before starting the RPCs.

Useful? React with 👍 / 👎.

@datadog-prod-us1-6

datadog-prod-us1-6 Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 52.55% (-0.06%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: d427fab | Docs | View more details | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Files inventory check summary

File checks results against ancestor 3b26ea63:

Results for datadog-agent_7.84.0~devel.git.384.d427fab.pipeline.133001508-1_amd64.deb:

No change detected

Results for datadog-iot-agent_7.84.0~devel.git.384.d427fab.pipeline.133001508-1_amd64.deb:

No change detected

@dd-octo-sts

dd-octo-sts Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

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

Successful checks

Info

Quality gate Change Size (prev → curr → max)
agent_rpm_arm64 +4.47 KiB (0.00% increase, -0.87% of buffer) 736.629 → 736.634 → 737.130
agent_suse_arm64 +4.47 KiB (0.00% increase, -0.87% of buffer) 736.629 → 736.634 → 737.130
docker_agent_arm64 +4.47 KiB (0.00% increase, -0.75% of buffer) 820.305 → 820.309 → 820.890
docker_agent_jmx_arm64 +4.47 KiB (0.00% increase, -0.61% of buffer) 999.854 → 999.859 → 1000.570
iot_agent_deb_arm64 +4.0 KiB (0.01% increase, -0.37% of buffer) 43.155 → 43.159 → 44.220
iot_agent_deb_armhf +4.0 KiB (0.01% increase, -0.36% of buffer) 43.950 → 43.953 → 45.020
26 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64 760.816 MiB
agent_deb_amd64_fips 713.590 MiB
agent_heroku_amd64 312.809 MiB
agent_rpm_amd64 760.800 MiB
agent_rpm_amd64_fips 713.574 MiB
agent_rpm_arm64_fips 692.714 MiB
agent_suse_amd64 760.800 MiB
agent_suse_amd64_fips 713.574 MiB
agent_suse_arm64_fips 692.714 MiB
docker_agent_amd64 819.432 MiB
docker_agent_jmx_amd64 1010.329 MiB
docker_cluster_agent_amd64 211.344 MiB
docker_cluster_agent_arm64 224.395 MiB
docker_cws_instrumentation_amd64 7.443 MiB
docker_cws_instrumentation_arm64 6.877 MiB
docker_dogstatsd_amd64 39.463 MiB
docker_dogstatsd_arm64 37.560 MiB
docker_host_profiler_amd64 306.800 MiB
docker_host_profiler_arm64 318.034 MiB
dogstatsd_deb_amd64 30.204 MiB
dogstatsd_deb_arm64 28.240 MiB
dogstatsd_rpm_amd64 30.204 MiB
dogstatsd_suse_amd64 30.204 MiB
iot_agent_deb_amd64 46.503 MiB
iot_agent_rpm_amd64 46.503 MiB
iot_agent_suse_amd64 46.502 MiB

@cit-pr-commenter-54b7da

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Job ID: dd7084f4-1e20-4976-8c56-16ca5d122f41

Baseline: 3b26ea6
Comparison: d427fab
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_metrics_logs memory utilization +1.69 [+1.46, +1.92] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization +0.55 [-0.34, +1.44] 1 Logs bounds checks dashboard
quality_gate_private_action_runner memory utilization +0.45 [+0.32, +0.57] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization +0.25 [+0.17, +0.34] 1 Logs bounds checks dashboard
quality_gate_security_idle memory utilization +0.05 [+0.00, +0.10] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +0.01 [-0.02, +0.05] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.01 [-0.05, +0.03] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization -0.29 [-0.32, -0.25] 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 4 = 4 bounds checks dashboard
quality_gate_idle memory_usage 10/10 172.60MiB ≤ 178MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 749.69KiB ≤ 819.20KiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 4 = 4 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 517.87MiB ≤ 538MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 1.15MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 17 ≤ 40 bounds checks dashboard
quality_gate_logs memory_usage 10/10 212.50MiB ≤ 229MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_logs total_bytes_received 10/10 263.09MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 366.37 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 20 ≤ 40 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 430.12MiB ≤ 453MiB 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_private_action_runner memory_usage 10/10 72.53MiB ≤ 76MiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 26.91 ≤ 100 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 327.04MiB ≤ 335MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 65.21 ≤ 200 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 301.76MiB ≤ 314MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 22.22 ≤ 100 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 311.72MiB ≤ 343MiB 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_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check cpu_usage: 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 intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_private_action_runner, 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_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_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 memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check missed_bytes: 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_logs, bounds check memory_usage: 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 missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 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_no_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

internal Identify a non-fork PR short review PR is simple enough to be reviewed quickly team/agent-runtimes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant