kyuubi/docker/playground
hezhao2 7e8275b7b4
[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

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>
2024-12-24 10:30:50 +08:00
..
conf [KYUUBI #5944] Introduce Prometheus and Grafana for Kyuubi Playground 2024-01-15 13:49:00 +08:00
grafana/datasource [KYUUBI #5944] Introduce Prometheus and Grafana for Kyuubi Playground 2024-01-15 13:49:00 +08:00
image [KYUUBI #5266] Upgrade playground to Kyuubi 1.7.1 2023-09-11 11:13:05 +00:00
prometheus [KYUUBI #5944] Introduce Prometheus and Grafana for Kyuubi Playground 2024-01-15 13:49:00 +08:00
script [KYUUBI #3881] Upgrade playground components to latest versions 2022-12-02 10:51:41 +08:00
.env [KYUUBI #5834] Add Grafana dashboard template 2024-12-24 10:30:50 +08:00
build-image.sh [KYUUBI #4215] Remove useless build-arg CLICKHOUSE_JDBC_VERSION 2023-02-01 20:37:36 +08:00
compose.yml [KYUUBI #5944] Introduce Prometheus and Grafana for Kyuubi Playground 2024-01-15 13:49:00 +08:00
README.md [KYUUBI #5944] Introduce Prometheus and Grafana for Kyuubi Playground 2024-01-15 13:49:00 +08:00

Playground

For Users

Setup

  1. Install Docker and Docker Compose;
  2. Go to docker/playground, and use docker compose up -d to run compose services as daemon;

Play

  1. Connect using beeline

docker exec -it kyuubi /opt/kyuubi/bin/beeline -u 'jdbc:hive2://0.0.0.0:10009/tpcds/tiny';

  1. Connect using DBeaver

Add a Kyuubi datasource with

  • connection url jdbc:hive2://0.0.0.0:10009/tpcds/tiny
  • username: anonymous
  • password: <empty>
  1. 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, run docker 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, run docker 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

Shutdown

  1. Stop compose services by docker compose down;

For Maintainers

Build

  1. Build images docker/playground/build-image.sh;
  2. Optional to use buildx to build and publish cross-platform images BUILDX=1 docker/playground/build-image.sh;