-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
52c086d
commit aa663fe
Showing
4 changed files
with
57 additions
and
1 deletion.
There are no files selected for viewing
58 changes: 57 additions & 1 deletion
58
docs/05-administrator-guide/03-operations/09-observability/05-grafana.md
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 |
---|---|---|
@@ -1,7 +1,63 @@ | ||
--- | ||
sidebar_label: Grafana | ||
--- | ||
<!--- | ||
Licensed to the Apache Software Foundation (ASF) under one or more | ||
contributor license agreements. See the NOTICE file distributed with | ||
this work for additional information regarding copyright ownership. | ||
The ASF licenses this file to You under the Apache License, Version 2.0 | ||
(the "License"); you may not use this file except in compliance with | ||
the License. You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
|
||
# 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. |
Binary file added
BIN
+312 KB
...dministrator-guide/03-operations/09-observability/GrafanaOzoneObjectMetrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+496 KB
docs/05-administrator-guide/03-operations/09-observability/GrafanaOzoneOverall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+437 KB
...5-administrator-guide/03-operations/09-observability/GrafanaOzoneRPCMetrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.