Log Custom Preference Activity
The Log Custom Preference activity enables users to record custom log information. It supports logging messages in both JSON and plain text formats, allowing for flexible data capture and monitoring.
| Field | Description | Requirement |
|---|---|---|
| Log Message (JSON) | Specifies the log message content in JSON format. When this field is used, a custom value for the Index parameter must also be provided. | Required |
| Log Message (Text) | Specifies the log message content in plain text format. If the Index parameter is not specified, the message is pushed to the default 'transaction-detail' index. | Required |
| Index | Defines the name of the monitoring index where the log message will be stored. If left empty and Log Message (Text) is used, the default 'transaction-detail' index is applied. This field is mandatory when Log Message (JSON) is configured. | Optional |
| Continue on Error | Determines whether the activity should continue execution if an error occurs during the logging process. | Optional |
Action Types & Examples
Log Message (JSON)
- Format: string
- Example Result:
{ "cityCode" : "IST", "cityName" : "Istanbul" }
Log Message (Text)
- Format: string
- Example Result:
customLog2
Index
- Format: string
- Example Result:
custom-logger-test
Implementation Examples
Field Setup - Log Message (JSON): { "cityCode" : "IST", "cityName" : "Istanbul" } - Log Message (Text): customLog2 - Index: custom-logger-test - Continue on Error: false
Execution Parameters - Log Message (Text): ${LogMessage} - Index: runtime-logs
Technical Notes
The activity supports logging in both JSON and plain text formats. When providing a log message in JSON format, it is mandatory to also specify a custom value for the 'Index' parameter, as the default index is not applicable for JSON logs. For plain text logs, if the 'Index' parameter is not provided, the log message will be directed to the default 'transaction-detail' index. Based on the source definition, both 'Log Message (JSON)' and 'Log Message (Text)' are marked as required parameters; however, in typical usage, only one log message type is provided per execution.