The Setup Alerts page shows details about existing system alerts associated to the current product view, and lets you edit them and create new alerts.
...
Column | Description | ||
|---|---|---|---|
Name | The alert's name, click on the name to go to the Alert details Page - you can edit the alert from there. | ||
Description | A description of the alert - displays the "Query Value" field of the alert. | ||
Enabled | Shows whether or not the alert execution will be scheduled to run (this is a read only field, you can change it by editing the alert). | ||
System Health Metric | Shows whether or not the alert is a metric. | ||
Schedule | When an alert execution will be scheduled -.
| ||
Recipients | "Syslog" and/or the email addresses of the recipients for the alert publishing. |
Alert Details page
The top part displays the following fields:
Field | Description |
|---|---|
Enabled | Whether or not the alert will be scheduled for execution. |
System Health Metric | Whether or not the alert is a metric. |
Description | A description of the alert -displays the value of the "Query Value" field of the alert. |
Product | Product Type |
Schedule | When an alert execution will be scheduled (if the alert is not enabled the alert will not be scheduled). |
REST URL | The URL to run use in REST API to perform actions on the alert via REST, see Alerts REST API from more details. |
Recipients | "Syslog" and/or the email addresses of the recipients for the alert publishing. |
The top part of the page also contains three buttons:
Test - Execute the alert immediately, the alert will be executed even if it's disabled, this is helpful in case you want to check the alert before actually scheduling it.
Edit - Edit the alert
Delete - Delete the alert
...
Field | Description |
|---|---|
Executing User | SCHEDULER - if DPOD run an alert execution via the scheduler. REST - if the alert was run via the REST API. User name - if a user tested the alert by pressing the "Test" button. |
Status | The execution status. |
Status Time | When the status was set. |
Message | How many alerts were generated (or an error message if a problem occurred). |
Add / Edit Alert
The first section contains details about the execution of the alert
...
Field | Description | Applicable Product Type |
|---|---|---|
Device | Which DataPower devices the alert's query should check | Gateway/API-C |
Domain | Which DataPower domains the alert's query should check | Gateway/API-C |
Service | Which DataPower services the alert's query should check | Gateway |
Catalog | Which API-C catalog names the alert's query should check | API-C |
Space | Which API-C space names the alert's query should check | API-C |
Product | Which API-C product names the alert's query should check | API-C |
Plan | Which API-C plan names the alert's query should check | API-C |
API Name | Which API-C names the alert's query should check | API-C |
API Version | Which API-C versions the alert's query should check | API-C |
App Name | Which API-C names the alert's query should check | API-C |
...