Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Grafana][Observability] Embed Grafana dashboard panels into Ray dashboard #1278

Merged
merged 7 commits into from
Aug 1, 2023

Conversation

kevin85421
Copy link
Member

@kevin85421 kevin85421 commented Jul 28, 2023

Why are these changes needed?

  • Replace dashboard_default.json with default_grafana_dashboard.json (generated by Ray 2.5.0)

  • install/prometheus/install.sh & overrides.yaml: Pin the kube-prometheus-stack chart to version v48.2.1 and create the chart using overrides.yaml to configure Grafana. This will enable the embedding of Grafana dashboard panels into the Ray dashboard.

  • ray-cluster.embed-grafana.yaml: An example YAML file to demonstrate embedding

Related issue number

Closes #1020

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

@kevin85421 kevin85421 changed the title [Grafana][Observability] Embed Grafana dashboard panels into Ray dashboard [WIP][Grafana][Observability] Embed Grafana dashboard panels into Ray dashboard Jul 28, 2023
"schemaVersion": 27,
"style": "dark",
"tags": [
"rayVersion:2.5.0"
Copy link

Choose a reason for hiding this comment

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

should this be 2.6.1?

It has some differences from the default dashboard generated automatically from 2.6.1

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, that's why I mentioned that manually importing the dashboard, as stated in the "TODO: Note that importing the dashboard manually is not ideal", isn't ideal. We should find a way to import the Grafana dashboard automatically in the future. I added some sentences to describe it b94b5d6. Does the change make sense to you?

@kevin85421 kevin85421 changed the title [WIP][Grafana][Observability] Embed Grafana dashboard panels into Ray dashboard [Grafana][Observability] Embed Grafana dashboard panels into Ray dashboard Jul 31, 2023
@kevin85421 kevin85421 marked this pull request as ready for review July 31, 2023 20:14
@kevin85421 kevin85421 requested a review from alanwguo July 31, 2023 20:14
@kevin85421
Copy link
Member Author

cc @alanwguo would you mind reviewing this PR? Thanks!

* Note that we do not deploy Grafana in the head Pod, so we need to set both `RAY_GRAFANA_IFRAME_HOST` and `RAY_GRAFANA_HOST`.
`RAY_GRAFANA_HOST` is used by the head Pod to send health-check requests to Grafana in the backend.
`RAY_GRAFANA_IFRAME_HOST` is used by your browser to fetch the Grafana panels from the Grafana server rather than from the head Pod.
Because we forward the port of Grafana to `127.0.0.1:3000` in this example, we set `RAY_GRAFANA_IFRAME_HOST` to `http://127.0.0.1:3000`.
Copy link

Choose a reason for hiding this comment

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

should we include instructions that if user does not want to port-forward, they should set up an ingress?

Copy link
Member Author

Choose a reason for hiding this comment

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

We have instructions for setting up the ingress for the Ray dashboard. Setting up the ingress for Grafana seems to be beyond the scope of KubeRay. How about adding https://grafana.com/tutorials/run-grafana-behind-a-proxy/ to the doc?

Copy link
Member Author

Choose a reason for hiding this comment

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

Add the link in 7362c58. Does it make sense to you? Thx!

@kevin85421 kevin85421 merged commit 627f529 into ray-project:master Aug 1, 2023
18 checks passed
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
…board (ray-project#1278)

Embed Grafana dashboard panels into Ray dashboard
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.

[Docs] Improve metrics/grafana docs to include info on how to utilize the new Ray dashboard features.
3 participants