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 |
|---|---|---|---|
| APM Integration Syslog App Name | APM Integration | DPOD-MSC1 | Logical name used by APM to indentify DPOD. |
| APM Integration Target Syslog Host | APM Integration | 172.77.77.7 | APM's IP address or hostname |
| APM Integration Target Syslog Port | APM Integration | 60030 | APM's listening port |
| APM Integration Target Syslog Protocol | APM Integration | tcp | APM's listening protocol for Syslog |
| APM Integration Target Syslog SSL | APM Integration | false | Is conncetion secured? |
| APM Integration Events Publishing Enable | APM Integration | true | Activate / Disable integration between DPOD and APM installation. |
Agents
| 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 (info, warn, error, etc) |
| 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. |
Dashboards
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, 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 |
Device Health
| Parameter | Category | Default Value | Description |
|---|---|---|---|
| System Health Dashboard Sample Time Range (min.) | Device Health | 5 | See "Device Health Calculation" in System Health |
Reports
The following parameters determine DPOD's reporting behavior.
...
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. |
...
These parameters control the way data is displayed in DPOD's Console UI.
Parameter | Category | Default | Description |
Default Full Date Format | Style | MM/dd/yyyy HH:mm:ss.SSS | Full date format |
Default Date Format with no Millis | Style | MM/dd/yyyy HH:mm:ss | Full date format, without milliseconds |
Default Date Format with no Year | Style | MM/dd HH:mm:ss.SSS | Full date format, without year |
Default Short Date Format | Style | MM/dd/yyyy | Short date format |
Default Theme (light/dark) | Style | Light | Light, dark or |
elegant theme of the console UI screens |
Internal Health
| Note |
|---|
| Changes to the following parameters will take affect only after restarting the keepalive service via app-util.sh |
...