chore: Misc. logging changes (#797)

* Add .none ClientLogMode and make it defualt to make logging opt-in. * Adjust logging levels for URL session HTTP client. * Add public init and set default log level for initialize() method to .error. * Fix SwiftLogger::log method to pass in the designated log level (self.level) to the underlying Logger::log method, instead of wrongly copying the log level passed into SwiftLogger::log. --------- Co-authored-by: Sichan Yoo <[email protected]>
smithy-lang · Aug 13, 2024 · 896e95a · 896e95a
1 parent a6d1331
commit 896e95a
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 10 deletions.
diff --git a/Sources/ClientRuntime/Config/DefaultClientConfiguration.swift b/Sources/ClientRuntime/Config/DefaultClientConfiguration.swift
@@ -15,7 +15,7 @@ public protocol DefaultClientConfiguration: ClientConfiguration {
 
     /// The log mode to use for client logging.
     ///
-    /// If none is provided, `.request` will be used.
+    /// If none is provided, `.none` will be used.
     var clientLogMode: ClientLogMode { get set }
 
     /// The network endpoint to use.

diff --git a/Sources/ClientRuntime/Config/DefaultSDKRuntimeConfiguration.swift b/Sources/ClientRuntime/Config/DefaultSDKRuntimeConfiguration.swift
@@ -54,7 +54,7 @@ public struct DefaultSDKRuntimeConfiguration<DefaultSDKRuntimeRetryStrategy: Ret
 
     /// The log mode to use for client logging.
     ///
-    /// If none is provided, `.request` will be used.
+    /// If none is provided, `.none` will be used.
     public var clientLogMode: ClientLogMode
 
     /// The network endpoint to use.
@@ -126,8 +126,8 @@ public extension DefaultSDKRuntimeConfiguration {
 
     /// The log mode to use when none is provided
     ///
-    /// Defaults to `.request`.
-    static var defaultClientLogMode: ClientLogMode { .requestWithoutAuthorizationHeader }
+    /// Defaults to `.none`.
+    static var defaultClientLogMode: ClientLogMode { .none }
 
     static var defaultAuthSchemeResolver: AuthSchemeResolver { DefaultAuthSchemeResolver() }
 }

diff --git a/Sources/ClientRuntime/Networking/Http/URLSession/FoundationStreamBridge.swift b/Sources/ClientRuntime/Networking/Http/URLSession/FoundationStreamBridge.swift
@@ -281,7 +281,7 @@ class FoundationStreamBridge: NSObject, StreamDelegate {
                 // `writeCount` will be a positive number if bytes were written.
                 // Remove the written bytes from the front of the buffer.
                 if writeCount > 0 {
-                    logger.info("FoundationStreamBridge: wrote \(writeCount) bytes to request body")
+                    logger.debug("FoundationStreamBridge: wrote \(writeCount) bytes to request body")
                     buffer.removeFirst(writeCount)
                     // TICK - smithy.client.http.bytes_sent
                     var attributes = Attributes()

diff --git a/Sources/ClientRuntime/Networking/Http/URLSession/URLSessionHTTPClient.swift b/Sources/ClientRuntime/Networking/Http/URLSession/URLSessionHTTPClient.swift
@@ -198,15 +198,15 @@ public final class URLSessionHTTPClient: HTTPClient {
             guard let tlsOptions = tlsOptions, tlsOptions.useSelfSignedCertificate,
                   let certFile = tlsOptions.certificate,
                   let serverTrust = challenge.protectionSpace.serverTrust else {
-                logger.error(
+                logger.info(
                     "Either TLSOptions not set or missing values! Using default trust store."
                 )
                 completionHandler(.performDefaultHandling, nil)
                 return
             }
 
             guard let customRoot = Bundle.main.certificate(named: certFile) else {
-                logger.error("Certificate not found! Using default trust store.")
+                logger.info("Certificate not found! Using default trust store.")
                 completionHandler(.performDefaultHandling, nil)
                 return
             }
@@ -232,7 +232,7 @@ public final class URLSessionHTTPClient: HTTPClient {
             guard let tlsOptions, tlsOptions.useProvidedKeystore,
                   let keystoreName = tlsOptions.pkcs12Path,
                   let keystorePasword = tlsOptions.pkcs12Password else {
-                logger.error(
+                logger.info(
                     "Either TLSOptions not set or missing values! Using default keystore."
                 )
                 completionHandler(.performDefaultHandling, nil)

diff --git a/Sources/ClientRuntime/Telemetry/Logging/ClientLogMode.swift b/Sources/ClientRuntime/Telemetry/Logging/ClientLogMode.swift
@@ -6,6 +6,7 @@
 //
 
 public enum ClientLogMode {
+    case none
     case request
     case requestWithBody
     case response

diff --git a/Sources/ClientRuntime/Telemetry/Logging/SDKLoggingSystem.swift b/Sources/ClientRuntime/Telemetry/Logging/SDKLoggingSystem.swift
@@ -11,12 +11,14 @@ public actor SDKLoggingSystem {
     private var isInitialized = false
     private var factories: [String: SDKLogHandlerFactory] = [:]
 
+    public init() {}
+
     public func add(logHandlerFactory: SDKLogHandlerFactory) {
         let label = logHandlerFactory.label
         factories[label] = logHandlerFactory
     }
 
-    public func initialize(defaultLogLevel: SDKLogLevel = .info) async {
+    public func initialize(defaultLogLevel: SDKLogLevel = .error) async {
         if isInitialized { return } else { isInitialized = true }
         let ptr = factories
         LoggingSystem.bootstrap { label in

diff --git a/Sources/Smithy/Logging/SwiftLog+LogAgent.swift b/Sources/Smithy/Logging/SwiftLog+LogAgent.swift
@@ -16,6 +16,12 @@ public struct SwiftLogger: LogAgent {
         self.logLevel = LogAgentLevel.info
     }
 
+    public init(label: String, logLevel: LogAgentLevel) {
+        self.label = label
+        self.logger = Logger(label: label)
+        self.logLevel = logLevel
+    }
+
     public var level: LogAgentLevel {
         get {
             return logLevel
@@ -39,7 +45,7 @@ public struct SwiftLogger: LogAgent {
         let mappedDict = metadata?.mapValues { (value) -> Logger.MetadataValue in
             return Logger.MetadataValue.string(value)
         }
-        self.logger.log(level: logLevel.toLoggerLevel(),
+        self.logger.log(level: level.toLoggerLevel(),
                         Logger.Message(stringLiteral: message),
                         metadata: mappedDict,
                         source: source,