### _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 f6fc2d71e [Cheng Pan] fix style 465f0546a [Cheng Pan] update dashboard 3fa2d237e [hezhao2] add status chart 4b2bd3dbc [hezhao2] add status chart 185f2cccf [hezhao2] make it compatible with kyuubi 1.8 457085be5 [hezhao2] add REAMDE.md to guide users 45e3ba3e5 [hezhao2] add docker file build a grafana image and load dashboards available dbc22108b [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> |
||
|---|---|---|
| .. | ||
| conf | ||
| grafana/datasource | ||
| image | ||
| prometheus | ||
| script | ||
| .env | ||
| build-image.sh | ||
| compose.yml | ||
| README.md | ||
Playground
For Users
Setup
- Install Docker and Docker Compose;
- Go to
docker/playground, and usedocker compose up -dto run compose services as daemon;
Play
- Connect using
beeline
docker exec -it kyuubi /opt/kyuubi/bin/beeline -u 'jdbc:hive2://0.0.0.0:10009/tpcds/tiny';
- Connect using DBeaver
Add a Kyuubi datasource with
- connection url
jdbc:hive2://0.0.0.0:10009/tpcds/tiny - username:
anonymous - password:
<empty>
- Use built-in dataset
Kyuubi supply some built-in dataset, after Kyuubi started, you can run the following command to load the different datasets:
- For loading TPC-DS tiny dataset to
spark_catalog.tpcds_tiny, rundocker exec -it kyuubi /opt/kyuubi/bin/beeline -u 'jdbc:hive2://0.0.0.0:10009/' -f /opt/load_data/load-dataset-tpcds-tiny.sql - For loading TPC-H tiny dataset to
spark_catalog.tpch_tiny, rundocker exec -it kyuubi /opt/kyuubi/bin/beeline -u 'jdbc:hive2://0.0.0.0:10009/' -f /opt/load_data/load-dataset-tpch-tiny.sql
Access Service
- MinIO: http://localhost:9001
- PostgreSQL localhost:5432 (username: postgres, password: postgres)
- Spark UI: http://localhost:4040 (available after Spark application launching by Kyuubi, port may be 4041, 4042... if you launch more than one Spark applications)
- Prometheus: http://localhost:9090
- Grafana: http://localhost:3000 (username: admin, password: admin)
Shutdown
- Stop compose services by
docker compose down;
For Maintainers
Build
- Build images
docker/playground/build-image.sh; - Optional to use
buildxto build and publish cross-platform imagesBUILDX=1 docker/playground/build-image.sh;