Configuring failure notification using the web UI

With failure notification enabled, you can send or upload an error report after the IBM® MQ Appliance returns to service from an outage. The error report can contain diagnostic details.

About this task

When you choose to upload error reports, you can configure First Failure Data Capture (FFDC) settings. An FFDC event triggers the error report and contains additional information. FFDC events include crashes, out-of-memory crashes, watchdogs, and other user-requested events.

When you choose to send email notifications, FFDC information is not included.

Procedure

  1. Start the IBM MQ Appliance web UI, and click the administration icon shows the administration icon.
  2. Select Device > Failure Notification.
  3. Ensure that the Administrative state is set to On.
  4. Optionally enter a description in the Comments field.
  5. Select Upload error report to upload the error report to a specified destination. Further fields appear that enable you to specify the destination.
    • Use the Background Packet Capture property to control whether to execute an always-on background packet capture that captures network packets on all interfaces, which include the internal loopback interface. When an FFDC event is triggered, that error report includes these details. Although this feature is disabled by default, it is recommended that you enable it. If you enable this feature and manually request a packet capture, two packet-captures are running, which significantly affects performance.
    • Use the Background Log Capture property to control whether to execute an always-on background log message capture that captures all log and trace points in the code with minimal performance impact. Log messages that are captured are independent of the system logging configuration. When an FFDC event is triggered, that error report includes these details. Although this feature is disabled by default, it is recommended that you enable it.
    • Use the Background Memory Trace property to control whether to run memory-tracing when system memory usage becomes too low or too high. This feature enables background leak detection that captures all allocation call sites when the system detects a memory leak trend. When an FFDC event is triggered, that error report includes these details. Although this feature is disabled by default, it is recommended that you enable it.
    • In the Report Destination Protocol field, select the protocol to use to upload the error report.
      To send as email:
      1. Select smtp.
      2. In the SMTP Server field, enter the host name or IP address of the remote SMTP server to which the error-report is sent. Click Ping to test the connection to the chosen server.
      3. In the Email Address field, enter the email address of the recipient.
      4. In the Email Sender Address field, optionally enter the email address of the sender. If not specified, the email address of the sender is the same as the recipient.
      To write to the mqdiag: directory on the RAID disk, select mqdiag as the as the Report Destination Protocol.

      To write the report to the temporary: directory, select temporary as the Report Destination Protocol. The report is written to temporary: by default, but if you select this option as the upload destination, you can select the extra information to include in the report.

  6. Use the Include Internal State property to control whether error reports include a snapshot of the system.
  7. Use the Always on Startup property to control whether to send an error report on each firmware restart.
  8. Use the Always on Shutdown property to control whether to generate an error report on each firmware shutdown.
  9. When not uploading error reports, use the Email Notification property to control whether to send error reports to an email recipient when the appliance shuts down or starts up. This option does not include FFDC information in the report. When you select this option further fields enable you to specify details about the email destination:
    • In the Location field, enter the subject line of the email. Include a customer name or system identifier in this field.
    • In the SMTP Server field, enter the host name or IP address of the remote SMTP server to which the error-report is sent. Click Ping to test the connection to the chosen server.
    • In the Email Address field, enter the email address of the recipient.
    • In the Email Sender Address field, optionally enter the email address of the sender. If not specified, the email address of the sender is the same as the recipient.
  10. In the Report history field, specify the number of error reports to maintain. When the number is reached, the next time an error report is written, it overwrites the oldest saved report.