Add additional debug logs for better traceability #203
Conversation
jguz-pubnub
requested review from
parfeon,
wkal-pubnub and
marcin-cebo
as code owners
| @@ -75,7 +79,14 @@ class EffectDispatcher<Invocation: AnyEffectInvocation, Event, Dependencies>: Di | |||
| storageId id: String, | |||
| notify listener: DispatcherListener<Event> | |||
| ) { | |||
| effectsCache.put(effect: effect, with: id) | |||
| effectsCache.put( | |||
| let currentStateDescr = String(describing: currentState) | ||
| let newStateDescr = String(describing: newState) | ||
|
|
||
| PubNub.log.debug("Exiting \(currentStateDescr)", category: LogCategory.eventEngine.rawValue) |
| return "No URL found in request" | ||
| } | ||
|
|
||
| var debugString = "" |
|
|
||
| switch encryptionResult { | ||
| case .success: | ||
| PubNub.log.debug("Data encrypted successfully", category: LogCategory.crypto.rawValue) |
|
|
||
| @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *) | ||
| extension Logger { | ||
| static var subsystem: String { "com.pubnub"} |
| @@ -96,11 +98,17 @@ final class Request { | |||
| self.requestOperator = MultiplexRequestOperator(operators: operators) | |||
| self.delegate = delegate | |||
|
|
|||
| PubNub.log.debug("Request Created \(requestID) on \(router)") | |||
| PubNub.log.info( | |||
| @@ -254,14 +266,29 @@ final class Request { | |||
| } | |||
|
|
|||
| func didResume(_ task: URLSessionTask) { | |||
| sessionStream?.emitRequest(self, didResume: task) | |||
| PubNub.log.debug( | |||
| "Sending HTTP request \(task.requestDescr()) for \(requestID)", | |||
| .debug, | ||
| category: category, | ||
| message: message(), | ||
| date: date, |
| @@ -50,6 +50,10 @@ class EffectDispatcher<Invocation: AnyEffectInvocation, Event, Dependencies>: Di | |||
| notify listener: DispatcherListener<Event> | |||
| ) { | |||
| invocations.forEach { | |||
| PubNub.log.debug( | |||
There was a problem hiding this comment.
Should it be some trace level because level of verbosity would be insane on working Event Engine?
There was a problem hiding this comment.
Here's the currently exposed interface wrt LogType:
public struct LogType: OptionSet, Equatable, Hashable, Sendable {
public let rawValue: UInt32
// Reserverd Log Types
public static let none = LogType([])
public static let debug = LogType(rawValue: 1 << 0)
public static let info = LogType(rawValue: 1 << 1)
public static let event = LogType(rawValue: 1 << 2)
public static let warn = LogType(rawValue: 1 << 3)
public static let error = LogType(rawValue: 1 << 4)
public static let log = LogType(rawValue: 1 << 31)
public static let all = LogType(rawValue: UInt32.max)
public init(rawValue: UInt32) {
self.rawValue = rawValue
}
}
I see two possibilities:
- Treating
debuglevel as atracelevel. However, this might not be what you expect - Add a new
tracetype with the following value(1 << 5)to not to break values introduced before
Regarding the second option, we could then replace all the PubNub.log.debug occurrences I introduced in the scope of this PR with PubNub.log.trace. Which option do you prefer?
| let currentStateDescr = String(describing: currentState) | ||
| let newStateDescr = String(describing: newState) | ||
|
|
||
| PubNub.log.debug("Exiting \(currentStateDescr)", category: LogCategory.eventEngine.rawValue) |
There was a problem hiding this comment.
I was curious about performance hit because of formatting which won't be used if logger is off. Should we have some kind of closure in this function which conditionally will be called?
There was a problem hiding this comment.
This is how exactly it should work under the hood. The message parameter for the PubNub.log.debug and simillar methods as well uses autoclosure, which means that a value evaluation will be deferred if needed. Anyway, I will double check it if it works as expected and let you know
feat(logger): add
OSLogWriteras the recommendedLogWriterto usefeat(logger): refine
LogWriterprotocol signature to support build-inLoggerfrom theosframeworkfeat(logger): enhance object descriptions with
CustomStringConvertiblefeat(logger): add explanatory documentation for debug-level logging messages