Skip to Content

Operation Debug Logging for Cloud Agents

Introduction

Operation debug logs are additional log files and data that are generated for operations when operation debug logging is enabled. Operation debug logging is used mainly for debugging problems during testing and should not be turned on in a production environment.

On Cloud Agents, enabling debug logging on an operation can result in the generation of two types of logs:

  • Component Input and Output Data: Data written to a Cloud Studio operation log when operation debug logging is enabled on an operation. The data is retained for 30 days by Harmony.

    Warning

    When component input and output data are generated, all request and response data for that operation are logged to the Harmony cloud and remain there for 30 days. Be aware that personally identifiable information (PII) and sensitive data such as credentials provided in a request payload will be visible in clear text in the input and output data within the Harmony cloud logs.

  • API Operation Logs: Operation logs for both successful and unsuccessful API operations (configured for Custom APIs or OData Services). When operation debug logging is not enabled, only unsuccessful API operations are logged in the operation logs.

Note

An additional type of operation debug log is generated only when using Private Agents.

Enable Operation Debug Logging

You can enable debug logging for an individual Cloud Studio or Design Studio operation with these steps:

  • Cloud Studio: Use an operation's actions menu to select Settings. In the Options tab, select Enable Debug Mode Until and set a date for debug logging to be turned off. The option to cascade the debug mode settings to any child operations is also available.

  • Design Studio: Right-click the background of any operation and select Options. In the Operation Options window, select Enable Debug Mode Until and set a date for debug logging to be turned off.

This date is limited to 2 weeks from the current date. Operation debug logging will be turned off at the beginning of this date (that is, at 12:00 am) using the time zone of the agent.

Component Input and Output Data

Component input and output data is generated when a Cloud Studio operation that has operation debug logging enabled at the operation level is executed. Input and output data are available only for activities and transformations used as operation steps.

Caution

The generation of component input and output data is unaffected by the Agent Group setting Enable Cloud Logging (see Agents > Agent Groups). Component input and output data will be logged to the Harmony cloud even if cloud logging is disabled.

Input and Output Data Access

Component input and output data is accessed from the Cloud Studio operation log screen in additional table rows shown for each operation step that has input and output data. In the Input/Output column, icons for activities and transformations used as operation steps can be clicked to show or hide the component input and output data for that individual operation step. Each input and output log entry is limited to 100MB. If the data for an individual input or output log entry exceeds 100MB, no data will be displayed.

logs table operation steps header

  • Copy: Click the copy icon copy 2 to copy the log data to your clipboard. When clicked, a clipboard icon copy 2 is temporarily displayed.
  • Download: Click the download icon download to download the input or output data. The file is named with the operation step name followed by _input or _output as appropriate.

Input and Output Data Retention Policy

Component input and output data is retained for 30 days by Harmony.

Input and Output Data Contents

Component input and output data is generated for certain steps of an operation. The data is appropriate to the function of a step. The input is the structure that the component consumes, while the output is the structure that the component produces.

Input and output data is generated for these components used as operation steps:

  • Activities: Input and output data and any related information for the execution of the activity. Some activities may have multiple input and output files.
  • Transformations: Input and output data for the execution of the transformation.

Input and output data is not applicable to scripts when they are used as operation steps. Script content, such as that produced by the WritetoOperationLog function, is displayed in the log messages of an operation log.