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 Queries Emails SMTP | Alerts | true | Enable / Disable publishing alerts via SMTP server |
Enable Queries Emails SMTP WS | 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. Possible values: debug, info, notice, warning, err, crit, alert, emerg |
Alerts Syslog Server Hostname | Alerts | 172.77.77.7 | Syslog server hostname or IP address. |
Alerts Syslog Server Port | Alerts | 60031 | Syslog server listening port. |
...
Parameter | Category | Default Value | Description |
---|---|---|---|
IDG Transactions Page Columns | Dashboards | Service Name, Operation, Time, Device, Domain, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload | Controls which columns will appear in the Investigate->Transactions Page, you can omit or reorder the columns. Any mistakes in the input will cause the display to revert to the default value. The Payload field will not appear to users that does not have authorization to view payloads Possible values (not case sensitive): Service Name, Operation, Time, Device, Domain, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload |
IDG Raw Message Page Columns | Dashboards | Device, Domain, Category, Severity, Time, Direction, Object Type, Object Name, Transaction ID, Client IP, Message Code, Message | Controls which columns will appear in the Investigate→Raw Messages Page, you can omit or reorder the columns. Possible values (not case sensitive): |
APIC Transactions Page Columns | Dashboards | API Name, Time, Device, Catalog Name, Space Name, Operation ID, Client ID, OAuth Scope, Product, Plan Name, API Name, API Version, APP Name, Method, URI, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload | Controls which columns will appear in the APIC Investigate->Transactions Page, you can omit or reorder the columns. Possible values (not case sensitive): |
Service URI Dashboard Percentiles (3 comma separated decimals) | Dashboards | 90.0, 95.0, 99.0 | Controls the percentiles shown in the rightmost columns of the Service URI Calls page and the API URI calls page, enter decimal values between 0-99.9 |
Service URL Dashboard Percentiles (3 comma separated decimals) | Dashboards | 90.0, 95.0, 99.0 | Controls the percentiles shown in the rightmost columns of the Service URL Calls page and the API URL calls page, enter decimal values between 0-99.9 |
APIC Recent Activity Page Latency Percentile | Dashboards | 90.0 | Controls the percentile shown in the APIC Recent Activity page, enter a decimal value between 0-99.9 |
...
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 |
SMTP WS Endpoint URI | Email SMTP WS | /SMTPSender | Destination URI for sending reports via Web-Service |
SMTP WS Host | Email SMTP WS | localhost | Destination hostname for sending reports via Web-Service |
SMTP WS Port | Email SMTP WS | 8080 | Destination port for sending reports via Web-Service |
SMTP WS Protocol | Email SMTP WS | HTTP | Protocol for accessing the Web-Service host Valid values: HTTP / HTTPS |
SMTP WS User | Email SMTP WS | user | User used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. |
SMTP WS Password | Email SMTP WS | ******** | Password used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. |
...
Parameter | Category | Default | Description |
---|---|---|---|
Internal Alerts - Check Agents Interval in Seconds | Health | 300 | How often to check whether DPOD's syslog and WS-M agents are up and working |
Internal Alerts - Check Derby Interval in Seconds | Health | 300 | How often to check whether DPOD's internal database is up and working |
Internal Alerts - Check Dropped Syslogs Interval in Seconds | Health | 600 | How often to check whether DPOD's syslog agents lost incoming messages |
Internal Alerts - Check Dropped WS-M Messages Interval in Seconds | Health | 600 | How often to check whether DPOD's WS-M agents lost incoming payloads |
Internal Alerts - Check ES Interval in Seconds | Health | 300 | How often to check whether DPOD's big data component is up and working |
Internal Alerts - Check File System Interval in Seconds | Health | 300 | How often to check whether DPOD's filesystem is out of space |
Internal Alerts - Check Retention Interval in Seconds | Health | 300 | How often to check whether DPOD's internal big data retention process is working |
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 on Alert | Health | false | Whether or not to send a Syslog message when a problem was detected by the internal health monitoring |
Interval in Seconds to Sample Logging Targets | Health | 300 | How often to sample DPOD's log targets in the monitored devices |
Interval in Seconds to Sample Nodes Health Statistics | Health | 300 | How often to collect statistics on DPOD's big data nodes |
Interval in Seconds to Monitor Objects Status | Health | 300 | How often to monitor enabled but down objects in the monitored devices |
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, |
Interval in Seconds to Sample WSM Agents Statistics | Health | 300 | How often to sample WS-M Agents in the monitored devices |
Internal Alerts REST API Service Host | Health | localhost | Host name / IP address of the maintenance housekeeping server to save and publish internal alerts. |
Internal Alerts REST API Service Port | Health | 8084 | Port of the maintenance housekeeping service to save and publish internal alerts. |
...