Monitoring with Prometheus and Grafana
This app provides an instant HyperCloud dashboard as a VM making use of hc-exporter. Prometheus and Grafana are automatically configured with inputs provided by the user during setup.
What are Prometheus and Grafana?
Prometheus collects monitoring metrics and data from various sources and stores it in a time-series database, which can be queried with PromQL, Prometheus' query language.
hc-exporter provides the HTTP endpoint for Prometheus to scrape data from.
Grafana can visualize the data collected by Prometheus, and many other sources to provide real-time, interactive dashboards.
Both Grafana and Prometheus can be configured to send alerts when specific conditions are met, such as when a server's resource usage exceeds a defined threshold
hc-exporter with Prometheus and Grafana provides a powerful monitoring solution for HyperCloud, with strong analysis and alerting capabilities.
Import the App to HyperCloud
In HyperCloud, go to Storage > Marketplaces and select the SoftIron Marketplace.
Select the Apps tab, then select the HyperCloud Monitoring App, and click the import button
The VM image and templates are downloaded and added to HyperCloud.
Start an instance of the app
In HyperCloud, go to Templates > VMs. Select the HyperCloud Monitoring App and click Instantiate
Configure the VM as needed, paying special attention to Custom Attributes and Networking:
Custom Attributes
Check the user's privileges
The credentials provided here should be an existing user with access to see everything in HyperCloud Metrics that this user doesn't have access to will not be collected, so the summed totals will be incorrect.
HyperCloud Exporter Configuration
| Variable | Usage |
|---|---|
| Cluster Name | Name of your HyperCloud instance |
| XML-RPC URL | HyperCloud API endpoint |
| Username | HyperCloud Auth |
| Password | HyperCloud Auth |
| Log Level | Verbosity of hc-exporter |
| Force HTTPS | Set false to skip HTTPS Verification on XML-RPC |
Grafana Configuration
| Variable | Usage |
|---|---|
| Grafana Admin Username | Sets Grafana admin username |
| Grafana Admin Password | Sets Grafana admin password |
| Enable Anonymous Dashboard Viewing | Allows read only access to Grafana dashboard with no authentication |
Networking
Add an interface and select a network where HyperCloud is accessible
Configure the security group :
| Port | Usage |
|---|---|
| 3000 | Incoming to Grafana Web UI |
| 2634 | Outgoing to HyperCloud XML-RPC |
| 9090 | Optional. Incoming to Prometheus Web UI |
| 9000 | Optional. Incoming to hc-exporter endpoint |
| 22 | Optional. Incoming SSH |
The Optional ports here are only used by the app on localhost. You can choose to expose them if desired. All networking is TCP.
Start the VM
Once configured, start the VM, wait a minute for it to configure itself and Grafana should become available on port 3000.