How to set up the Background Memory Tracing parameter for IBM WebSphere DataPower SOA Appliances?
Starting in DataPower firmware Version 3.8.1, you can set automatic memory leak detection when it leads to a crash:
1. Enable "Failure Notification".
Using the WebGUI, select Objects -> Failure Notification. From the Configure Failure Notification screen, turn Administrative State radio button to On.
Using the CLI: configure terminal -> failure-notification -> admin-state enabled
# configure terminal
Global configuration mode
Modify Failure Notification configuration
(config failure-notification)# admin-state enabled
2. Enable the "Upload Error Report" setting.
Using the WebGUI, from the Configure Failure Notification screen, turn Upload Error Report radio button to On.
Using the CLI: From Failure-Notification Configuration Mode -> upload-report on
(config failure-notification)# upload-report on
3. Enable the "Background Memory Trace" configuration parameter to enable automatic leak detection.
Using the WebGUI: From the Configure Failure Notification screen, turn the Background Memory Trace radio button to On.
Using the CLI: From Failure-Notification Configuration Mode -> ffdc memory-trace on
(config failure-notification)# ffdc memory-trace on
NOTE: The throttle settings can prevent the appliance from reaching the internal threshold.
4. Enable the "Include Internal State"
Using the WebGUI: From the Configure Failure Notification screen, turn the Include Internal State radio button to On.
Using the CLI: From Failure-Notification Configuration Mode -> internal-state on
config failure-notification)# internal-state on
5. Fill out the desired destination for the Error-Report.
Depending on your available resources, you can specify an NFS, iSCSI, RAID, SMTP, FTP, or temporary folder destination.
The appliance generates error reports. The naming convention includes the serial number of the appliance and the timestamp of the report. This naming convention prevents one report from overwriting another.
Using the WebGUI: From the Configure Failure Notification screen, select a Report Destination Protocol.
Using the CLI: From Failure-Notification Configuration Mode -> protocol <ftp | nfs | raid | iscsi | smtp | temporary>
(config failure-notification)# protocol temporary
6. Save the settings and recreate the issue.
7. Once the issue has been recreated, submit a full appliance backup and the generated error report for review by IBM Support.
This feature finds gradual memory leaks that occur steadily over time.
This feature does not help in situations where messages are larger than the appliance can parse.
When enabled and if memory falls below an internal threshold, the appliance tracks all memory allocations.
If the appliance reaches a critical condition that will lead to a crash, it generates an error report that contains information about memory allocation.
The configuration of the Throttle Settings affects this feature.
There may be some impact on performance after enabling this feature depending on the configuration.
It is recommended to enable the Background Memory Trace feature during testing to fully understand the impact in your environment.
For further details about contacting IBM Support or if the Background Memory tracing does not provide enough information, see MustGather: Memory Leak for WebSphere DataPower SOA Appliance 3.7.2 and later.