[Doc] add a doc for sharing a Grafana instance across multiple KubeRa…

…y custom resources Signed-off-by: win5923 <[email protected]>
ray-project · Jan 9, 2025 · 556731e · 556731e
1 parent a3b1265
commit 556731e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/doc/source/cluster/kubernetes/images/grafana_ray_dashboard.png b/doc/source/cluster/kubernetes/images/grafana_ray_dashboard.png
diff --git a/doc/source/cluster/kubernetes/images/grafana_ray_dashboard2.png b/doc/source/cluster/kubernetes/images/grafana_ray_dashboard2.png
diff --git a/doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md b/doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md
@@ -366,8 +366,16 @@ Refer to [this Grafana document](https://grafana.com/tutorials/run-grafana-behin
 
 * TODO: Note that importing the dashboard manually is not ideal. We should find a way to import the dashboard automatically.
 
+Once the Ray Dashboard is imported into Grafana, you can filter metrics by using the `Cluster` variable. This variable is automatically applied by default when using the provided `PodMonitor` configuration. No additional setup is needed for this labeling.
+
+If you have multiple RayClusters, the `Cluster` variable allows you to filter metrics specific to a particular cluster. This ensures that you can easily monitor or debug individual RayCluster instances without being overwhelmed by data from all clusters.
+
 ![Grafana Ray Dashboard](../images/grafana_ray_dashboard.png)
 
+Select a specific RayCluster from the dropdown to view metrics for that instance.
+
+![Grafana Ray Dashboard2](../images/grafana_ray_dashboard2.png)
+
 ## Step 11: Embed Grafana panels in Ray Dashboard
 
 ```sh