LogBuilder

Triton utilizes the builder design pattern to enable a quick and easy-to-read log creation routine.

pharos.LogBuilder

This is a global managed class provided with the Pharos managed package. These methods aren't accessible for editing locally. For an overview of the builder class please refer to this section.

This class is used by TritonBuilder that provides an abstraction layer over this managed class. The documentation here is provided mostly just for reference. For all practical purposes you can skip this class go straight to TritonBuilder.

getInstance()

global static LogBuilder getInstance()

This is a static method to create a new instance of the builder. Note that this is the only option to instantiate the builder class as the constructor is private.

type(String value)

global LogBuilder type(String value)

This method sets the type value on the log record (see Type enum).

summary(String value)

global LogBuilder summary(String value)

This method sets the summary value on the log record. Summary will be truncated automatically to 255 characters as necessary.

details(String value)

global LogBuilder details(String value)

This method sets the details value on the log record.

category(String value)

global LogBuilder category(String value)

This method sets the category value on the log record (see Category enum).

stackTrace(String value)

global LogBuilder stackTrace(String value)

This method sets the stack trace on the log record. Pharos will use this value to render a graphical stack trace for Apex code. For everything else, a text representation of the stack trace will be provided.

area(String value)

global LogBuilder area(String value)

This method sets the area (functional area) value on the log record (see Area enum).

postProcessing(String settingsJSON)

global LogBuilder postProcessing(String settingsJSON)

This method sets the post processing controls that signal to Pharos the types of post processing to perform on a log record. Use the PostProcessingControlsBuilder to build the settings and serialize them to JSON.

transactionId(String value)

global LogBuilder transactionId(String value)

This method sets the transaction Id on a log record.

createIssue()

global LogBuilder createIssue()

Calling this method will signal to Pharos to create an Issue from this log record. By default, no Issue records are created for custom logs.

attribute(String field, Object value)

global LogBuilder attribute(String field, Object value)

This methods set any field on a log record to the specified value. Please refer to this section for more details.

build()

global pharos__Log__c build()

This methods will return the final log record. Call this method once you've set all the attributes. The output of this method can be provided to the logging methods.