The Setup Alerts page shows details about existing system alerts, and lets you edit them and create new alerts.
...
The top part displays the following fields:
Field | Description | ||
---|---|---|---|
Schedule | When an alert executionEnabled | Whether or not the alert will be scheduled | (iffor execution |
System Health Metric | Whether or not the alert is | not enabled the alert will not be scheduled)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 the alert via REST | ||
Recipients | "Syslog" and/or the email addresses of the recipients for the alert publishing |
...
The first section contains details about the execution of the alert
Field | Description |
---|---|
Enabled | Whether or not the alert will be scheduled for execution |
System Health Metric | Whether or not the alert is a metric |
Name | The Alert's name |
Product | Gateway or API-C |
Schedule | When the alert will be scheduled, the format is identical to the one used to schedule reports |
Destination | Specify the alert publishing destinations: Email - send an email (make sure that "Enable Queries Emails SMTP" is set to true inthe System Parameters page) Email WS - send an email via webservice (make sure that "Enable Queries Emails SMTP WS" is set to true inthe System Parameters page) |
Recipients | if the destination is Email or Email WS - this field will contain the list of recipients |
The Alert Details section contains information about how the alert's query will be evaluated
Field | Description |
---|---|
Type | The alert type (more information about the alert types can be found in the the Alerts page) |
Query Value | Free text, describes the results returned by the alert's query Press the "Details" button to view the alert query itself |
Index Sets | (Hidden by default) Which ElasticSearch index sets will be queried |
Document Types | (Hidden by default) Which ElasticSearch document types will be queried |
Query (JSON) | (Hidden by default) An ElasticSearch query |
Parameters (JSON) | (Hidden by default) Named parameters to replace placeholders in the query. i.e: |
Query Period | The time frame for the alert's query |
Operator | Operator for the alert's query |
Threshold | The value to compare the query's result to (not applicable for alert types "any" and "list" |
Field Name | Only applicable for alert type "list" |
Value List | Only applicable for alert type "list" - the list of values delimited by the delimiter specified in the "delimiter" field |
...
The Alert Filters section lets you specify additional criteria for the alert's query query according to the product type and document type
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 |