apache/kyuubi
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity
bcaff5a3f1
kyuubi/grafana
History
Cheng Pan 6d99b20e04
[KYUUBI #6870][FOLLOWUP] Correct file name of grafana/README.md 
### Why are the changes needed?

Fix a typo of file name.

### How was this patch tested?

Review.

### Was this patch authored or co-authored using generative AI tooling?

No.

Closes #7074 from pan3793/6870-f.

Closes #6870

45915d978 [Cheng Pan] [KYUUBI #6870][FOLLOWUP] Correct file name of grafana/README.md

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2025-05-26 12:48:30 +08:00
..
dashboard-template.json [KYUUBI #6870] Add more metrics for grafana dashboard 2024-12-27 10:24:42 +08:00
README.md [KYUUBI #6870][FOLLOWUP] Correct file name of grafana/README.md 2025-05-26 12:48:30 +08:00

README.md

Kyuubi Grafana Dashboard

Grafana is a popular open and composable observability platform. Kyuubi provides a Grafana Dashboard template dashboard-template.json to help users to monitor the Kyuubi server.

For Users

By default, Kyuubi server enables metrics system and exposes Prometheus endpoints at http://<host>:10019/metrics, to use the Kyuubi Grafana Dashboard, you are supposed to have an available Prometheus and Grafana service, then configure Prometheus to scrape Kyuubi metrics, add the Prometheus data source into Grafana, and then import the dashboard-template.json into Grafana and customize. For more details, please read the Kyuubi Docs

For Developers

If you have good ideas to improve the dashboard, please don't hesitate to reach out to us by opening GitHub Issues/PRs or sending an email to dev@kyuubi.apache.org.

Export Grafana Dashboard template

Depends on your Grafana version, the exporting steps might be a little different.

Use Grafana 11.4 as an example, after modifying the dashboard, save your changes and click the "Share" button on the top-right corner, then choose the "Export" tab and enable the "Export for sharing externally", finally, click the "View JSON" button and update the dashboard-template.json with that JSON content.

We encourage the developers to use a similar version of Grafana to the existing dashboard-template.json, and focus on one topic in each PR, to avoid introducing unnecessary and huge diff of dashboard-template.json. Additionally, to make the reviewers easy to understand your changes, don't forget to attach the current and updated dashboard screenshots in your PR description.