Log Entries
Each time a Logger method is called, LogKit automatically gathers a variety of details regarding the message, its source, the runtime environment, and the host device. These details are collected into a Log Entry instance.
Developers creating custom Entry formatters may choose to include any number of the available properties in their serialization format.
Log Entry Properties
Every LXLogEntry
contains the following properties:
Property | Type | Description |
---|---|---|
logKitVersion |
String |
The version of the LogKit framework that generated the Entry |
message |
String |
The message provided during the logging call |
userInfo |
[String:AnyObject] |
Additional values to be provided to each Endpoint’s entryFormatter ; always present but may be empty; see here for using userInfo |
level |
String |
The name of the Log Entry’s Priority Level |
timestamp |
Double |
The number of seconds since the Unix epoch |
dateTime |
String |
The timestamp as a string serialized by an Endpoint’s dateFormatter |
functionName |
String |
The name of the function from which the Log Entry was created |
fileName |
String |
The name of the source file from which the Log Entry was created |
filePath |
String |
The absolute path of the source file from which the Log Entry was created |
lineNumber |
Int |
The line number within the source file from which the Log Entry was created |
columnNumber |
Int |
The column number within the source file from which the Log Entry was created |
threadID |
String |
The ID of the thread from which the Log Entry was created |
threadName |
String |
The name of the thread from which the Log Entry was created |
isMainThread |
Bool |
An indicator of whether the Log Entry was created on the main thread |
osVersionString |
String |
A description of the operating system, including its name and version |
osMajorVersion |
Int |
The major version number of the operating system |
osMinorVersion |
Int |
The minor version number of the operating system |
osPatchVersion |
Int |
The patch version number of the operating system |
osBuildVersion |
String |
The build version string of the operating system |
bundleID |
String |
The bundle ID of the host application |
deviceModel |
String |
The model of the device running the application |
deviceType |
String |
The type of the device running the application |
deviceVendorID |
String |
The vendor ID of the device running the application (if available) |
deviceAdvertisingID |
String |
The advertising ID of the device running the application (if available) |