XCGLogger

To get started quickly:

1. Setup Frameworks: Add XCGLogger.framework and ObjcExceptionBridging.framework to the Embedded Binaries section under the General tab of your target.
2. Import: Add import XCGLogger to your source files.
3. Initialize: Declare a global constant for the default instance (e.g., in AppDelegate).
4. Configure: Call .setup() to define log levels and output destinations.

Configuration Options for .setup():

• level: The minimum log level to output to the console.
• showThreadName: Boolean to show the thread name.
• showLevel: Boolean to show the log level.
• showFileNames: Boolean to show the filename.
• showLineNumbers: Boolean to show the line number.
• writeToFile: A String or URL for file logging. If provided, the file is cleared before use. Omit or set to nil for console-only logging.
• fileLevel: The minimum log level for file output. Omit or set to nil to match the console level.

XCGLogger allows you to send log messages to various destinations like the Apple System Log, files, or third-party servers. You can create a logger with no default destinations and manually add specific destination objects. Each destination can have its own outputLevel and configuration options (e.g., showFunctionName, showLineNumber, showDate).

Note: A destination object can only be added to one logger object; adding it to a second will remove it from the first.

// Create a logger object with no destinations
let log = XCGLogger(identifier: "advancedLogger", includeDefaultDestinations: false)

// Create a destination for the system console log (via NSLog)
let systemDestination = AppleSystemLogDestination(identifier: "advancedLogger.systemDestination")
systemDestination.outputLevel = .debug
systemDestination.showFunctionName = true

// Add the destination to the logger
log.add(destination: systemDestination)

// Create a file log destination
let fileDestination = FileDestination(writeToFile: "/path/to/file", identifier: "advancedLogger.fileDestination")
fileDestination.logQueue = XCGLogger.logQueue
log.add(destination: fileDestination)

// Add basic app info, version info etc, to the start of the logs
log.logAppDetails()

You can add color to FileDestination logs using ANSIColorLogFormatter. This allows you to view colorized logs in a terminal. You can customize the color and options (like .bold, .italic, .faint, .underline) for each log level.

if let fileDestination: FileDestination = log.destination(withIdentifier: XCGLogger.Constants.fileDestinationIdentifier) as? FileDestination {
    let ansiColorLogFormatter: ANSIColorLogFormatter = ANSIColorLogFormatter()
    ansiColorLogFormatter.colorize(level: .verbose, with: .colorIndex(number: 244), options: [.faint])
    ansiColorLogFormatter.colorize(level: .debug, with: .black)
    ansiColorLogFormatter.colorize(level: .info, with: .blue, options: [.underline])
    ansiColorLogFormatter.colorize(level: .notice, with: .green, options: [.italic])
    ansiColorLogFormatter.colorize(level: .warning, with: .red, options: [.faint])
    ansiColorLogFormatter.colorize(level: .error, with: .red, options: [.bold])
    ansiColorLogFormatter.colorize(level: .severe, with: .white, on: .red)
    ansiColorLogFormatter.colorize(level: .alert, with: .white, on: .red, options: [.bold])
    ansiColorLogFormatter.colorize(level: .emergency, with: .white, on: .red, options: [.bold, .blink])
    fileDestination.formatters = [ansiColorLogFormatter]
}