Skip to content

fix(dashboard): use _total suffix for nautobot change counters#71

Merged
dmathur0 merged 2 commits into
mainfrom
davesh/fix-dashboard-counter-total
Jul 8, 2026
Merged

fix(dashboard): use _total suffix for nautobot change counters#71
dmathur0 merged 2 commits into
mainfrom
davesh/fix-dashboard-counter-total

Conversation

@dmathur0

@dmathur0 dmathur0 commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • The Render Events panels in the Config Manager Overview dashboard queried the bare counter names nv_config_manager_nautobot_change_messages_processed / _failed.
  • prometheus_client exposes counters with a _total suffix (the live series are ..._processed_total / ..._failed_total), so these expressions never matched and the panels showed no data in any namespace (verified against live Prometheus).
  • Appended _total so the queries resolve. Applied to both the deployed chart copy and the docs copy.

Verification

  • Confirmed the live series names in Prometheus: nv_config_manager_nautobot_change_messages_processed_total (and _failed_total) exist and carry data in active namespaces.
  • Both JSON files validated as parseable.

Notes

  • This does not change the metric prefix; counters defined in src/nv_config_manager/render/dispatch.py already use the nv_config_manager_ namespace.

Summary by CodeRabbit

  • Bug Fixes
    • Updated the “Render Events” dashboard panel to use the latest metric names for processed and failed events.
    • Kept the existing chart layout, legends, and filtering behavior unchanged.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fec3a34d-07c4-4ea7-ba18-47016535b781

📥 Commits

Reviewing files that changed from the base of the PR and between d0da593 and 972f35c.

📒 Files selected for processing (2)
  • deploy/helm/dashboards/nv-config-manager-overview.json
  • docs/assets/static/nv-config-manager-overview.json
🚧 Files skipped from review as they are similar to previous changes (2)
  • deploy/helm/dashboards/nv-config-manager-overview.json
  • docs/assets/static/nv-config-manager-overview.json

📝 Walkthrough

Walkthrough

The Render Events dashboard queries were updated in both dashboard JSON copies to use the new _processed_total and _failed_total Prometheus metric names.

Changes

Render Events panel metric rename

Layer / File(s) Summary
Panel query updates
deploy/helm/dashboards/nv-config-manager-overview.json, docs/assets/static/nv-config-manager-overview.json
The Render Events Prometheus targets now query nv_config_manager_nautobot_change_messages_processed_total and nv_config_manager_nautobot_change_messages_failed_total instead of the previous metric names.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped through dashboards, neat and bright,
New metric names now fit just right.
Processed, failed—both count the same,
The Render Events panel keeps its frame.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: updating Nautobot change counter metrics to use the _total suffix in dashboards.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch davesh/fix-dashboard-counter-total

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

The Render Events panels queried the bare counter names
(nv_config_manager_nautobot_change_messages_processed / _failed),
but prometheus_client exposes counters with a _total suffix, so the
series never matched and the panels rendered no data in any namespace.
Append _total so the queries resolve.

Signed-off-by: Davesh Mathur <daveshm@nvidia.com>
@dmathur0 dmathur0 force-pushed the davesh/fix-dashboard-counter-total branch from d0da593 to 972f35c Compare June 29, 2026 20:15
@github-actions

Copy link
Copy Markdown

@ryanheffernan

Copy link
Copy Markdown
Collaborator

lgtm, if you can please rebase and run unit tests i'll approve

@dmathur0 dmathur0 merged commit f514bf4 into main Jul 8, 2026
15 of 16 checks passed
@dmathur0 dmathur0 deleted the davesh/fix-dashboard-counter-total branch July 8, 2026 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants