-
Notifications
You must be signed in to change notification settings - Fork 935
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[KYUUBI #5834] Add Grafana dashboard template
### _Why are the changes needed?_ This PR adds a basic Grafana Dashboard template, also updates the metrics docs to guide users to use Prometheus and Grafana to monitor the Kyuubi server. The Grafana Dashboard template is exported from the Grafana OSS v11.4.0 ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate <img width="1484" alt="image" src="https://github.com/user-attachments/assets/417b35fa-cd12-4e51-b73f-2955282aa187" /> - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/contributing/code/testing.html#running-tests) locally before make a pull request Closes #5147 from zhaohehuhu/Improvement-0809. Closes #5834 f6fc2d7 [Cheng Pan] fix style 465f054 [Cheng Pan] update dashboard 3fa2d23 [hezhao2] add status chart 4b2bd3d [hezhao2] add status chart 185f2cc [hezhao2] make it compatible with kyuubi 1.8 457085b [hezhao2] add REAMDE.md to guide users 45e3ba3 [hezhao2] add docker file build a grafana image and load dashboards available dbc2210 [hezhao2] Add Grafana dashboard template Lead-authored-by: hezhao2 <hezhao2@cisco.com> Co-authored-by: Cheng Pan <chengpan@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
1 parent
1d1e8a0
commit 7e8275b
Showing
4 changed files
with
2,349 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Kyuubi Grafana Dashboard | ||
|
||
[Grafana](https://grafana.com/) 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](https://kyuubi.readthedocs.io/en/master/monitor/metrics.html#grafana-and-prometheus) | ||
|
||
## For Developers | ||
|
||
If you have good ideas to improve the dashboard, please don't hesitate to reach out to us by opening | ||
GitHub [Issues](https://github.com/apache/kyuubi/issues)/[PRs](https://github.com/apache/kyuubi/pulls) | ||
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. |
Large diffs are not rendered by default.
Oops, something went wrong.