iOS: Collecting logs

1
import VoxImplantSDK
2
import Foundation
3
4
final class FileLogger: NSObject {
5
    static var shared: FileLogger = FileLogger()
6
7
    private let dateFormatter = DateFormatter()
8
9
    private var logFilePath: URL? {
10
        if let documentsFolder = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first {
11
            return documentsFolder.appendingPathComponent("VoxImplantSDK.log")
12
        } else {
13
            print("Documents folder not found, skipping")
14
            return nil
15
        }
16
    }
17
18
    private override init() {
19
        super.init()
20
        dateFormatter.dateFormat = "dd.MM.yyyy HH:mm:ss:SSS"
21
        // (2) Invoke VIClient.setLogDelegate API to handle Voximplant SDK log messages.
22
        VIClient.setLogDelegate(self)
23
    }
24
25
    private func writeLogToFile(_ text: String) {
26
        guard let logFile = logFilePath else {
27
            print("File path does not exist")
28
            return
29
        }
30
        if FileManager.default.fileExists(atPath: logFile.path),
31
           let fileHandle = try? FileHandle(forWritingTo: logFile) {
32
            let string = "\(text)\n"
33
            let data = Data(string.utf8)
34
            fileHandle.seekToEndOfFile()
35
            fileHandle.write(data)
36
            fileHandle.closeFile()
37
        } else {
38
            do {
39
                try text.write(to: logFile, atomically: false, encoding: .utf8)
40
            }
41
            catch {
42
                print("Error: \(error.localizedDescription)")
43
            }
44
        }
45
    }
46
47
    private func logFormatter(message: String) -> String {
48
        let now = Date()
49
        let dateString = dateFormatter.string(from: now)
50
        return dateString + " " + message
51
    }
52
}
53
54
// (1) Conform VILogDelegate protocol
55
extension FileLogger: VILogDelegate {
56
    func didReceiveLogMessage(_ message: String, severity: VILogSeverity) {
57
        let dateAndMessage = logFormatter(message: message)
58
        // (3) Write a log message to a file.
59
        writeLogToFile(dateAndMessage)
60
    }
61
}

1
// import CocoaLumberjack // if the dependency is installed via CocoaPods
2
import CocoaLumberjackSwift // if the dependency is installed via SPM
3
import VoxImplantSDK
4
import Foundation
5
6
final class FileLogger: NSObject {
7
    static var shared: FileLogger = FileLogger()
8
9
    private let voxClientFileLogger = DDLog()
10
    private var ddLogLevel: DDLogLevel { .info }
11
12
    private var logFilePath: URL? {
13
        if let documentsFolder = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first {
14
            return documentsFolder.appendingPathComponent("VoxImplantSDK.log")
15
        } else {
16
            print("Documents folder not found, skipping")
17
            return nil
18
        }
19
    }
20
21
    private override init() {
22
        super.init()
23
        configure()
24
25
        // (2) Invoke VIClient.setLogDelegate API to handle Voximplant SDK log messages.
26
        VIClient.setLogDelegate(self)
27
    }
28
29
    private func configure() {
30
        guard let logFilePath = logFilePath else { return }
31
        let logFileManager = DDLogFileManagerDefault(logsDirectory: logFilePath.path)
32
        logFileManager.maximumNumberOfLogFiles = 1
33
34
        let fileLogger = DDFileLogger(logFileManager: logFileManager)
35
        /// Cleanup interval 24 hours
36
        fileLogger.rollingFrequency = TimeInterval(60 * 60 * 24)
37
        /// Maximum log file size 10MB
38
        fileLogger.maximumFileSize = 1024 * 1024 * 10
39
40
        fileLogger.logFormatter = LogFormatter()
41
        voxClientFileLogger.add(fileLogger, with: ddLogLevel) // Vox Client Log to file
42
    }
43
}
44
45
// (1) Conform VILogDelegate protocol
46
extension FileLogger: VILogDelegate {
47
    func didReceiveLogMessage(_ message: String, severity: VILogSeverity) {
48
        // (3) Write a log message to a file.
49
        switch severity {
50
        case .debug:
51
            DDLogDebug(message, ddlog: voxClientFileLogger)
52
        case .info:
53
            DDLogInfo(message, ddlog: voxClientFileLogger)
54
        case .warning:
55
            DDLogWarn(message, ddlog: voxClientFileLogger)
56
        case .error:
57
            DDLogError(message, ddlog: voxClientFileLogger)
58
        case .verbose:
59
            DDLogDebug(message, ddlog: voxClientFileLogger)
60
        default:
61
            DDLogDebug(message, ddlog: voxClientFileLogger)
62
        }
63
    }
64
}
65
66
final class LogFormatter: NSObject, DDLogFormatter {
67
    private let dateFormatter = DateFormatter()
68
69
    override init() {
70
        dateFormatter.dateFormat = "dd.MM.yyyy HH:mm:ss:SSS"
71
        super.init()
72
    }
73
74
    func format(message logMessage: DDLogMessage) -> String? {
75
        let dateAndTime = dateFormatter.string(from: logMessage.timestamp)
76
        return dateAndTime + " " + logMessage.message
77
    }
78
}

1
import VoxImplantSDK
2
import Foundation
3
4
// (1) Import os
5
import os
6
7
@available(iOS 14.0, *)
8
final class ConsoleLogger: NSObject {
9
    static var shared: ConsoleLogger = ConsoleLogger()
10
11
    let logger = Logger()
12
13
    private override init() {
14
        super.init()
15
        // (3) Invoke VIClient.setLogDelegate API to handle Voximplant SDK log messages.
16
        VIClient.setLogDelegate(self)
17
    }
18
}
19
20
// (2) Conform VILogDelegate protocol
21
@available(iOS 14.0, *)
22
extension ConsoleLogger: VILogDelegate {
23
    func didReceiveLogMessage(_ message: String, severity: VILogSeverity) {
24
        // (4) Redirect the log message
25
        logger.log("\(message)")
26
    }
27
}