Log

STATUS: ACTIVE

Generic logging framework that persists across DML reversions by publishing a Platform Event

See LogMessage

See LogException

See LogTriggerHandler

Constructors

private Log()

establishes the buffer, if one doesn't yet exist private, to ensure we can't directly construct this class. Use the Singleton, Luke.

---

Fields

private buffer → List<LogMessage>

private list of LogMessage objects to be published in the future

private currentInstance → Log

private instance of this log class that backs the singleton get() method.

public publishToStandardLogs → Boolean

---

Methods

public static Log get()

Singleton pattern get method.

Returns

Type	Description
Log	Log

public void add(String messageToLog)

Add a message to the buffer without publishing it. Assumes a null severity

Parameters

Param	Description
messageToLog	The string message to add to the buffer.

public void add(String messageToLog, LoggingLevel severity)

Add a message to the buffer without publishing it.

Parameters

Param	Description
messageToLog	The string message to add to the buffer.
severity	LogSeverity enum

public void add(Exception exceptionToLog)

Add an formatted exception message to the buffer without publishing it. Assumes a null Severity

Parameters

Param	Description
exceptionToLog	Exception to format and log

public void add(Exception exceptionToLog, LoggingLevel severity)

Add an formatted exception message to the buffer without publishing it.

Parameters

Param	Description
exceptionToLog	Exception to format and log
severity	LogSeverity enum

public void publish()

Publish any messages currently in the buffer, without adding any new ones.

private static void alsoPublishToStandardLogs(List<Log__e> logEvents)

SUPPRESSWARNINGS

this method will drop the logged statements to the transaction log via system.debug

Parameters

Param	Description
logEvents	List<Log__e> to be logged

public void publish(Exception exceptionToLog)

Auto-format exception details, add it to the log buffer, and then publish the current buffer. Use the equivalent add method if you intend to add multiple messages rapidly to minimize DML usage.

Parameters

Param	Description
exceptionToLog	exception to format and log

public void publish(String messageToLog)

Auto-format a custom log message string, add it to the log buffer, and then publish the current buffer. Use the equivalent add method if you intend to add multiple messages rapidly to minimize DML usage.

Parameters

Param	Description
messageToLog	String to log

public void publish(LoggingLevel severity, String messageToLog)

Publish a custom log message string with a specified severity

Parameters

Param	Description
severity	LoggingLevel enum noting the severity of the message
messageToLog	String to log

---