KubeRay Stay organized with collections Save and categorize content based on your preferences.
This document describes how to configure your Google Kubernetes Engine deploymentso that you can use Google Cloud Managed Service for Prometheus to collect metrics fromKubeRay. This document shows you how to do the following:
- Set up KubeRay to report metrics.
- Access a predefined dashboard in Cloud Monitoring to view the metrics.
These instructions apply only if you are usingmanaged collectionwith Managed Service for Prometheus.If you are using self-deployed collection, then see theKubeRay documentationfor installation information.
These instructions are provided as an example and are expected to work inmost Kubernetes environments.If you are having trouble installing anapplication or exporter due to restrictive security or organizational policies,then we recommend you consult open-source documentation for support.
For information about KubeRay, seeKubeRay.For information about setting up KubeRay on Google Kubernetes Engine,see the GKE guide for KubeRay.
Prerequisites
To collect metrics fromthe KubeRay exporterby usingManaged Service for Prometheus and managed collection, your deployment mustmeet the following requirements:
- Your cluster must be running Google Kubernetes Engine version 1.28.15-gke.2475000 or later.
- You must be running Managed Service for Prometheus with managed collection enabled. For more information, see Get started with managed collection.
Set up port forwarding by using the following command:
kubectl -nNAMESPACE_NAME port-forwardPOD_NAME 8080:8080
Access the endpoint
localhost:8080/metricsby using the browseror thecurlutility in another terminal session.
Define a PodMonitoring resource
For target discovery, the Managed Service for Prometheus Operatorrequires a PodMonitoring resource that corresponds tothe KubeRay exporter in the same namespace.
You can use the following PodMonitoring configuration:
# Copyright 2025 Google LLC## Licensed under the Apache License, Version 2.0 (the "License");# you may not use this file except in compliance with the License.# You may obtain a copy of the License at## https://www.apache.org/licenses/LICENSE-2.0## Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and# limitations under the License.apiVersion:monitoring.googleapis.com/v1kind:PodMonitoringmetadata:name:raylabels:app.kubernetes.io/name:rayapp.kubernetes.io/part-of:google-cloud-managed-prometheusspec:endpoints:-port:8080scheme:httpinterval:30spath:/metricsselector:matchLabels:ray.io/is-ray-node:"yes"port andmatchLabels fields match those of the KubeRay pods you want to monitor.To apply configuration changes from a local file, run the following command:
kubectl apply -nNAMESPACE_NAME -fFILE_NAME
You can alsouse Terraformto manage your configurations.
Verify the configuration
You can use Metrics Explorer to verify that you correctly configuredthe KubeRay exporter. It might take one or two minutes forCloud Monitoring to ingest your metrics.
To verify the metrics are ingested, do the following:
In the Google Cloud console, go to theleaderboard Metrics explorer page:
If you use the search bar to find this page, then select the result whose subheading isMonitoring.
- In the toolbar of thequery-builder pane, select the button whose name is eithercode MQL orcode PromQL.
- Verify thatPromQL is selectedin theLanguage toggle. The language toggle is in the same toolbar thatlets you format your query.
- Enter and run the following query:
up{job="ray", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}
View dashboards
The Cloud Monitoring integration includestheRay on GKE Overview dashboard.Dashboards are automatically installed when you configure the integration.You can also view static previews of dashboards without installing theintegration.
To view an installed dashboard, do the following:
In the Google Cloud console, go to the Dashboards page:
If you use the search bar to find this page, then select the result whose subheading isMonitoring.
- Select theDashboard List tab.
- Choose theIntegrations category.
- Click the name of the dashboard, for example,Ray on GKE Overview.
To view a static preview of the dashboard, do the following:
In the Google Cloud console, go to the
Integrations page:If you use the search bar to find this page, then select the result whose subheading isMonitoring.
- Click theKubernetes Engine deployment-platform filter.
- Locate the KubeRay integration and clickView Details.
- Select theDashboards tab.
Troubleshooting
For information about troubleshooting metric ingestion problems, seeProblems with collection from exporters inTroubleshooting ingestion-side problems.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-19 UTC.