RUMM-1113 Pass logged error to RUM integration

Sources/Datadog/Core/Utils/DDError.swift

@@ -7,26 +7,26 @@
 import Foundation
 
 /// Common representation of Swift `Error` used by different features.
-internal struct DDError {
-    let title: String
+internal struct DDError: Equatable {
+    let type: String
     let message: String
-    let details: String
+    let stack: String
 
     init(error: Error) {
         if isNSErrorOrItsSubclass(error) {
             let nsError = error as NSError
-            self.title = "\(nsError.domain) - \(nsError.code)"
+            self.type = "\(nsError.domain) - \(nsError.code)"
             if nsError.userInfo[NSLocalizedDescriptionKey] != nil {
                 self.message = nsError.localizedDescription
             } else {
                 self.message = nsError.description
             }
-            self.details = "\(nsError)"
+            self.stack = "\(nsError)"
         } else {
             let swiftError = error
-            self.title = "\(type(of: swiftError))"
+            self.type = "\(Swift.type(of: swiftError))"
             self.message = "\(swiftError)"
-            self.details = "\(swiftError)"
+            self.stack = "\(swiftError)"
         }
     }
 }

Sources/Datadog/FeaturesIntegration/LoggingForTracingAdapter.swift

@@ -77,6 +77,8 @@ internal struct LoggingForTracingAdapter {
             loggingOutput.writeLogWith(
                 level: level,
                 message: message,
+                // TODO: RUMM-1112
+                error: nil,
                 date: date,
                 attributes: LogAttributes(
                     userAttributes: userAttributes,

Sources/Datadog/FeaturesIntegration/LoggingWithRUMIntegration.swift

@@ -27,6 +27,11 @@ internal struct LoggingWithRUMErrorsIntegration {
     private let rumErrorsIntegration = RUMErrorsIntegration()
 
     func addError(for log: Log) {
-        rumErrorsIntegration.addError(with: log.message, stack: nil, source: .logger)
+        rumErrorsIntegration.addError(
+            with: log.error?.message ?? log.message,
+            type: log.error?.type,
+            stack: log.error?.stack,
+            source: .logger
+        )
     }
 }

Sources/Datadog/FeaturesIntegration/RUMIntegrations.swift

@@ -38,7 +38,7 @@ internal struct RUMContextIntegration {
 /// Creates RUM Errors with given message.
 internal struct RUMErrorsIntegration {
     /// Adds RUM Error with given message and stack to current RUM View.
-    func addError(with message: String, stack: String?, source: RUMInternalErrorSource, attributes: [AttributeKey: AttributeValue] = [:]) {
-        rumMonitor?.addError(message: message, stack: stack, source: source, attributes: attributes)
+    func addError(with message: String, type: String?, stack: String?, source: RUMInternalErrorSource, attributes: [AttributeKey: AttributeValue] = [:]) {
+        rumMonitor?.addError(message: message, type: type, stack: stack, source: source, attributes: attributes)
     }
 }

Sources/Datadog/Logger.swift

@@ -17,12 +17,6 @@ public enum LogLevel: Int, Codable {
     case critical
 }
 
-internal enum ErrorAttributes {
-    static let kind = "error.kind"
-    static let message = "error.message"
-    static let stack = "error.stack"
-}
-
 /// Because `Logger` is a common name widely used across different projects, the `Datadog.Logger` may conflict when
 /// using `Logger.builder`. In such case, following `DDLogger` typealias can be used to avoid compiler ambiguity.
 ///
@@ -226,17 +220,6 @@ public class Logger {
         let date = dateProvider.currentDate()
 
         var combinedUserAttributes = messageAttributes ?? [:]
-        if let someError = error {
-            let ddError = DDError(error: someError)
-            let errorAttributes = [
-                ErrorAttributes.kind: ddError.title,
-                ErrorAttributes.message: ddError.message,
-                ErrorAttributes.stack: ddError.details
-            ]
-            combinedUserAttributes.merge(errorAttributes) { userAttribute, _ in
-                return userAttribute
-            }
-        }
         combinedUserAttributes = queue.sync {
             return self.loggerAttributes.merging(combinedUserAttributes) { _, userAttributeValue in
                 return userAttributeValue // use message attribute when the same key appears also in logger attributes
@@ -260,6 +243,7 @@ public class Logger {
         logOutput.writeLogWith(
             level: level,
             message: message,
+            error: error.flatMap { DDError(error: $0) },
             date: date,
             attributes: LogAttributes(
                 userAttributes: combinedUserAttributes,

Sources/Datadog/Logging/Log/LogBuilder.swift

@@ -25,11 +25,12 @@ internal struct LogBuilder {
     /// Adjusts log's time (device time) to server time.
     let dateCorrector: DateCorrectorType?
 
-    func createLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>) -> Log {
+    func createLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) -> Log {
         return Log(
             date: dateCorrector?.currentCorrection.applying(to: date) ?? date,
             status: logStatus(for: level),
             message: message,
+            error: error,
             serviceName: serviceName,
             environment: environment,
             loggerName: loggerName,

Sources/Datadog/Logging/Log/LogEncoder.swift

@@ -21,6 +21,7 @@ internal struct Log: Encodable {
     let date: Date
     let status: Status
     let message: String
+    let error: DDError?
     let serviceName: String
     let environment: String
     let loggerName: String
@@ -49,6 +50,12 @@ internal struct LogEncoder {
         case serviceName = "service"
         case tags = "ddtags"
 
+        // MARK: - Error
+
+        case errorKind = "error.kind"
+        case errorMessage = "error.message"
+        case errorStack = "error.stack"
+
         // MARK: - Application info
 
         case applicationVersion = "version"
@@ -98,6 +105,13 @@ internal struct LogEncoder {
         try container.encode(log.message, forKey: .message)
         try container.encode(log.serviceName, forKey: .serviceName)
 
+        // Encode log.error properties
+        if let someError = log.error {
+            try container.encode(someError.type, forKey: .errorKind)
+            try container.encode(someError.message, forKey: .errorMessage)
+            try container.encode(someError.stack, forKey: .errorStack)
+        }
+
         // Encode logger info
         try container.encode(log.loggerName, forKey: .loggerName)
         try container.encode(log.loggerVersion, forKey: .loggerVersion)

Sources/Datadog/Logging/LogOutputs/LogConsoleOutput.swift

@@ -37,8 +37,8 @@ internal struct LogConsoleOutput: LogOutput {
         self.printingFunction = printingFunction
     }
 
-    func writeLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>) {
-        let log = logBuilder.createLogWith(level: level, message: message, date: date, attributes: attributes, tags: tags)
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+        let log = logBuilder.createLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags)
         printingFunction(formatter.format(log: log))
     }
 }

Sources/Datadog/Logging/LogOutputs/LogFileOutput.swift

@@ -13,8 +13,8 @@ internal struct LogFileOutput: LogOutput {
     /// Integration with RUM Errors.
     let rumErrorsIntegration: LoggingWithRUMErrorsIntegration?
 
-    func writeLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>) {
-        let log = logBuilder.createLogWith(level: level, message: message, date: date, attributes: attributes, tags: tags)
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+        let log = logBuilder.createLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags)
         fileWriter.write(value: log)
 
         if level.rawValue >= LogLevel.error.rawValue {

Sources/Datadog/Logging/LogOutputs/LogOutput.swift

@@ -15,5 +15,5 @@ internal struct LogAttributes {
 
 /// Type writting logs to some destination.
 internal protocol LogOutput {
-    func writeLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>)
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>)
 }

Sources/Datadog/Logging/LogOutputs/LogUtilityOutputs.swift

@@ -8,7 +8,7 @@ import Foundation
 
 /// `LogOutput` which does nothing.
 internal struct NoOpLogOutput: LogOutput {
-    func writeLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>) {}
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {}
 }
 
 /// Combines one or more `LogOutputs` into one.
@@ -19,18 +19,18 @@ internal struct CombinedLogOutput: LogOutput {
         self.combinedOutputs = outputs
     }
 
-    func writeLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>) {
-        combinedOutputs.forEach { $0.writeLogWith(level: level, message: message, date: date, attributes: attributes, tags: tags) }
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+        combinedOutputs.forEach { $0.writeLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags) }
     }
 }
 
 internal struct ConditionalLogOutput: LogOutput {
     let conditionedOutput: LogOutput
     let condition: (LogLevel) -> Bool
 
-    func writeLogWith(level: LogLevel, message: String, date: Date, attributes: LogAttributes, tags: Set<String>) {
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
         if condition(level) {
-            conditionedOutput.writeLogWith(level: level, message: message, date: date, attributes: attributes, tags: tags)
+            conditionedOutput.writeLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags)
         }
     }
 }

Sources/Datadog/OpenTracing/OTSpan.swift

@@ -98,9 +98,9 @@ public extension OTSpan {
     ) {
         let dderror = DDError(error: error)
         setError(
-            kind: dderror.title,
+            kind: dderror.type,
             message: dderror.message,
-            stack: dderror.details,
+            stack: dderror.stack,
             file: file,
             line: line
         )

Sources/Datadog/RUM/RUMMonitor/RUMCommand.swift

@@ -63,14 +63,17 @@ internal struct RUMAddCurrentViewErrorCommand: RUMCommand {
 
     /// The error message.
     let message: String
-    /// The origin of this error.
-    let source: RUMInternalErrorSource
+    /// Error type.
+    let type: String?
     /// Error stacktrace.
     let stack: String?
+    /// The origin of this error.
+    let source: RUMInternalErrorSource
 
     init(
         time: Date,
         message: String,
+        type: String?,
         stack: String?,
         source: RUMInternalErrorSource,
         attributes: [AttributeKey: AttributeValue]
@@ -79,6 +82,7 @@ internal struct RUMAddCurrentViewErrorCommand: RUMCommand {
         self.source = source
         self.attributes = attributes
         self.message = message
+        self.type = type
         self.stack = stack
     }
 
@@ -93,8 +97,9 @@ internal struct RUMAddCurrentViewErrorCommand: RUMCommand {
         self.attributes = attributes
 
         let dderror = DDError(error: error)
-        self.message = dderror.title
-        self.stack = dderror.details
+        self.message = dderror.message
+        self.type = dderror.type
+        self.stack = dderror.stack
     }
 }
 
@@ -167,6 +172,8 @@ internal struct RUMStopResourceWithErrorCommand: RUMResourceCommand {
 
     /// The error message.
     let errorMessage: String
+    /// Error type.
+    let errorType: String?
     /// The origin of the error (network, webview, ...)
     let errorSource: RUMInternalErrorSource
     /// Error stacktrace.
@@ -178,13 +185,15 @@ internal struct RUMStopResourceWithErrorCommand: RUMResourceCommand {
         resourceKey: String,
         time: Date,
         message: String,
+        type: String?,
         source: RUMInternalErrorSource,
         httpStatusCode: Int?,
         attributes: [AttributeKey: AttributeValue]
     ) {
         self.resourceKey = resourceKey
         self.time = time
         self.errorMessage = message
+        self.errorType = type
         self.errorSource = source
         self.attributes = attributes
         self.httpStatusCode = httpStatusCode
@@ -207,9 +216,10 @@ internal struct RUMStopResourceWithErrorCommand: RUMResourceCommand {
         self.httpStatusCode = httpStatusCode
 
         let dderror = DDError(error: error)
-        self.errorMessage = dderror.title
+        self.errorMessage = dderror.message
+        self.errorType = dderror.type
         // The stack will give the networking error (`NSError`) description in most cases:
-        self.stack = dderror.details
+        self.stack = dderror.stack
     }
 }
 

Sources/Datadog/RUM/RUMMonitor/Scopes/RUMResourceScope.swift

@@ -205,7 +205,7 @@ internal class RUMResourceScope: RUMScope {
                 ),
                 source: command.errorSource.toRUMDataFormat,
                 stack: command.stack,
-                type: command.errorMessage
+                type: command.errorType
             ),
             service: nil,
             session: .init(hasReplay: nil, id: context.sessionID.toRUMDataFormat, type: .user),

Sources/Datadog/RUM/RUMMonitor/Scopes/RUMViewScope.swift

@@ -320,7 +320,7 @@ internal class RUMViewScope: RUMScope, RUMContextProvider {
                 resource: nil,
                 source: command.source.toRUMDataFormat,
                 stack: command.stack,
-                type: command.message
+                type: command.type
             ),
             service: nil,
             session: .init(hasReplay: nil, id: context.sessionID.toRUMDataFormat, type: .user),

Sources/Datadog/RUMMonitor.swift

@@ -307,11 +307,12 @@ public class RUMMonitor: DDRUMMonitor, RUMCommandSubscriber {
             }
             return nil
         }()
-        addError(message: message, stack: stack, source: RUMInternalErrorSource(source), attributes: attributes)
+        addError(message: message, type: nil, stack: stack, source: RUMInternalErrorSource(source), attributes: attributes)
     }
 
     internal func addError(
         message: String,
+        type: String?,
         stack: String?,
         source: RUMInternalErrorSource,
         attributes: [AttributeKey: AttributeValue]
@@ -320,6 +321,7 @@ public class RUMMonitor: DDRUMMonitor, RUMCommandSubscriber {
             command: RUMAddCurrentViewErrorCommand(
                 time: dateProvider.currentDate(),
                 message: message,
+                type: type,
                 stack: stack,
                 source: source,
                 attributes: attributes
@@ -491,6 +493,7 @@ public class RUMMonitor: DDRUMMonitor, RUMCommandSubscriber {
                 resourceKey: resourceKey,
                 time: dateProvider.currentDate(),
                 message: errorMessage,
+                type: nil,
                 source: .network,
                 httpStatusCode: (response as? HTTPURLResponse)?.statusCode,
                 attributes: attributes

Tests/DatadogBenchmarkTests/DataStorage/LoggingStorageBenchmarkTests.swift

@@ -80,6 +80,7 @@ class LoggingStorageBenchmarkTests: XCTestCase {
             date: Date(),
             status: .info,
             message: "message \(Int.random(in: 0..<100))",
+            error: DDError(error: ErrorMock("description")),
             serviceName: "service-name",
             environment: "benchmarks",
             loggerName: "logger-name",

Tests/DatadogIntegrationTests/Scenarios/RUM/RUMManualInstrumentationScenarioTests.swift

@@ -68,7 +68,8 @@ class RUMManualInstrumentationScenarioTests: IntegrationTests, RUMCommonAsserts
         XCTAssertEqual(view1.resourceEvents[0].resource.type, .image)
         XCTAssertGreaterThan(view1.resourceEvents[0].resource.duration, 100_000_000 - 1) // ~0.1s
         XCTAssertLessThan(view1.resourceEvents[0].resource.duration, 100_000_000 * 3) // less than 0.3s
-        XCTAssertEqual(view1.errorEvents[0].error.message, "NSURLErrorDomain - -1011")
+        XCTAssertEqual(view1.errorEvents[0].error.type, "NSURLErrorDomain - -1011")
+        XCTAssertEqual(view1.errorEvents[0].error.message, "Bad response.")
         XCTAssertEqual(
             view1.errorEvents[0].error.stack,
             #"Error Domain=NSURLErrorDomain Code=-1011 "Bad response." UserInfo={NSLocalizedDescription=Bad response.}"#