IBM Support

Best practices for Failure Notification Settings in Datapower

How To


Summary

With the settings below you can expect to get the most information possible when generating an error-report to provide for analysis by support teams.

Steps

1.  In Failure-Notification:
  • Upload Error Report 'on'
  • Internal State 'off'
  • Background Packet Capture 'on'
  • Background Log Capture 'on'
  • Background Memory Trace optionally 'on'
    • Note: Background Memory Trace is controlled by a set of memory diagnostic commands, by default reaching over 50% enables leak detection diagnostics. This reports in the WebGUI as "Diagnostics are enabled, which impacts performance".  Review the diagnostic commands listed at the bottom of the technote for more details.
  • Always On Startup 'on'
  • Optional: You can have on-shutdown set to 'On', which helps get more artifacts before a manual reload or reboot of the device. Always On Startup should always be on as it is the only way to immediately collect data after an unexpected reload
  • If available, save error-reports to the raid opposed to temporary to assure they will be there after a reboot.

See example below:

image 2681

2. In Throttle Settings:
  • Status Log to 'on'
  • Log Level at 'information'
See example below:

image 2679

3. In Statistics (default, and for each custom domain):

  • Statistics 'enabled' inside each domain (this will be disabled by default).

See example below:

image 2682

Background Memory Trace
Background Memory Trace is managed through a variety of commands under diagnostics mode:
  • DataPower Docker and Linux Containers do not support this feature
  • Memory Trimming is nbleak diagnostics
  • BGLeak is a sampling collection, similar to 'show memory live'
  • When BGLeak is enabled, a reload is required to disable should the DataPower system go back below the threshold.
All commands are performed under 'diag', the prompt should show: idg(diag)#
  • show [ bgleak | memory-trimming ] - this can show the current values of each feature
  • set-memory-trimming [ percent | reset ] - default 100% (does not trigger)
  • set-bgleak [ percent | reset ] - default 50% (triggers when memory reaches 50% or higher)
  • set-bgleak-sample-interval [ interval_kb | reset] - the periodic memory polling is done by samples of this size
throttle.png (19.6 kB)
stats.png (8.9 kB)
failurenotificationsettings.png (28.3 kB)

Document Location

Worldwide

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS9H2Y","label":"IBM DataPower Gateway"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"2018.4.1","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
10 November 2022

UID

ibm16117898

Page Feedback