add How to Add Dashboards for EnvoyGateway

[woodgear]

Summary by CodeRabbit

• Documentation
  • New guide added for configuring EnvoyGateway monitoring dashboards. Provides ready-to-deploy manifests to create Grafana-style dashboards for control-plane and data-plane metrics, Prometheus PodMonitor configurations to collect metrics from control-plane and proxy pods, step-by-step apply/verify instructions to see dashboards in the web console, and rollback steps to remove the deployed monitoring resources.

[coderabbitai]

Warning

Rate limit exceeded

@woodgear has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 45 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d3f9aea5-9553-4177-b5a4-f907c432d19c

📥 Commits

Reviewing files that changed from the base of the PR and between 467567e and 88cf71a.

📒 Files selected for processing (1)

• docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md

Walkthrough

Adds a documentation guide that supplies two MonitorDashboard manifests (control-plane and data-plane), two Prometheus PodMonitor resources for scraping metrics, and operational instructions to apply, verify, and roll back the combined manifest.

Changes

EnvoyGateway Monitoring Dashboard Documentation

Layer / File(s)	Summary
Guide Introduction and Prerequisites docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md	Purpose, scope, and prerequisites for adding EnvoyGateway dashboards, including required installation state, cluster access, and PodMonitor support.
Manifest creation step docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md	Instruction to create envoy-gateway-dashboard.yaml containing dashboards and monitoring resources.
Control-plane MonitorDashboard configuration docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md	Control-plane MonitorDashboard with panels for watch/subscription status, status updater, xDS server, infrastructure manager, and control-plane CPU/memory; includes namespace templating and time-range settings.
Data-plane MonitorDashboard configuration docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md	Data-plane MonitorDashboard with server overview, CPU/memory/network panels, downstream gateway metrics, upstream route metrics, response-code breakdown, endpoint health, and templating for namespace, gateway, and route.
Prometheus PodMonitor resources docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md	Two PodMonitor manifests: one for EnvoyGateway control-plane (/metrics) and one for Envoy proxy (/stats/prometheus) with label selection and relabeling.
Deployment, verification, and rollback docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md	kubectl apply -f envoy-gateway-dashboard.yaml, commands to list MonitorDashboard and PodMonitor resources and confirm dashboards in web console, and kubectl delete -f rollback.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

• tyzhou111

Poem

🐰 In a garden of metrics I hop and hum,
Panels bloom where Prometheus drums,
Control and data sing in gentle rhyme,
Grafana lights up timestamped time,
EnvoyGateway's vistas now sparkle and chime. ✨

🚥 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 pull request title clearly and concisely describes the main change: adding documentation for EnvoyGateway dashboards. It directly relates to the primary content of the changeset.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 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 `@docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md`:
- Around line 33-35: Update the prerequisites to include RBAC for PodMonitor: in
addition to requiring permission to create MonitorDashboard in the cpaas-system
namespace, explicitly require permission to create PodMonitor resources in
cpaas-system (and note that the monitoring stack must support PodMonitor).
Reference the resource names MonitorDashboard and PodMonitor and the namespace
cpaas-system so the manifest creators know to add/create the PodMonitor RBAC
rule.
- Around line 223-230: The latency panels use PromQL like
histogram_quantile(..., rate(status_update_duration_seconds_bucket{...}[2m]))
but the Grafana panel unit is set to ms, causing a 1000x mismatch; fix by either
multiplying each histogram_quantile(...) expression by 1000 (e.g. 1000 *
histogram_quantile(...)) or change the panel unit from "ms" to "s" for both
"Status Update Duration" and "Resource Apply Duration" panels; update
occurrences referencing histogram_quantile,
status_update_duration_seconds_bucket and resource_apply_duration_seconds_bucket
accordingly (also apply the same change at the other location mentioned).
- Line 1149: The "Endpoint Health Percentage (Route)" Prometheus expression
currently ends with " > 0", which turns the ratio into a boolean; update the
query used in that panel (the expression starting with avg
by(envoy_cluster_name)
(envoy_cluster_membership_healthy{gateway_namespace=~"$namespace",gateway=~"$gateway",envoy_cluster_name=~"$route"})
/ avg by(envoy_cluster_name)
(envoy_cluster_membership_total{gateway_namespace=~"$namespace",gateway=~"$gateway",envoy_cluster_name=~"$route"})
> 0) by removing the comparison and returning the raw ratio (or multiply by 100
to present a percentage) so the panel shows the actual endpoint health
percentage rather than 0/1.

🪄 Autofix (Beta)

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

Run ID: 79ce778a-233b-4270-aed5-5fed594cef59

📥 Commits

Reviewing files that changed from the base of the PR and between ca9e549 and cc318e9.

📒 Files selected for processing (1)

• docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md