Skip to content

Add Enterprise Commercial License Grafana dashboard page - #907

Merged
mlsmaycon merged 5 commits into
mainfrom
docs/enterprise-grafana-dashboard
Aug 8, 2026
Merged

Add Enterprise Commercial License Grafana dashboard page#907
mlsmaycon merged 5 commits into
mainfrom
docs/enterprise-grafana-dashboard

Conversation

@SunsetDrifter

@SunsetDrifter SunsetDrifter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the Grafana dashboard for the Enterprise Commercial License management stack added in netbirdio/netbird#7095.

  • New page at /selfhosted/enterprise/grafana-dashboard, listed under Commercial License in the sidebar. It covers the dashboard's five rows (General, NATS, Debugging, Network Map, Browser Client), prerequisites (prometheus-nats-exporter for the NATS row, optional Loki for the log-based Debugging panel), import steps, and dashboard variables.
  • Documents the values that need editing after import: hardcoded NATS host names, the pinned management instance in the Loki query, and the $host variable referenced by several panel queries but not defined by the dashboard.
  • Adds a Management (Enterprise) row and short cross-linking section to the existing Grafana dashboards reference page.

Details verified against the dashboard JSON and source: the 7-second high-latency threshold (management/server/telemetry/grpc_metrics.go), the wsproxy metric names (util/wsproxy/server/metrics.go), and the NATS signalling role, which is scoped to HA deployments since a single-node stack uses NATS for traffic flow only.

Note: netbirdio/netbird#7095 is not merged yet, so the GitHub links to management-enterprise.json on main will 404 until it lands. This PR should merge after (or together with) the upstream one.

Summary by CodeRabbit

  • New Features

    • Added a Grafana Dashboard link to the self-hosted Commercial License documentation.
    • Added setup and usage documentation for the Enterprise Grafana dashboard, including prerequisites, import steps, dashboard variables, and post-import adjustments.
  • Documentation

    • Updated the observability dashboards guide with the Enterprise dashboard, its available panels, and prerequisite information.

@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 7, 2026 1:09pm

Request Review

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@SunsetDrifter, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 48 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d1ccb927-9e12-4a90-976a-e593922f0553

📥 Commits

Reviewing files that changed from the base of the PR and between 1040184 and 5bb258a.

📒 Files selected for processing (2)
  • src/pages/selfhosted/enterprise/grafana-dashboard.mdx
  • src/pages/selfhosted/observability/dashboards.mdx
📝 Walkthrough

Walkthrough

The PR adds an Enterprise Grafana dashboard page. It documents setup, datasources, panels, variables, and query edits. The navigation and observability dashboard documentation now link to and describe the Enterprise dashboard.

Changes

Enterprise Grafana dashboard

Layer / File(s) Summary
Document the Enterprise dashboard
src/pages/selfhosted/enterprise/grafana-dashboard.mdx
Adds dashboard metadata and documents monitoring rows, required Prometheus/NATS/Loki datasources, import steps, deployment-specific query edits, variables, and undefined $host references.
Connect dashboard references
src/components/NavigationDocs.jsx, src/pages/selfhosted/observability/dashboards.mdx
Adds the Grafana Dashboard navigation link. Updates the dashboard description, catalog, and Enterprise panel details.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Poem

A rabbit hops through dashboards bright,
Five monitoring rows come into sight.
Prometheus, NATS, and Loki align,
Import the panels; the graphs will shine.
Documentation now points the way—
Enterprise metrics guide the day.

🚥 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 and concisely describes the main change: adding the Enterprise Commercial License Grafana dashboard documentation page.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/enterprise-grafana-dashboard

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/selfhosted/enterprise/grafana-dashboard.mdx`:
- Line 37: Update the NATS memory consumption panel description in
grafana-dashboard.mdx to remove the deployment-specific host names nats-1-prod
and nats-2-prod, replacing them with generic wording that does not expose
production infrastructure identifiers.

In `@src/pages/selfhosted/observability/dashboards.mdx`:
- Line 22: Update the shared variable table’s introductory scope statement to
apply only to the community dashboards, and explicitly exclude the Enterprise
dashboard variables documented separately. Preserve the existing community
variable descriptions for cluster, environment, and host.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 10ca9b55-c8e8-41e9-8725-ffd148aa5279

📥 Commits

Reviewing files that changed from the base of the PR and between f403129 and 1040184.

📒 Files selected for processing (3)
  • src/components/NavigationDocs.jsx
  • src/pages/selfhosted/enterprise/grafana-dashboard.mdx
  • src/pages/selfhosted/observability/dashboards.mdx

Comment thread src/pages/selfhosted/enterprise/grafana-dashboard.mdx Outdated
Comment thread src/pages/selfhosted/observability/dashboards.mdx
@mlsmaycon
mlsmaycon merged commit e2c42dd into main Aug 8, 2026
5 checks passed
@mlsmaycon
mlsmaycon deleted the docs/enterprise-grafana-dashboard branch August 8, 2026 03:02
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.

2 participants