CleanroomLogger Docs (100% documented)

CleanroomLogger Reference Field Enum Reference

Field

public enum Field

The individual Field declarations for the FieldBasedLogFormatter.

timestamp
Represents the timestamp field rendered in a specific TimestampStyle.
Declaration
Swift

case timestamp(TimestampStyle)

severity
Represents the LogSeverity field rendered in a specific SeverityStyle.
Declaration
Swift

case severity(SeverityStyle)

callSite
Represents the call site field. The call site includes the filename and line number corresponding to the call site’s source.
Declaration
Swift

case callSite

stackFrame
Represents the stack frame of the caller. Assuming the call site is within a function, this field will contain the signature of the function.
Declaration
Swift

case stackFrame

callingThread
Represents the ID of the thread on which the call was executed. The CallingThreadStyle specifies how the thread ID is represented.
Declaration
Swift

case callingThread(CallingThreadStyle)

payload
Represents the Payload of a LogEntry.
Declaration
Swift

case payload

processName
Represents the name of the currently executing process.
Declaration
Swift

case processName

processID
Represents the ID of the currently executing process.
Declaration
Swift

case processID

delimiter
Represents a text delimiter. The DelimiterStyle specifies the content of the delimiter string.
Declaration
Swift

case delimiter(DelimiterStyle)

literal
Represents a string literal.
Declaration
Swift

case literal(String)

custom
Represents a field containing the output of the given LogFormatter.
Declaration
Swift

case custom(LogFormatter)