Skip to content

fix(kubestatemetrics): serialize access to shared availableStores map - #54951

Draft
pgimalac wants to merge 1 commit into
mainfrom
pgimalac/fix-ksm-builder-race
Draft

fix(kubestatemetrics): serialize access to shared availableStores map#54951
pgimalac wants to merge 1 commit into
mainfrom
pgimalac/fix-ksm-builder-race

Conversation

@pgimalac

Copy link
Copy Markdown
Member

What does this PR do?

Fixes a data race on the kube-state-metrics library's package-level availableStores map: WithCustomResourceStoreFactories and BuildStores mutate/read this shared map without synchronization, so two concurrent KSM check workers calling buildStores() race on it. Adds a package-level mutex (ksmBuilderMu) that serializes access to both methods.

Motivation

Fix a race, found via a race-detector-enabled build in staging (see #54333 for context).

Describe how you validated your changes

Added TestWithCustomResourceStoreFactoriesConcurrent which calls WithCustomResourceStoreFactories concurrently on 100 goroutines; it reproduces the race under -race before the fix and is clean after (dda inv test --targets=./pkg/kubestatemetrics/builder/... --race).

WithCustomResourceStoreFactories and BuildStores delegate to the
kube-state-metrics library which mutates a package-level availableStores
map without synchronization. When two KSM check workers call buildStores()
concurrently, they race on this shared map.

Add a package-level mutex (ksmBuilderMu) that serializes access to
WithCustomResourceStoreFactories and BuildStores, preventing concurrent
mutation of the shared library state.

Found via a race-detector-enabled build in staging (see #54333).
@pgimalac pgimalac added qa/done QA done before merge and regressions are covered by tests changelog/no-changelog No changelog entry needed labels Aug 17, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@codex review

@github-actions github-actions Bot added the short review PR is simple enough to be reviewed quickly label Aug 17, 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: be56fb6117

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

Comment thread pkg/kubestatemetrics/builder/builder_race_test.go
@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 50.00%
Overall Coverage: 52.43% (+0.05%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: be56fb6 | Docs | Datadog PR Page | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Files inventory check summary

File checks results against ancestor 92f6b05c:

Results for datadog-agent_7.84.0~devel.git.224.be56fb6.pipeline.131280521-1_amd64.deb:

No change detected

Results for datadog-iot-agent_7.84.0~devel.git.224.be56fb6.pipeline.131280521-1_amd64.deb:

No change detected

@dd-octo-sts

dd-octo-sts Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

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

32 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64 760.218 MiB
agent_deb_amd64_fips 713.079 MiB
agent_heroku_amd64 312.557 MiB
agent_rpm_amd64 760.201 MiB
agent_rpm_amd64_fips 713.062 MiB
agent_rpm_arm64 735.966 MiB
agent_rpm_arm64_fips 692.153 MiB
agent_suse_amd64 760.201 MiB
agent_suse_amd64_fips 713.062 MiB
agent_suse_arm64 735.966 MiB
agent_suse_arm64_fips 692.153 MiB
docker_agent_amd64 818.833 MiB
docker_agent_arm64 819.642 MiB
docker_agent_jmx_amd64 1009.731 MiB
docker_agent_jmx_arm64 999.192 MiB
docker_cluster_agent_amd64 210.475 MiB
docker_cluster_agent_arm64 223.456 MiB
docker_cws_instrumentation_amd64 7.439 MiB
docker_cws_instrumentation_arm64 6.877 MiB
docker_dogstatsd_amd64 39.482 MiB
docker_dogstatsd_arm64 37.560 MiB
docker_host_profiler_amd64 305.814 MiB
docker_host_profiler_arm64 317.125 MiB
dogstatsd_deb_amd64 30.224 MiB
dogstatsd_deb_arm64 28.247 MiB
dogstatsd_rpm_amd64 30.224 MiB
dogstatsd_suse_amd64 30.224 MiB
iot_agent_deb_amd64 46.475 MiB
iot_agent_deb_arm64 43.127 MiB
iot_agent_deb_armhf 43.910 MiB
iot_agent_rpm_amd64 46.476 MiB
iot_agent_suse_amd64 46.475 MiB

@cit-pr-commenter-54b7da

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Job ID: 5c05787e-2087-4e8d-b3bc-9297ef730fbb

Baseline: 92f6b05
Comparison: be56fb6
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_idle_all_features memory utilization +0.36 [+0.32, +0.41] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization +0.34 [+0.27, +0.42] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization +0.24 [+0.09, +0.39] 1 Logs bounds checks dashboard
quality_gate_metrics_logs memory utilization +0.09 [-0.15, +0.34] 1 Logs bounds checks dashboard
quality_gate_private_action_runner memory utilization -0.03 [-0.14, +0.09] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.23 [-0.36, -0.11] 1 Logs bounds checks dashboard
quality_gate_security_idle memory utilization -0.24 [-0.34, -0.13] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -0.84 [-1.72, +0.03] 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 173.43MiB ≤ 178MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 732.86KiB ≤ 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.77MiB ≤ 538MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 1.13MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 18 ≤ 40 bounds checks dashboard
quality_gate_logs memory_usage 10/10 202.79MiB ≤ 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.79MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 355.53 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 18 ≤ 40 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 377.16MiB ≤ 439MiB 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 71.69MiB ≤ 76MiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 27.33 ≤ 100 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 325.22MiB ≤ 335MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 58.62 ≤ 200 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 302.67MiB ≤ 314MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 19.45 ≤ 100 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 306.40MiB ≤ 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_private_action_runner, bounds check memory_usage: 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.
  • 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_idle_all_features, bounds check total_bytes_received: 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_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_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_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, 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_security_mean_fs_load, bounds check memory_usage: 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

changelog/no-changelog No changelog entry needed internal Identify a non-fork PR qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/container-integrations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant