IBM DataPower Operations Dashboard v1.0.12.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Log Target Analysis Levels
The Log Target Analysis Level determines how many syslogs will be sent from the monitored device to DPOD.
Each analysis level is composed of message groups that allow DPOD to show information about the transactions (see the message groups descriptions below)
In addition, each analysis level will only show syslog messages that are equal or above a certain log level.
The Default analysis level for IDG and API Connect domains (on DataPower API Gateway) is Max Data
The Default analysis level for API Connect domains (on DataPower Gateway) is Balanced + SideCalls
Analysis Level Name | Message Groups | Log Level |
---|---|---|
Max Data | Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, Sidecalls | info |
More Data | Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency | info |
Balanced | Core, MemoryReqRes, B2B, MemActionLevel | notice |
More TPS | Core, MemoryReqRes, B2B | notice |
Max TPS | Core, MemoryReqRes, B2B | error |
Message Group Name | Description |
---|---|
Core | Required, DPOD may not show any data without this message group |
MemoryReqRes | Required, DPOD may not show any data without this message group |
B2B | This message group will enable special B2B filters in the Raw Messages page (like "B2B Message ID" and "B2B From Partner ID"), DPOD will show B2B transactions even without this message group |
MemActionLevel | This message group will populate the memory graph in the transaction page, DPOD will show basic memory data even without this message group |
ReqPayloadSize | This message group will populate service request size information in some dashboards, such as the Recent Activity dashboard |
ExtLatency | This message group will populate the transaction's extended latency tab in the transaction page. |
SideCalls | This message group will populate the sidecalls tab in the transaction page |
Customize Analysis Levels
You can configure which message groups and log level are assigned to each analysis level from the system parameters (For example, the parameters "Transaction Analysis Level - Balanced" will assign message groups and log level to the Balanced analysis level)
In most cases, you can leave the default analysis levels setup
Customize Message Groups
If you wish to add or remove specific syslog messages from a message group, you can specify an override file, specify the file's location in the system parameter "Transaction Analysis Level - User Override Path"
The file should contain one or more lines to add or remove messages to message groups,
To add messages to a message group use:
+.messageGropName.syslogMessageCode=logLevel.logCategory,logLevel.logCategory,logLevel.logCategory
For Example
+.MemActionLevel.0x80e0013f=debug.memory-report
Will add the message 0x80e0013f (debug log level and above, with log category memory-report) to the message group MemActionLevel
+.B2B.0x80123456=debug.b2bgw, error.mpgw
Will add the message 0x80123456 (debug log level and above, with log category b2bgw, and error log level and above withr log category mpgw) to the message group B2B
Similarly, remove a message from a message group by adding the line:
-.messageGropName.syslogMessageCode=logLevel.logCategory,logLevel.logCategory,logLevel.logCategory
For example:
-.MemActionLevel.0x80e0013f=debug.memory-report
Will remove the message 0x80e0013f (debug log level and above, with log category memory-report) from the message group MemActionLevel
Changing message groups setting may have tremendous impact on DPOD performance, DPOD functionality and also on network utilization. Supporting customers for performance issues will be performed on default message group setting only.