Monitoring and Reports

Select a cluster and then click on Monitor, present on the left sidebar, this displays the granular details of OpenEBS volumes such as Storage Capacity, Total capacity of all volumes, IOPS of all volumes, Throughput of all volumes.  
The granular details of a particular OpenEBS volume can be viewed by clicking the Volume Analytics icon displayed parallel (towards the end)to volume details, it redirects you to the dashboard(as shown in the image below) where more details of the OpenEBS volume can be obtained.

Monitoring of all OpenEBS volume from any cloud can be seen from Cross-Cloud Monitoring section from the Project page. The main advantage of this dashboard is that it shows the granular details such as IOPS, throughput, Block Size for both Read and Write operations, Latency for both Read and Write operations and Storage Usage of an OpenEBS volume by selecting the required OpenEBS PVC in the selected cluster. Required OpenEBS volume can be selected by choosing the corresponding cluster and OpenEBS PVC. The range for displaying the monitoring metrics can be customized using the range button. The default value configured is for last 1 hour period with 1 minute refresh interval.   

This dashboard can be shared and saved using the share and Save buttons present int the top right corner(encircled in the image below).

The Storage pool dashboard can be accessed from inside the cluster. Select Pools section displayed on the left sidebar. This page gives an overview of the existing pools, their statuses, nodes on which they are deployed, CAS used and capacity. Each storage pool dashboard can be accessed by clicking on Pool analytics icon present towards the end of the Pool details. This dashboard will give granular details of the corresponding storage pool. By clicking on the Topology view, all cStor Pool components connectivity diagram and its detailed information can be viewed. It is also possible to get inside the container of storage pool from this page by selecting pool pod from the topology view. Pool analytics dashboard will help to track the usage of cStorStoragePool pods and its functionality. The Storage pool dashboard provides all the details of all cStorStoragePools in the cluster. From this dashboard, the granular details of cStorStoragePool such as Pool Name, Associated cluster, SPC name, Capacity Usage of the Pool, Pool replication count, IO in bytes, IOPS count, Latency, Sync count and Sync Latency. The range can be customized with the specified date range or the quick ranges displayed on the console. You can also compare metrics of more than one pool in a spc by clicking on the spc name within the Storage pool dashboard. It will show the metrics of all the pool in a spc, you can select any no. of pools and do a comparison. Similarly, by clicking on Logs icon, logs of the corresponding pool pod can be accessed. This will make easier for going through the logs to get the current and past event information using a single click.

Currently, Director Online supports monitoring of 6 applications: CockroachDB, Elasticsearch, Minio, MySQL, PostgreSQL, and Redis. Few applications such as Minio and CoackroachDB expose metrics by default whereas for others (MYSQL, PostgreSQL, Redis, Elasticsearch) we need an external exporter to expose metrics.
Steps to monitor Minio and CockroachDB:

Note: Make sure the pod has all the labels that are present in the application (deployment/Statefulset)

First, connect your cluster to DirectorOnline. You can do this by following the steps described here. After connecting your cluster to DO, you should find yourself at the "Overview" page. 


All your applications will be listed here.

1. Click on the desired application. In this example, we will enable monitoring for CockroachDB. 
2. Now go to Analytics and select "Enable Analytics" 
3. Wait for a while (it may take up to 5 minutes), and you will see a small dashboard in front of you. To view additional graphs, click on "View More" in the bottom right corner of the panel.  
   Similarly, you can enable metrics for the MinIO application. While enabling metrics you need to provide a  bearer-token for prometheus. Click here to know the steps to generate this token.  

For applications like Elasticsearch, MySQL, PostgreSQL, and Redis an external exporter to expose metrics is needed. Director Online currently supports 4 such applications. They are - Elasticsearch, MySQL, PostgreSQL, and Redis. Let's now show how to enable metrics for these applications. We will use MySQL for this example.

1. Click on MySQL from the application list. 
2. Go to Analytics and select "Enable Analytics," then enter the required details like username, password, etc., in the form, and click on "Submit". 
3. Wait for a period of time (it may take up to 5 minutes) and you will see a small dashboard in front of you. Again, you can view additional graphs by clicking on the "View More" button located in the bottom right corner of the panel. 
4. If you entered the wrong details of the application in the form, you could edit your entries back from the Analytics tab on the top right corner of the panel. It may also take up to 5 minutes for the changes to be reflected. If you don't want the metrics anymore, you can delete the analytics as well. 

Likewise, you can enable monitoring for other applications:

Elasticsearch:

Note: For Elasticsearch applications, you need to input data in the username and password field if the application does not have any authentication.

Redis:

Note: For Redis applications, you can leave the password field empty if the application does not require any password.

PostgreSQL:

One more fantastic feature that Director provides is the ability to generate and download a Report of your dashboards. Click on the Report button located in the top right panel of the dashboard, and you should get your graphs in PDF format.