Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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


Syslog server hostname or IP address.

Alerts Syslog Server Port

Alerts

Syslog server listening port.

...

Parameter

Category

Default Value

Description

Enable Reports Emails SMTP 

Reports

true

Enables sending reports via SMTP

Enable Reports Emails SMTP WS 

Reports

false

Enables sending reports via a Web-Service

Enable Reports Output File 

Reports

false

Enables writing reports to a local file-system. (Defaults to /data/reports)

Fields to ignore in ElasticSearch response

Reports

doc_count_error_upper_bound,sum_other_doc_count

For internal use, do not change unless instructed to do so by product support.  

Emails and SMTP (For report publishing, alerts, share, maintenanace plans etc)

...

Parameter

Category

Default Value

Description

From Address

Email

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 - 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

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,
set this option to All to make it sample all object classes in the monitored gateways, or enter a custom list of comma separated 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,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Transaction Analysis Level - More TPS

Transactions

Core, MemoryReqRes, B2B, notice

The message group names and log level for the More TPS analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Transaction Analysis Level - Balanced

Transactions

Core, MemoryReqRes, B2B, MemActionLevel, notice

The message group names and log level for the Balanced analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

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,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

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,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Size of next/previous transaction results

Transactions

default

The size of next/previous transaction results.
The default is the size of the transactions list page from where the user clicked on the transaction ID link.

Miscellaneous Parameters

The following parameters control various other functions.

...