The Log to Server action natively introduces logging capability for API Tasks. This action enables you to create custom logs and forward them along with API Task runtime logs to any Security Information and Event Management (SIEM) server configured in the Control Room.

Overview

The Log to Server enables you to verify the API Tasks runtime logs by forwarding the logs to a SIEM server. You can also create custom logs and forward them along with the runtime logs. Previously, API Tasks did not allow forwarding logs due to restrictions in file handling capability.

Forwarding the logs to a SIEM server provides a centralized avenue to verify the automation runtime data and debug any errors that might occur during the automation execution. You can leverage the reporting and analysis capabilities of the tools available on the SIEM server to analyze and manage the logs. You can also retain the logs in the server as per organizational requirements for compliance and regulatory audits.

Ensure that you configure the integration settings for SIEM before using the Log to Server action in an automation. For more information about configuring the SIEM integration settings, see Configure integration with SIEM.

The forwarded custom log contains the following parameters:
Parameter Description
logMessage The log message contains the log header for the log content.
executionId The execution ID of the automation. The execution ID appears in the URL when you open the Activity page of the automation.
logLevel The log level that you set when configuring the action.
sysLogSource The data source tag that you set when configuring the action. This tag serves as an identifier for the logs.
botName The name you entered when creating the automation.
botId The bot ID of the automation. The bot ID appears in the URL when you open the bot in the bot editor workspace.
logCreatedTime The time when you created the automation. This entry includes the date and the time.

Settings

  • Text to log: Enter a name for the log header. The logMessage parameter displays the log header. The maximum allowed text length is 1024 characters.
  • You can export the configured information of the variables in the automation using the Variables to log option. The Log to Server action supports String, Number, Datetime, and Boolean variables. The variables and their respective default values also appear in the logMessage parameter.

    Choose one of the following:

    • By type: Use this option to log variables based on the type. You can log the variables individually or together.
      Note: When you select the By type option, you can also log variables that you create later after you have added the Log variables to file action.
    • Custom selection: Use this option to select and log the variables individually or together.
  • Data source tag (optional): Add tags for identifying the log entries. The tags allow easy filtering of the logs in the SIEM server. The data source tag appears in the sysLogSource parameter.
  • Log level: Select an appropriate level for the log information based on the requirements. The log level appears in the logLevel parameter. The following log levels are available:
    • Emergency
    • Error
    • Warning
    • Info
    • Debug