Skip to content

LogMessage

The properties defined in Action are also applicable to this action.

LogMessage Properties

Property Type Required
Level enum Optional
Message string Required
_Type const Required

Level

  • type: enum

The value of this property must be equal to one of the known values below.

Value Description
Off Turn off logging.
Error Enable Error logs. High level such as fatal errors.
Warn Enable Warning logs. Medium level such as potential issues or non-fatal errors. It will include Error logs too.
Info Enable Info logs. Low level such as information of lapsed event. It will include Error and Warning logs too.
Debug Enable Debug logs. Very low level such as debugging information. It will include Error, Warning and Info logs too.
Trace Enable Trace logs. Most verbose level such as tracing information. It will include Error, Warning, Info and Debug logs too. To enable logging of traces to the client log file, you must also enable TracingEnabled and configure the debug settings via the BrandedSettings.json or SetDebugSettings action. Note: Traces will be tagged as DEBUG in the log file.

Message

Message to log

  • type: string

_Type

  • type: const

The value of this property must be equal to:

"Action.Type.Logger.LogMessage"

Action Result

This action does not have an ActionResult.


Examples

{
  "_Type": "Action.Type.Logger.LogMessage",
  "Message": "Example",
  "Level": "Error"
}