This section explains how to configure Qumulo Alerts to generate alarms and alerts.
Configuring Monitoring for a Qumulo Cluster
To configure Qumulo Alerts to connect to, and collect data from a Qumulo cluster, you must edit QumuloAlerts.json
, located in the config/alerts
directory, in the directory that you cloned from GitHub.
The following is an explanation of the JSON keys that configure Qumulo cluster monitoring.
Name | Description |
---|---|
cluster_name |
The fully qualified domain name (FQDN) for your Qumulo cluster |
cluster_port |
The port for communicating with the Qumulo REST API, 8000 by default |
frequency |
The time period between each plugin's execution, including the unit (seconds or minutes) and value, that applies to all plugins in a category without a specific frequency, 60 seconds by default You can configure a distinct frequency for each category of alarm or alert. |
monitor |
An array of notifications to which a user subscribes
For a list of available alarm and alert plugin names, see What Alarms and Alerts Qumulo Alerts Supports. |
nlb |
Network load balancer: when set to To prevent spreading the load of a plugin's API requests across all nodes in a Qumulo cluster, each alarm or alert plugin that you configure communicates with your cluster by using either a network load balancer or floating IPs. Important
You can configure one—but not both—of these communication methods. |
user_token |
The long-lived access token for communicating with the Qumulo REST API |
Example: Monitoring Alarms for Disks and Nodes on a Single Cluster
[{
"cluster_name": "test-cluster.corp.example.com",
"cluster_port": 8000,
"user_token": "access-v1:abcdefgh1234567...",
"nlb": false,
"frequency": {"seconds": 60},
"monitor": [{
"category": "Alarms",
"subcategory": ["Disks", "Nodes"],
"enabled": true
}]
}]
Example: Monitoring Alarms for Disks and Nodes and All Alerts on a Single Cluster
In the following example, the wildcard *
specifies every plugin available in this category.
[{
"cluster_name": "test_cluster.corp.example.com",
"cluster_port": 8000,
"user_token": "access-v1:abcdefgh1234567...",
"nlb": false,
"frequency": {"seconds": 60},
"monitor": [{
"category": "Alarms",
"subcategory": ["Disks", "Nodes"],
"enabled": true
},{
"category": "Alerts",
"subcategory": ["*"],
"frequency": {"minutes": 5},
"enabled": true
}]
}]