Log

open class Log : CoatyObject

Represents a log object.

Class registration.


                    
                    
                    objectType

Undocumented

Declaration

Swift

override open class var objectType: String { get }

Attributes.

logLevel
The level of logging.
Declaration
Swift

public var logLevel: LogLevel
logMessage
The message to log.
Declaration
Swift

public var logMessage: String
logDate
Timestamp string in ISO 8601 format (with or without timezone offset).
Declaration
Swift

public var logDate: String
logTags
Represents a series of tags assigned to this Log object (optional). Tags are used to categorize or filter log output. Agents may introduce specific tags, such as “service” or “app”.
Declaration
Swift

public var logTags: [String]?
logLabels
Represents a set of key-value label pairs, used to add context-specific information to this log object (optional).

Labels are useful in providing multi-dimensional data along a log entry to be exploited by external logging services, such as Prometheus.

Any label value must be JSON compatible.
Declaration
Swift

public var logLabels: [String : Any]?
logHost
Information about the host environment in which this log object is created (optional).

Typically, this information is just send once as part of an initial advertised log event. Further log records need not specify this information because it can be correlated automatically by the event source ID.
Declaration
Swift

public var logHost: LogHost?

Initializers.


                    
                    
                    init(logLevel:logMessage:logDate:name:objectType:objectId:logTags:logLabels:logHost:)

Default initializer for a Log object.

Declaration

Swift

public init(logLevel: LogLevel,

            logMessage: String,

            logDate: String,

            name: String = "LogObject",

            objectType: String = Log.objectType,

            objectId: CoatyUUID = .init(),

            logTags: [String]? = nil,

            logLabels: [String: Any]? = nil,

            logHost: LogHost? = nil)

Codable methods.


                    
                    
                    init(from:)

Undocumented

Declaration

Swift

public required init(from decoder: Decoder) throws


                    
                    
                    encode(to:)

Undocumented

Declaration

Swift

open override func encode(to encoder: Encoder) throws