feat: initial configuration for grafana dashboard (#3263)

* feat: initial configuration for grafana dashboard Signed-off-by: Ruihang Xia <[email protected]> * fix typo Signed-off-by: Ruihang Xia <[email protected]> * lift up dir Signed-off-by: Ruihang Xia <[email protected]> * update readme Signed-off-by: Ruihang Xia <[email protected]> * add paths to CI config Signed-off-by: Ruihang Xia <[email protected]> * tweak config details Signed-off-by: Ruihang Xia <[email protected]> * add OpenDAL traffic panel Signed-off-by: Ruihang Xia <[email protected]> * remove sync count Signed-off-by: Ruihang Xia <[email protected]> * Update grafana/README.md --------- Signed-off-by: Ruihang Xia <[email protected]>
GreptimeTeam · Jan 30, 2024 · e0e6351 · e0e6351
1 parent 0a9361a
commit e0e6351
Show file tree

Hide file tree

Showing 5 changed files with 2,417 additions and 0 deletions.
diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -9,6 +9,7 @@ on:
       - '.dockerignore'
       - 'docker/**'
       - '.gitignore'
+      - 'grafana/**'
   push:
     branches:
       - main
@@ -19,6 +20,7 @@ on:
       - '.dockerignore'
       - 'docker/**'
       - '.gitignore'
+      - 'grafana/**'
   workflow_dispatch:
 
 name: CI

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -9,6 +9,7 @@ on:
       - '.dockerignore'
       - 'docker/**'
       - '.gitignore'
+      - 'grafana/**'
   push:
     branches:
       - main
@@ -19,6 +20,7 @@ on:
       - '.dockerignore'
       - 'docker/**'
       - '.gitignore'
+      - 'grafana/**'
   workflow_dispatch:
 
 name: CI

diff --git a/README.md b/README.md
@@ -133,6 +133,10 @@ To write and query data, GreptimeDB is compatible with multiple [protocols and c
 - [GreptimeDB Rust Client](https://github.com/GreptimeTeam/greptimedb-client-rust)
 - [GreptimeDB JavaScript Client](https://github.com/GreptimeTeam/greptime-js-sdk)
 
+### Grafana Dashboard
+
+Our official Grafana dashboard is available at [grafana](./grafana/README.md) directory.
+
 ## Project Status
 
 This project is in its early stage and under heavy development. We move fast and

diff --git a/grafana/README.md b/grafana/README.md
@@ -0,0 +1,10 @@
+Grafana dashboard for GreptimeDB
+--------------------------------
+
+GreptimeDB's official Grafana dashboard.
+
+Status notify: we are still working on this config. It's expected to change frequently in the recent days. Please feel free to submit your feedback and/or contribution to this dashboard 🤗
+
+# How to use
+
+Open Grafana Dashboard page, choose `New` -> `Import`. And upload `greptimedb.json` file.