If you need to troubleshoot your flows in IBM® App Connect on IBM Cloud, or find out what they’re doing, you can use the built-in log viewer or access the logs from an IBM Log Analysis with LogDNA service instance that’s configured to receive platform services logs in IBM Cloud.

App Connect flows emit the following types of log entry:

  • Error

    An error message is emitted when an event, action, or some flow logic has failed.

    This error type is enabled by default.

  • Info

    An information message is emitted at key points, such as when a flow is triggered, or when it completes successfully.

    This error type is enabled by default.

  • Debug

    A debug message logs detailed information about the execution of flows, including payload data.

    You must enable this error type manually. These log entries are visible to IBM operators.

This guide shows you how to enable debug logging and view the logs.

Before you start

  • You need to have created an instance of IBM App Connect on IBM Cloud.
  • To view your logs by using the IBM Log Analysis with LogDNA service, you must have an instance provisioned and configured to receive service logs from App Connect. For more information about provisioning and configuring an IBM Log Analysis with LogDNA instance, see Monitoring and managing App Connect logs in IBM Log Analysis with LogDNA.
  • These instructions assume that you’ve created at least one flow.

Debugging your flows

  1. If an error message is emitted when an event, action, or some flow logic has failed in your flow, the quickest way to find more information about that error is to click the warning icon on the flow tile in the App Connect dashboard. Screenshot showing the error icon on the flow tile

    In the “Error messages” panel, you can see the associated error messages, and can click View logs under the Actions menu () for a log entry, to open the log viewer.

  2. If you’d like to diagnose an error further and record debugging information for the flow in your logs, open the tile menu and click Enable debug logging. (This menu item is only visible when using App Connect on IBM Cloud.) Screenshot showing the Enable debug logging menu item when you expand the tile menu
  3. Click Enable on next restart to confirm that debugging should be enabled when the flow next starts.
  4. If your flow is already running, stop and restart it. If the flow is in a Stopped state, start the flow. Debug logging is now enabled for that flow.
  5. To view error, information, and debug messages for your flow within the built-in log viewer, open the App Connect menu App Connect menu icon and then click Manage > Logs.

    When debug logging is enabled, you’ll see a log entry for each step in the flow that completes successfully. The log entry includes the output data from that step (in JSON format). Each step in the flow has access to the output from all previous steps.

    If the flow is configured with a Log node that is used to emit a custom message with a log level of debug, you’ll also see a log entry for that custom message.

    Log viewer sample data for debug level

    For information about using the log viewer, see Viewing App Connect logs in the log viewer.

  6. To view error, information, and debug messages for your flow within your configured IBM Log Analysis with LogDNA instance in IBM Cloud, open the IBM Log Analysis with LogDNA web UI, as described in Viewing and managing logs in your IBM Log Analysis with LogDNA instance. You’ll see log entries that are similar to those shown in the built-in log viewer.

Join The Discussion

Your email address will not be published. Required fields are marked *