Using Integration Logs

When integration workflows are held in a halted state, you can leverage logs to troubleshoot the cause of the halted state. Message headers in the log allow for more enhanced troubleshooting over time and greater analysis. Additionally, you can configure workflows to reprocess or purge failed messages to improve execution performance.

This allows users to reliably view logs that are active and in use because the interface may fail to load if there are too many built up. Log purging also improves the performance of the workflows as a large collection of logs can affect the workflow execution process.

Note:

For more information about the Message Container, see Reprocessing Methods for Integration Workflows.

To access logs

  1. On the Integrations menu, select Integrations.

    The Integrations screen appears.

  2. Click on the name of an integration.
    Note:

    To access an integration created through a wizard, click the workflow name in the workflows card in the Summary tab.



    The Integration Builder screen appears.

  3. Navigate to the Logs tab. All event executions for the given workflow will be listed in the table with the following column details:
    Note:

    If there are no logs available, this means the workflow has not yet been executed.



    Column

    Description

    Event ID

    Random alphanumeric ID generated for the event executed for the workflow.

    Message Key

    Indicates the message key that is used by the OneTrust product trigger. It can be used to denote the customer or product-defined value in order to identify which event was created for a specific message key.



    Created Date

    Identifies when the event log was first created.

    Updated Date

    Identifies when the event log was last updated.

    Attempts

    Tallies the number of execution attempts for the event.

    Status

    Identifies the execution status of the attempted event.

    • Success

    • Queued

    • Expired

    • Pending

    • Failure

To view log details

  1. On the Integrations menu, select Integrations.

    The Integrations screen appears.

  2. Click on the name of an integration.

    The Integration Builder screen appears.

  3. Navigate to the Logs tab.
  4. Click on the name of an Event ID to open the Logs pane. You can access this pane by also selecting View Log(s) from the given Event ID's context menu.
  5. The Log Details pane will present basic information about the event message, including its status, created date, and additional details in the Tree view by default.
    Tree view

    : allows you to collapse and expand sections to easily sort and surface desired information.



    Text view

    : presents the log information in a single text field to easy copy JSON.



  6. The AI Summary portion of integration logs can quickly identify failed actions to provide error summaries, root cause explanations, and actionable recommendations inside the log. Users can see exactly which workflow step failed, the type of error, and suggested next steps, which enables users to resolve issues faster and more confidently.




    Important:

    The AI-Powered Individual Log Error Analysis feature requires the Integration error summaries setting to be enabled in Global Settings. Please contact your account representative to request early access to this Public Preview feature. For more information, see Managing AI Features in the OneTrust Platform.

  7. Additional details, like the trigger and action, can be useful to diagnose issues.
    • Expand the Trigger section to inspect the eventData, payload, userDetails, and more information about how the integration was triggered.

    • Expand the Action section to inspect the payloads for the various calls that were executed for the workflow.

  8. Use the Expand all or Collapse All buttons to manage your view of the log.




  9. If there are issues with the workflow execution, the log will display a message alert with information and status codes about the error scenario. Use this information to troubleshoot and resolve the issue to continue execution.


  10. Use the Copy option to copy and use this message data for additional troubleshooting and support review.
  11. Use the View full screen option to open the log in a larger window with the same supported collapsible sections for easier review.


To apply filters

  1. Navigate to the Logs tab of the Integration Builder screen.
  2. In the top-left above the table, click + Add filter.


  3. You can filter the table according to the following values:
    • Created Date

    • Updated Date

    • Status



  4. For Created Date filters, this sorts the table for log events that were created between a timeframe that you can choose using the calendar picker.


    Click outside of the pop-up to display the applied filter.



  5. For Updated Date filters, this sorts the table for log events that were updated between a timeframe that you can choose using the calendar picker.


    Click outside of the pop-up to display the applied filter.



  6. For Status filters, this sorts the table for log events according to a specific status condition.




    Click outside of the pop-up to display the applied filter.



    Hover over or select the applied filter to show the additional + count.



  7. Click the X icon to delete select filters or use the Clear all option to remove all applied filters.


To increase pagination of the log screen

  1. Navigate to the Logs tab of a workflow.
  2. Click the Load more records button.

    The Load more records modal appears.

  3. By default the platform will load up to 10,000 records. You can increase this by making a selection from the field:
    • 10,000 (Default)

    • 25,000

    • 50,000

    • 100,000

    • 250,000

    • All records



  4. Click the Load records button. The modal will begin processing updates. This may take a few minutes. To stop the process, click the Stop updating button.


  5. Once the modal closes, the pagination count will increase to your selection.

Troubleshooting Logs Best Practices

Avoid manually activating and deactivating the workflow repeatedly. If a workflow is automatically halted due to a high number of consecutive failures, first identify and resolve the issue before resuming the workflow and reprocessing the failed messages. This will ensure that new events are processed correctly. 

If a previously functioning workflow encounters unexpected issues, contact OneTrust Support to understand the root cause. Unless you have a clear understanding of the problem and the necessary steps to resolve it, OneTrust Support is available to assist you. 

If you resume the workflow and reprocess the messages, but the failures persist despite resolving the identified issue, refrain from resuming the workflow again. Doing so could disrupt the processing of queued messages and may interfere with the failed event queue, potentially affecting future events.

Workflow Status Descriptions

Status

Description

In Progress

The workflow is currently executing the event.

Success

The workflow executed successfully.

Failure

The workflow failed to execute as expected.

Pending

The workflow is currently Halted and the event message is waiting to be processed.

Queued

The event message is queued waiting to be processed.

Duplicate

The event message did not reprocess since the identifier has a duplicate message that has already processed successfully (only applies to Consent integrations).

Dropped

The failed workflow has been reprocessed but still does not meet AND/OR event conditions specified in the event payload.

Rate Limited

Appears for workflows enabled with throttling. Messages that have been throttled will appear with this status until their are reprocessed.

Expired

The workflow hasn't been reprocessed within 14 days and there is a message held in the Message Container. The message can only be reprocessed individually until it’s purged completely from the detailed logs at 30 days.

Retry Limit

The event message has been automatically re-processed up to 15 times, but is still not successful.