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.
...
Field | Description |
---|---|
Alert Type | The alert type (more information about the alert types can be found in the the Alerts page) |
Description | 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 OpenSearch index sets will be queried |
Document Types | (Hidden by default) Which OpenSearch document types will be queried |
Query (JSON) | (Hidden by default) An OpenSearch query (see Query DSL and Aggregations for more information on how to build a query). |
Parameters (JSON) | (Hidden by default) Named parameters to replace placeholders in the query. i.e: |
Investigate URI | An investigate link, included in the alert results, and displays the data that triggered each alert in DPOD Web Console. |
Aggs to Ignore | Delimited list of aggregation names to ignore in results. |
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" and "Frequency" |
Value List | Only applicable for alert type "List" - the list of values delimited by the delimiter specified in the "delimiter" field |
Final results list | Only applicable for alert type "Frequency" - the list of values always returned in results, delimited by the delimiter specified in the "delimiter" field |
List Delimiter | The delimiter used to delimit the value list and the final result list |
Alert Filters Section
The Alert Filters section lets you specify additional criteria for the alert's query according to the product type and document type
Field | Field Name for REST API | Description | Applicable Product Type |
---|---|---|---|
Device | deviceName | Which DataPower devices the alert's query should check | Gateway/API-C |
Domain | domainName | Which DataPower domains the alert's query should check | Gateway/API-C |
Client IP | clientIp | Which Client IP’s the alert's query should check | Gateway/API-C |
Service | serviceName | Which DataPower services the alert's query should check | Gateway |
Catalog | apicCatalogName | Which API-C catalog names the alert's query should check | API-C |
Space | apicSpaceName | Which API-C space names the alert's query should check | API-C |
Product | apicProductName | Which API-C product names the alert's query should check | API-C |
Plan | apicPlanName | Which API-C plan names the alert's query should check | API-C |
API Name | apicApiName | Which API-C names the alert's query should check | API-C |
API Version | apicApiVersion | Which API-C versions the alert's query should check | API-C |
App Name | apicConsumerAppName | Which API-C names the alert's query should check | API-C |
...