IBM DataPower Operations Dashboard contains an extensive set of parameters that let administrators fine-tune the system's behavior to the installation requirements.
The following sections describe these parameters in detail.
...
Parameter | Category | Default Value | Description |
|---|---|---|---|
Enable Alerts Emails SMTP | Alerts | true | Enable / Disable publishing alerts via SMTP server |
Enable Alerts Web Service | Alerts | false | Enable / Disable publishing alerts via Web Service |
Fields to Ignore in ElasticSearch Response in Alerts | Alerts | doc_count_error_upper_bound,sum_other_doc_count | Field to omit from alert description |
Enable Queries Output File | Alerts | false | Enable / Disable publishing alerts as file in local file system |
Syslog Severity Field Value | Alerts | info | Syslog record message level. |
Alerts Syslog Server Hostname | Alerts | Syslog server hostname or IP address. | |
Alerts Syslog Server Port | Alerts | Syslog server listening port. | |
Alerts HTTP Headers | Alerts | Several static Static HTTP headers can be that are added to all alerts (e.g.: "Authorization: ****", "User-Agent: abc", etc.). | |
Alerts HTTP Aggregated Request | Alerts | true | Alerts can be sent as single HTTP requests (a single alert per HTTP request) or as aggregated requests (all alerts that were generated from the same execution will be sent in a single HTTP request as an array of alerts). |
Alerts HTTP URL | Alerts | URL (supported protocols are HTTP and HTTPS) which will be used as the endpoint for the alert HTTP request. The request will be a POST request. | |
Alerts JSON Additional Fields | Alerts | Several static Static fields (of type String) can be that are added to all alerts (e.g.: "systemId": "dpod-system-123"). | |
Alerts JSON Fields Rename | Alerts | Any field can be renamed Allows renaming fields (e.g.: rename "description" to "details"). |
...
Parameter | Category | Default Value | Description |
|---|---|---|---|
From Address | from@example.com | The from address used for the report email. | |
SMTP Host | Email SMTP | smtp.example.com | Destination SMTP host |
SMTP Password | Email SMTP | Password for logging in to the SMTP host. If no authentication required leave this field empty. | |
SMTP Port | Email SMTP | 465 | Destination SMTP host port |
SMTP User | Email SMTP | mailer@example.com | Username for logging in to the SMTP host. If no authentication required leave this field empty. |
SMTP SSL Enabled | Email SMTP | true | Enable / Disable TLS/SSL |
Alerts/Reports Web Service Endpoint URI | Alerts/Reports Web Service | /SMTPSender | Destination URI for sending reports via Web-Service |
Alerts/Reports Web Service Host | Alerts/Reports Web Service | localhost | Destination hostname for sending reports via Web-Service |
Alerts/Reports Web Service Port | Alerts/Reports Web Service | 8080 | Destination port for sending reports via Web-Service |
Alerts/Reports Web Service Protocol | Alerts/Reports Web Service | HTTP | Protocol for accessing the Web-Service host Valid values: HTTP / HTTPS |
Alerts/Reports Web Service User | Alerts/Reports Web Service | user | User used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. |
Alerts/Reports Web Service Password | Alerts/Reports Web Service | Password used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. | |
...
Parameter | Category | Default | Description |
|---|---|---|---|
Internal Alerts - Send Email on Alert | Health | false | Whether or not to send an Email when a problem was detected by the internal health monitoring |
Internal Alerts - Email Destination Address for Alerts | Health | No Default | Destination Email address for sending internal health alerts |
Internal Alerts - Send Syslog HTTP on Alert | Health | false | Whether or not to send a Syslog message message via an HTTP request (JSON format) when a problem was detected by the internal health monitoring |
Internal Alerts - Send Syslog on Alert (JSON Format) | Health | false | Whether or not to send a Syslog message (JSON format) when a problem was detected by the internal health monitoring |
Internal Alerts - Send Syslog on Alert (Legacy Format) | Health | false | Whether or not to send a Syslog message (Legacy format) when a problem was detected by the internal health monitoring |
Internal Alerts - Send Email on Alert via Web Service | Health | false | Whether or not to send an Email via Web Service when a problem was detected by the internal health monitoring |
Object Status Monitor Class List (All, Default or a Custom List) | Health | Default | By default, the Failed Objects dashboard (under the "explore" menu) displays only common object classes, |
Internal Alerts - Log Target Down Domains to Ignore | Health | No Default | A list of comma separated domains to ignore when log targets are down so no internal alerts will be sent for those domains. |
...
Parameter | Category | Default | Description |
|---|---|---|---|
Enable Api-Stats Category Mode | Transactions | false | |
Allow Monitoring Transactions in Default Domain | Transactions | false | Whether or not the "Support TX in the Default Domain" box will be displayed in the Monitored Devices→Setup page |
Show Custom Transaction View Selection | Transactions | false | Whether or not the "Custom TX View" checkbox will be displayed in the Product Views |
Default Transactions Source (syslog/logical) | Transactions | syslog | If the "Custom TX View" is displayed, what will be the default for users on their first sign in. |
Logical Transaction, Custom String 1 Table Header | Transactions | Custom String 1 | The Table Header and Filter names for "Custom String 1" in the transactions page |
Logical Transaction, Custom String 2 Table Header | Transactions | Custom String 2 | The Table Header and Filter names for "Custom String 2" in the transactions page |
Transaction Analysis Level - User Override Path | Transactions | (blank) | Where to take the user override file for the syslog analysis message groups, no value (blank) means there is no override file |
Transaction Analysis Level - Max TPS | Transactions | Core, MemoryReqRes, B2B, error | The message group names and log level for the Max TPS analysis level, |
Transaction Analysis Level - More TPS | Transactions | Core, MemoryReqRes, B2B, notice | The message group names and log level for the More TPS analysis level, |
Transaction Analysis Level - Balanced | Transactions | Core, MemoryReqRes, B2B, MemActionLevel, notice | The message group names and log level for the Balanced analysis level, |
Transaction Analysis Level - More Data | Transactions | Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, info | The message group names and log level for the More Data analysis level, |
Transaction Analysis Level - Max Data | Transactions | Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, Sidecalls, info | The message group names and log level for the Max Data analysis level, |
Size of next/previous transaction results | Transactions | default | The size of next/previous transaction results. |
Miscellaneous Parameters
The following parameters control various other functions.
...