fix(base-cluster/monitoring): otherwise the metric will be duplicated if suspend is not set

[cwrau]

Summary by CodeRabbit

• Bug Fixes
  • Corrected the reconcile_suspended gauge to read directly from spec.suspend, ensuring accurate status reporting for suspended custom resources.
  • Resolves misreported values in monitoring, reducing false positives/negatives in dashboards and alerts.
  • Improves reliability of metrics consumed by kube-prometheus-stack visualizations and alerting rules.

[coderabbitai]

Walkthrough

Adjusted kube-state-metrics customResourceState configuration: reconcile_suspended_gauge now reads directly from spec.suspend by changing path to ["spec","suspend"] and removing valueFrom. Gauge type and nilIsZero remain unchanged. No other files or entities modified.

Changes

Cohort / File(s)	Summary
kube-state-metrics config charts/base-cluster/templates/monitoring/kube-prometheus-stack/_kube-state-metrics-config.yaml	Change reconcile_suspended_gauge path from ["spec"] with valueFrom ["suspend"] to ["spec","suspend"]; keep type "Gauge" and nilIsZero: true

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• fix(base-cluster/monitoring): also create metrics for resources without suspend field #1634 — Also modifies reconcile_suspended_gauge in the same file, focusing on handling missing suspend via nilIsZero.
• feat(base-cluster/flux): add alert about suspended resources #1540 — Introduced reconcile_suspended_gauge sourced from spec.suspend; this PR adjusts its extraction method.

Suggested labels

base-cluster

Suggested reviewers

• marvinWolff
• teutonet-bot
• tasches

Poem

A hop, a skip, a tidy tweak,
From spec to suspend we swiftly peek.
Gauges aligned, no detours found,
Nil is zero, metrics sound.
Thump-thump—my paws approve this fix,
Carrots counted: one, two, six! 🥕🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a1a8924 and 23609ec.

📒 Files selected for processing (1)

• charts/base-cluster/templates/monitoring/kube-prometheus-stack/_kube-state-metrics-config.yaml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Update release-please config file for a possibly new chart
• GitHub Check: check licenses
• GitHub Check: lint helm chart (base-cluster)

🔇 Additional comments (1)

charts/base-cluster/templates/monitoring/kube-prometheus-stack/_kube-state-metrics-config.yaml (1)

88-90: Directly reading spec.suspend is the right fix to prevent duplicates.

Switching to path ["spec","suspend"] (and keeping nilIsZero: true) avoids emitting multiple series when suspend is unset, and still yields 0/1 for boolean values. Looks good.

Quick checks to run after rollout:

• PromQL: Ensure no duplicate time series per object
  • count by (job, customresource_namespace, customresource_name) (gotk_reconcile_suspended_gauge) > 1
  • max_over_time(gotk_reconcile_suspended_gauge[5m]) to confirm 0/1 behavior across objects with/without suspend set.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/base-cluster/kube-state-metrics-flux-suspended-gauge-duplicates

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This PR fixes a configuration issue in the kube-state-metrics setup where metrics could be duplicated when the suspend field is not set. The fix consolidates the path specification for accessing the suspend field in Kubernetes custom resources.

• Simplifies the path configuration for the suspend field metric
• Prevents metric duplication by using a single consolidated path instead of separate path and valueFrom specifications

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}