-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: logs now show up in mac console app #80
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,49 @@ | ||
import Foundation | ||
import os.log | ||
import OSLog | ||
|
||
public protocol Logger { | ||
func verbose(_ message: String) | ||
/// mockable logger + abstract that allows you to log to multiple places if you wish | ||
public protocol Logger: AutoMockable { | ||
/// the noisey log level. Feel free to spam this log level with any | ||
/// information about the SDK that would be useful for debugging the SDK. | ||
func debug(_ message: String) | ||
/// Not noisy log messages. Good for general information such as | ||
/// when the background queue begins and ends running but use `debug` | ||
/// for the status of each background queue task running. | ||
func info(_ message: String) | ||
func warning(_ message: String) | ||
/// the SDK is in an unstable state that you want to notify | ||
/// the customer or our development team about. | ||
func error(_ message: String) | ||
} | ||
|
||
// log messages to console. | ||
// sourcery: InjectRegister = "Logger" | ||
public class ConsoleLogger: Logger { | ||
private let prefix = "[Cio]" | ||
// allows filtering in Console mac app | ||
private let logSubsystem = "io.customer.sdk" | ||
private let logCategory = "CIO" | ||
|
||
public func verbose(_ message: String) { | ||
print("\(prefix) Verbose: \(message)") | ||
// Unified logging for Swift. https://www.avanderlee.com/workflow/oslog-unified-logging/ | ||
// This means we can view logs in xcode console + Console app. | ||
private func printMessage(_ message: String, _ level: OSLogType) { | ||
if #available(iOS 14, *) { | ||
let logger = os.Logger(subsystem: self.logSubsystem, category: self.logCategory) | ||
logger.info("\(message, privacy: .public)") | ||
} else { | ||
let logger = OSLog(subsystem: logSubsystem, category: logCategory) | ||
os_log("%{public}@", log: logger, type: .info, message) | ||
} | ||
} | ||
|
||
public func debug(_ message: String) { | ||
print("\(prefix) Debug: \(message)") | ||
printMessage(message, .debug) | ||
} | ||
|
||
public func info(_ message: String) { | ||
print("\(prefix) Info: \(message)") | ||
} | ||
|
||
public func warning(_ message: String) { | ||
print("\(prefix) Warning: \(message)") | ||
printMessage(message, .info) | ||
} | ||
|
||
public func error(_ message: String) { | ||
print("\(prefix) Error: \(message)") | ||
printMessage(message, .error) | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
decided to cut the warn level?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. The original list of log levels (info, warning, verbose, etc) mostly came Android TBH.
The Swift Logger class does not include a
warning
case so I removed it.