diff --git a/docs/05-administrator-guide/03-operations/09-observability/05-grafana.md b/docs/05-administrator-guide/03-operations/09-observability/05-grafana.md index 43b200c9f..cdba93c8d 100644 --- a/docs/05-administrator-guide/03-operations/09-observability/05-grafana.md +++ b/docs/05-administrator-guide/03-operations/09-observability/05-grafana.md @@ -1,7 +1,73 @@ --- sidebar_label: Grafana --- + # Dashboarding With Grafana -**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section. +Once Prometheus is up and running, Grana can be configured to monitor and +visualize Ozone metrics. + +## Add Prometheus as a data source + +In the Grafana web UI, go to `Add Data Sources` and then select `Prometheus`. + +Enter the Prometheus hostname/port in the `HTTP`. For example, `http://localhost:9094` +(verify the port used by looking at Prometheus command line flags `-web.listen-address`. +The port can also be found from Prometheus web UI → Status → Command-Line Flags.) + +Choose Prometheus type: `Prometheus` + +Choose Prometheus version: `2.37.x` + +Finish the setup by clicking on `Save and Test`. + +## Import a Grafana dashboard for Ozone + +Apache Ozone comes with a default Grafana dashboard. Follow the instructions +below to import it: + +Download dashboard JSON: + +```shell +wget https://raw.githubusercontent.com/apache/ozone/master/hadoop-ozone/dist/src/main/compose/common/grafana/dashboards/Ozone%20-%20Overall%20Metrics.json +``` + +Open Grafana portal and click on Dashboards on the left and select `Import`. + +Click at `Upload JSON file` and select the file `Ozone - Overall Metrics.json` +that was just downloaded. + +The dashboard is now imported. + +![Overall dashboard](GrafanaOzoneOverall.png) + +Repeat the same for [Object Metrics](https://raw.githubusercontent.com/Xushaohong/ozone/master/hadoop-ozone/dist/src/main/compose/common/grafana/dashboards/Ozone%20-%20Object%20Metrics.json) +dashboard and [RPC Metrics](https://raw.githubusercontent.com/Xushaohong/ozone/master/hadoop-ozone/dist/src/main/compose/common/grafana/dashboards/Ozone%20-%20RPC%20Metrics.json) +dashboard. + +![Object dashboard](GrafanaOzoneObjectMetrics.png) + +![RPC dashboard](GrafanaOzoneRPCMetrics.png) + +More dashboards are constantly being added. Check out the [dashboard repo](https://github.com/apache/ozone/tree/master/hadoop-ozone/dist/src/main/compose/common/grafana/dashboards) +for more. + +Check out the official Grafana doc [Monitor Apache Ozone with Prometheus and Grafana +Cloud](https://grafana.com/docs/grafana-cloud/send-data/metrics/metrics-prometheus/prometheus-config-examples/the-apache-software-foundation-apache-ozone/) +for more details. diff --git a/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneObjectMetrics.png b/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneObjectMetrics.png new file mode 100644 index 000000000..d0342fe8c Binary files /dev/null and b/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneObjectMetrics.png differ diff --git a/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneOverall.png b/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneOverall.png new file mode 100644 index 000000000..5fbf95f7a Binary files /dev/null and b/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneOverall.png differ diff --git a/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneRPCMetrics.png b/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneRPCMetrics.png new file mode 100644 index 000000000..bd10845f6 Binary files /dev/null and b/docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneRPCMetrics.png differ