-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Since os_log is so terrible. Use this logger wrapper.
- Loading branch information
Showing
3 changed files
with
309 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,264 @@ | ||
| /* | ||
| See LICENSE folder for this sample’s licensing information. | ||
|
|
||
| Abstract: | ||
| Consolidates use of os_log to improve log message output. | ||
| */ | ||
|
|
||
| import Foundation | ||
|
|
||
| import os.log | ||
| import Darwin | ||
|
|
||
| /* | ||
| Can strip away logs or add adititional data to messages more easily | ||
|
|
||
| To use, in the Swift source file specify the following variable: | ||
| private let log = Log() -> Log(#file) <- paths are stripped | ||
| or | ||
| private let log = Log("File/Groupname") | ||
|
|
||
| log.debug("debug text") | ||
| log.info("info text") | ||
| log.error("error text") | ||
|
|
||
| A few boolean flags control the output: | ||
| configure(prints, timestamps, stacktraces) | ||
|
|
||
| For more expensive functions, use the isInfoEnabled() call to skip blocks. | ||
| if log.isInfoEnabled() { | ||
| log.info("ComputeWorldPopulation:", countPeopleInAllCountries()) | ||
| } | ||
|
|
||
| Output: | ||
| prints = true (via print) | ||
| 14:40:21.185 D[GameSceneViewController] debug text | ||
| 14:40:21.201 I[GameSceneViewController] info text | ||
| 14:40:21.321 E[GameSceneViewController] error text | ||
| at GameSceneViewController:75@init(_:file:) | ||
| on thread:queue | ||
|
|
||
| or | ||
| 0.001s D[GameSceneViewController] debug text | ||
| 0.002s I[GameSceneViewController] info text | ||
| 0.003s E[GameSceneViewController] error text | ||
| at GameSceneViewController:75@init(_:file:) | ||
| on thread:queue | ||
|
|
||
| prints = false (via os_log) | ||
| 2018-04-11 14:59:07.122127-0700 SwiftShot[581:21310] [GameSceneViewController] debug text | ||
| 2018-04-11 14:59:07.122166-0700 SwiftShot[581:21310] [GameSceneViewController] info text | ||
| 2018-04-11 14:59:07.122186-0700 SwiftShot[581:21310] [GameSceneViewController] error text | ||
| */ | ||
|
|
||
| class Log { | ||
| // verbose: Whether os_log or print is used to report logs. | ||
| static var prints = true | ||
| // stacktrace: Whether stack trace is logged on errors. | ||
| static var stacktraces = false | ||
| // timestamp: Show timestamps on all entries when printing statements. | ||
| static var timestamps = false | ||
| // absoluteTimestamps: Show relative or absolute timestampes. | ||
| static var absoluteTimestamps = true | ||
|
|
||
| // Custom logging group - usually based on source filename. | ||
| // This has a very limited output, but does go to console | ||
| private var log: OSLog | ||
|
|
||
| // Cache the filename for reporting it on errors. | ||
| private var file: String | ||
| // All logs go to this category for filtering. | ||
| private var category: String | ||
| // This can be filtered from command line arguments. | ||
| private static var subsystem = Bundle.main.bundleIdentifier! | ||
|
|
||
| // Store data for timestamps. | ||
| private static var timestampToSeconds: Double = 0 | ||
| private static var timestampStart = timestamp() | ||
| private static var timestampStartDate = Date() | ||
| private static var timestampFormatter = initTimestampFormatter() | ||
|
|
||
| init(_ category: String = #file, file: String = #file) { | ||
| // Strip the path, but allow hierachical category f.e. "Group/Subgroup" wihtout .swift. | ||
| self.category = category | ||
| if category.hasSuffix(".swift") { | ||
| self.category = Log.stripFilePathAndExtension(category) | ||
| } | ||
|
|
||
| // Compute once for use in logs. | ||
| self.file = Log.stripFilePathAndExtension(file) | ||
|
|
||
| self.log = OSLog(subsystem: Log.subsystem, category: self.category) | ||
| } | ||
|
|
||
| // Test whether messages are logged for the given levels | ||
| func isWarnEnabled() -> Bool { | ||
| return log.isEnabled(type: .default) | ||
| } | ||
| func isInfoEnabled() -> Bool { | ||
| return log.isEnabled(type: .info) | ||
| } | ||
| func isDebugEnabled() -> Bool { | ||
| #if DEBUG | ||
| return log.isEnabled(type: .debug) | ||
| #else | ||
| return false | ||
| #endif | ||
| } | ||
|
|
||
| func fault(_ message: String) { | ||
| let text = formatMessage(message, .fault) | ||
| if Log.prints { | ||
| print(text) | ||
| } else { | ||
| os_log("%@", log: log, type: .fault, text) | ||
| } | ||
| } | ||
|
|
||
| func error(_ message: String, _ function: String = #function, _ line: Int = #line) { | ||
| let text = formatMessage(message, .error, function, line) | ||
| if Log.prints { | ||
| print(text) | ||
| } else { | ||
| os_log("%@", log: log, type: .error, text) | ||
| } | ||
| } | ||
|
|
||
| // os_log left out warnings, so reuse default type for that | ||
| func warn(_ message: String) { | ||
| let text = formatMessage(message, .default) | ||
| if Log.prints { | ||
| print(text) | ||
| } else { | ||
| os_log("%@", log: log, type: .default, text) | ||
| } | ||
| } | ||
|
|
||
| func info(_ message: String) { | ||
| let text = formatMessage(message, .info) | ||
| if Log.prints { | ||
| print(text) | ||
| } else { | ||
| os_log("%@", log: log, type: .info, text) | ||
| } | ||
| } | ||
|
|
||
| func debug(_ message: String) { | ||
| // debug logs are stripped from release builds | ||
| #if DEBUG | ||
| let text = formatMessage(message, .debug) | ||
| if Log.prints { | ||
| print(text) | ||
| } else { | ||
| os_log("%@", log: log, type: .debug, text) | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| // Customize this printing as desired. | ||
| private func formatMessage(_ message: String, _ type: OSLogType, _ function: String = "", _ line: Int = 0) -> String { | ||
| var text = "" | ||
|
|
||
| if Log.prints { | ||
| let timestamp = Log.formatTimestamp() | ||
|
|
||
| // These messages never go out to the system console, just the debugger. | ||
| switch type { | ||
| case .debug: | ||
| text += "\(timestamp)D[\(category)] \(message)" | ||
| case .info: | ||
| text += "\(timestamp)I[\(category)] \(message)" | ||
| case .default: // not a keyword | ||
| text += "\(timestamp)W[\(category)] \(message)" | ||
| case .error: | ||
| text += "\(timestamp)E[\(category)] \(message)\n" | ||
| text += Log.formatLocation(file, line, function) | ||
| case .fault: | ||
| text += "\(timestamp)F[\(category)] \(message)\n" | ||
| text += Log.formatLocation(file, line, function) | ||
| default: | ||
| text += message | ||
| } | ||
| } else { | ||
| // Consider reporting the data above to os_log. | ||
| // os_log reports data, time, app, threadId and message to stderr. | ||
| text += message | ||
| } | ||
|
|
||
| if Log.stacktraces && (type == .error || type == .fault) { | ||
| text += "\n" | ||
|
|
||
| // Improve this - these are mangled symbols without file/line of where | ||
| Thread.callStackSymbols.forEach { text += $0 + "\n" } | ||
| } | ||
|
|
||
| return text | ||
| } | ||
|
|
||
| // location support | ||
| private static func formatLocation(_ file: String, _ line: Int, _ function: String) -> String { | ||
| var text = "" | ||
| let threadName = Thread.current.name ?? "" | ||
| var queueName = OperationQueue.current?.name ?? "" | ||
| if !queueName.isEmpty { | ||
| queueName = ":" + queueName | ||
| } | ||
|
|
||
| text += " at \(file):\(line)@\(function)\n" | ||
| text += " on \(threadName)\(queueName)" | ||
| return text | ||
| } | ||
|
|
||
| private static func stripFilePathAndExtension(_ path: String) -> String { | ||
| let str = path as NSString | ||
| return (str.deletingPathExtension as NSString).lastPathComponent | ||
| } | ||
|
|
||
| // timestamp support | ||
| private static func initTimestampFormatter() -> DateFormatter { | ||
| let formatter = DateFormatter() | ||
| formatter.locale = Locale.current | ||
| formatter.setLocalizedDateFormatFromTemplate("HH:mm:ss.SSS") // ms resolution | ||
| return formatter | ||
| } | ||
|
|
||
| private static func timeFromStart() -> Double { | ||
| return abs(Log.timestamp() - Log.timestampStart) | ||
| } | ||
|
|
||
| private static func timeAbsolute() -> String { | ||
| let timestamp = Log.timeFromStart() | ||
| let date = Date(timeInterval: timestamp, since: Log.timestampStartDate) | ||
| return timestampFormatter.string(from: date) | ||
| } | ||
|
|
||
| private static func formatTimestamp() -> String { | ||
| var timestamp = "" | ||
| if Log.timestamps { | ||
| if Log.absoluteTimestamps { | ||
| timestamp = Log.timeAbsolute() + " " | ||
| } else { | ||
| timestamp = String(format: "%.3fs ", Log.timeFromStart()) | ||
| } | ||
| } | ||
| return timestamp | ||
| } | ||
|
|
||
| // need timestamps in other parts of the app | ||
| static func timestamp() -> Double { | ||
| if Log.timestampToSeconds == 0 { | ||
| // Cache the conversion. Note that clock rate can change with cpu throttling. | ||
| // These are high-resolution timestamps taken from the system timer. | ||
| var info = mach_timebase_info(numer: 0, denom: 0) | ||
| mach_timebase_info(&info) | ||
| let numer = Double(info.numer) | ||
| let denom = Double(info.denom) | ||
| Log.timestampToSeconds = 1e-9 * (numer / denom) // inverse so we can multiply | ||
| } | ||
|
|
||
| let timestamp = Double(mach_absolute_time()) | ||
| let time = timestamp * Log.timestampToSeconds | ||
| return time | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.