Log Debug Message
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Tokens
Writes a message to the Plant an App log files at Debug level. Use it to trace what an action list is doing, for example which branch ran or what value a token had, without showing anything to the user.
Debug messages are only written when the log level is set to Debug. By default it's Error, so the action does nothing visible until you change it. See Turning on debug logging.
In Listings and User Guides, the same action is called Log Debug Info.
Typical Use Cases
- Check the value of a token at a certain point in an action list, for example
Order total: [Total] - Confirm which actions ran in a workflow or API endpoint
- Leave tracing messages in place that only produce output when debugging is turned on
Don't use it to
- Record errors that need attention. Use Log Error, which is always written.
- Record events for administrators to review in the Admin Logs. Use Log Event.
- Show a message to the user. Use Display Message.
Related Actions
| Action Name | Description |
|---|---|
| Log Debug Info | The same action, under the name used in Listings and User Guides. |
| Log Error | Writes a message at Error level, which is logged by default. |
| Log Event | Adds an entry to the Admin Logs. |
| Log Job Context | Logs the whole context of an Automation job. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Message | The text to log, for example Loaded customer [CustomerId], status [Status]. | Yes | empty string | No |
Considerations
- Turn debug logging off again when you're done. At
Debuglevel, the whole platform logs a lot more, which fills the log files quickly. - Don't log secrets. Log files are plain text on the server. Avoid putting passwords, API keys or personal data in the message.
- The action never fails and doesn't change any tokens. The actions after it always run.
Examples
tip
To understand how to use the below examples, please see Running Examples.
1. Trace a value in a workflow
This action logs the values the workflow received, so you can check them in the log file when debug logging is on.
{
"Title": "Log Debug Message",
"ActionType": "LogDebug",
"Description": "Trace the incoming order",
"Parameters": {
"Message": "Received order [OrderId] for customer [CustomerId], total [Total]"
}
}
Revised 09/27/2026