Structured Logs: Add default attributes (#5593)

denrase · web-flow · commit 99104c9cbeb2 · 2025-07-21T10:02:50.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ### Features
 
-- Add experimental support for capturing structured logs via `SentrySDK.logger` (#5532)
+- Add experimental support for capturing structured logs via `SentrySDK.logger` (#5532, #5593)
 
 ### Improvements
 
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
@@ -795,6 +795,7 @@
 		925824C22CB5897700C9B20B /* SentrySessionReplayIntegration-Hybrid.h in Headers */ = {isa = PBXBuildFile; fileRef = D80382BE2C09C6FD0090E048 /* SentrySessionReplayIntegration-Hybrid.h */; settings = {ATTRIBUTES = (Private, ); }; };
 		92672BB629C9A2A9006B021C /* SentryBreadcrumb+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 92672BB529C9A2A9006B021C /* SentryBreadcrumb+Private.h */; settings = {ATTRIBUTES = (Private, ); }; };
 		927A5CC42DD7626B00B82404 /* SentryEnvelopeItemHeaderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 927A5CC32DD7626400B82404 /* SentryEnvelopeItemHeaderTests.swift */; };
+		928207C42E251B8F009285A4 /* SentryScope+PrivateSwift.h in Headers */ = {isa = PBXBuildFile; fileRef = 928207C32E251B8F009285A4 /* SentryScope+PrivateSwift.h */; };
 		9286059529A5096600F96038 /* SentryGeo.h in Headers */ = {isa = PBXBuildFile; fileRef = 9286059429A5096600F96038 /* SentryGeo.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		9286059729A5098900F96038 /* SentryGeo.m in Sources */ = {isa = PBXBuildFile; fileRef = 9286059629A5098900F96038 /* SentryGeo.m */; };
 		9286059929A50BAB00F96038 /* SentryGeoTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9286059829A50BAA00F96038 /* SentryGeoTests.swift */; };
@@ -1964,9 +1965,9 @@
 		84A789092C0E9F5800FF0803 /* SentrySpan+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentrySpan+Private.h"; path = "include/SentrySpan+Private.h"; sourceTree = "<group>"; };
 		84A8891A28DBD28900C51DFD /* SentryDevice.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryDevice.h; path = include/SentryDevice.h; sourceTree = "<group>"; };
 		84A8891B28DBD28900C51DFD /* SentryDevice.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryDevice.m; sourceTree = "<group>"; };
+		84A8892028DBD8D600C51DFD /* SentryDeviceTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryDeviceTests.m; sourceTree = "<group>"; };
 		84A898522E163072009A551E /* SentryProfileConfiguration.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryProfileConfiguration.h; path = ../include/SentryProfileConfiguration.h; sourceTree = "<group>"; };
 		84A898532E163072009A551E /* SentryProfileConfiguration.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryProfileConfiguration.m; sourceTree = "<group>"; };
-		84A8892028DBD8D600C51DFD /* SentryDeviceTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryDeviceTests.m; sourceTree = "<group>"; };
 		84A898CD2E1DBDD1009A551E /* SentryAppStartProfilingConfigurationChangeTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryAppStartProfilingConfigurationChangeTests.swift; sourceTree = "<group>"; };
 		84A899342E218C5F009A551E /* CLAUDE.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CLAUDE.md; sourceTree = "<group>"; };
 		84A903702D39F66F00690CE4 /* SentryUserFeedbackFormViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUserFeedbackFormViewModel.swift; sourceTree = "<group>"; };
@@ -2060,6 +2061,7 @@
 		92235CAF2E155B2600865983 /* SentryLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryLoggerTests.swift; sourceTree = "<group>"; };
 		92672BB529C9A2A9006B021C /* SentryBreadcrumb+Private.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "SentryBreadcrumb+Private.h"; path = "include/HybridPublic/SentryBreadcrumb+Private.h"; sourceTree = "<group>"; };
 		927A5CC32DD7626400B82404 /* SentryEnvelopeItemHeaderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryEnvelopeItemHeaderTests.swift; sourceTree = "<group>"; };
+		928207C32E251B8F009285A4 /* SentryScope+PrivateSwift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentryScope+PrivateSwift.h"; path = "include/SentryScope+PrivateSwift.h"; sourceTree = "<group>"; };
 		9286059429A5096600F96038 /* SentryGeo.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryGeo.h; path = Public/SentryGeo.h; sourceTree = "<group>"; };
 		9286059629A5098900F96038 /* SentryGeo.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SentryGeo.m; sourceTree = "<group>"; };
 		9286059829A50BAA00F96038 /* SentryGeoTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SentryGeoTests.swift; sourceTree = "<group>"; };
@@ -2782,6 +2784,7 @@
 				7D0637022382B34300B30749 /* SentryScope.h */,
 				7D65260B237F649E00113EA2 /* SentryScope.m */,
 				632331F7240506DF008D91D6 /* SentryScope+Private.h */,
+				928207C32E251B8F009285A4 /* SentryScope+PrivateSwift.h */,
 				7BCFBD662681C95000BC27D8 /* SentryScopeObserver.h */,
 				15360CEF2433A16D00112302 /* SentryInstallation.h */,
 				15360CEC2433A15500112302 /* SentryInstallation.m */,
@@ -4848,6 +4851,7 @@
 				63FE710320DA4C1000CDBAE8 /* SentryCrashMachineContext_Apple.h in Headers */,
 				844EDC6F294143B900C86F34 /* SentryNSProcessInfoWrapper.h in Headers */,
 				D8479328278873A100BE8E99 /* SentryByteCountFormatter.h in Headers */,
+				928207C42E251B8F009285A4 /* SentryScope+PrivateSwift.h in Headers */,
 				63AA76981EB9C1C200D153DE /* SentryClient.h in Headers */,
 				0A9E917128DC7E7000FB4182 /* SentryInternalCDefines.h in Headers */,
 				63FE711F20DA4C1000CDBAE8 /* SentryCrashObjC.h in Headers */,
diff --git a/Sources/Sentry/SentryScope.m b/Sources/Sentry/SentryScope.m
@@ -624,6 +624,11 @@ - (NSDictionary *)buildTraceContext:(nullable id<SentrySpan>)span
     }
 }
 
+- (NSString *)propagationContextTraceIdString
+{
+    return [self.propagationContext.traceId sentryIdString];
+}
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/include/SentryPrivate.h b/Sources/Sentry/include/SentryPrivate.h
@@ -24,6 +24,7 @@
 #import "SentryNSDictionarySanitize.h"
 #import "SentryProfiler+Private.h"
 #import "SentryRandom.h"
+#import "SentryScope+PrivateSwift.h"
 #import "SentrySdkInfo.h"
 #import "SentrySerialization.h"
 #import "SentrySession.h"
diff --git a/Sources/Sentry/include/SentryScope+PrivateSwift.h b/Sources/Sentry/include/SentryScope+PrivateSwift.h
@@ -0,0 +1,14 @@
+#import "SentryScope.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+// Added to only expose a limited sub-set of internal API needed in the Swift layer.
+@interface SentryScope ()
+
+// This is a workaround to make the traceId available in the Swift layer.
+// Can't expose the SentryId directly for some reason.
+@property (nonatomic, readonly) NSString *propagationContextTraceIdString;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/Sources/Swift/Protocol/SentryLog.swift b/Sources/Swift/Protocol/SentryLog.swift
@@ -1,6 +1,6 @@
 struct SentryLog: Codable {
     let timestamp: Date
-    var traceId: SentryId
+    let traceId: SentryId
     let level: SentryLog.Level
     let body: String
     let attributes: [String: SentryLog.Attribute]
@@ -19,18 +19,18 @@ struct SentryLog: Codable {
     /// by the time processing completes, it is guaranteed to be a valid non-empty trace id.
     init(
         timestamp: Date,
-        traceId: SentryId? = nil,
+        traceId: SentryId,
         level: SentryLog.Level,
         body: String,
         attributes: [String: SentryLog.Attribute],
         severityNumber: Int? = nil
     ) {
         self.timestamp = timestamp
-        self.traceId = traceId ?? SentryId.empty
+        self.traceId = traceId
         self.level = level
         self.body = body
         self.attributes = attributes
-        self.severityNumber = severityNumber
+        self.severityNumber = severityNumber ?? level.toSeverityNumber()
     }
     
     init(from decoder: any Decoder) throws {
diff --git a/Sources/Swift/Tools/SentryLogBatcher.swift b/Sources/Swift/Tools/SentryLogBatcher.swift
@@ -7,8 +7,11 @@ import Foundation
     
     private let client: SentryClient
     
+    let options: Options
+    
     @_spi(Private) public init(client: SentryClient) {
         self.client = client
+        self.options = client.options
         super.init()
     }
     
diff --git a/Sources/Swift/Tools/SentryLogger.swift b/Sources/Swift/Tools/SentryLogger.swift
@@ -1,3 +1,5 @@
+@_implementationOnly import _SentryPrivate
+
 import Foundation
 
 /// **EXPERIMENTAL** - A structured logging API for Sentry.
@@ -101,13 +103,36 @@ public final class SentryLogger: NSObject {
         guard let batcher else {
             return
         }
-        let logAttributes = attributes.mapValues { SentryLog.Attribute(value: $0) }
-        let log = SentryLog(
-            timestamp: dateProvider.date(),
-            level: level,
-            body: body,
-            attributes: logAttributes
+        
+        var logAttributes = attributes.mapValues { SentryLog.Attribute(value: $0) }
+        addDefaultAttributes(to: &logAttributes)
+
+        let propagationContextTraceIdString = hub.scope.propagationContextTraceIdString
+        let propagationContextTraceId = SentryId(uuidString: propagationContextTraceIdString)
+
+        batcher.add(
+            SentryLog(
+                timestamp: dateProvider.date(),
+                traceId: propagationContextTraceId,
+                level: level,
+                body: body,
+                attributes: logAttributes
+            )
         )
-        batcher.add(log)
+    }
+
+    private func addDefaultAttributes(to attributes: inout [String: SentryLog.Attribute]) {
+        guard let batcher else {
+            return
+        }
+        attributes["sentry.sdk.name"] = .string(SentryMeta.sdkName)
+        attributes["sentry.sdk.version"] = .string(SentryMeta.versionString)
+        attributes["sentry.environment"] = .string(batcher.options.environment)
+        if let releaseName = batcher.options.releaseName {
+            attributes["sentry.release"] = .string(releaseName)
+        }
+        if let span = hub.scope.span {
+            attributes["sentry.trace.parent_span_id"] = .string(span.spanId.sentrySpanIdString)
+        }
     }
 }
diff --git a/Tests/Perf/metrics-test.yml b/Tests/Perf/metrics-test.yml
@@ -11,4 +11,4 @@ startupTimeTest:
 
 binarySizeTest:
   diffMin: 200 KiB
-  diffMax: 870 KiB
+  diffMax: 875 KiB
diff --git a/Tests/SentryTests/Protocol/SentryLogTests.swift b/Tests/SentryTests/Protocol/SentryLogTests.swift
@@ -39,6 +39,75 @@ final class SentryLogTests: XCTestCase {
     }
     """.utf8)
     
+    // MARK: - Severity Number Fallback Tests
+    
+    func testConstructorWithExplicitSeverityNumber() throws {
+        let log = SentryLog(
+            timestamp: Date(),
+            traceId: SentryId(),
+            level: .info,
+            body: "Test message",
+            attributes: [:],
+            severityNumber: 99  // Explicit value different from level's default
+        )
+        
+        XCTAssertEqual(log.severityNumber, 99, "Should use explicitly provided severity number")
+        XCTAssertEqual(log.level, .info)
+    }
+    
+    func testConstructorWithoutSeverityNumberFallsBackToLevel() throws {
+        let log = SentryLog(
+            timestamp: Date(),
+            traceId: SentryId(),
+            level: .info,
+            body: "Test message",
+            attributes: [:]
+            // severityNumber not provided - should default to nil and fallback to level
+        )
+        
+        XCTAssertEqual(log.severityNumber, 9, "Should derive severity number from info level")
+        XCTAssertEqual(log.level, .info)
+    }
+    
+    func testConstructorWithNilSeverityNumberFallsBackToLevel() throws {
+        let log = SentryLog(
+            timestamp: Date(),
+            traceId: SentryId(),
+            level: .error,
+            body: "Error message",
+            attributes: [:],
+            severityNumber: nil  // Explicitly nil
+        )
+        
+        XCTAssertEqual(log.severityNumber, 17, "Should derive severity number from error level")
+        XCTAssertEqual(log.level, .error)
+    }
+    
+    func testSeverityNumberFallbackForAllLevels() throws {
+        let testCases: [(SentryLog.Level, Int)] = [
+            (.trace, 1),
+            (.debug, 5),
+            (.info, 9),
+            (.warn, 13),
+            (.error, 17),
+            (.fatal, 21)
+        ]
+        
+        for (level, expectedSeverity) in testCases {
+            let log = SentryLog(
+                timestamp: Date(),
+                traceId: SentryId(),
+                level: level,
+                body: "Test message",
+                attributes: [:]
+                // severityNumber not provided
+            )
+            
+            XCTAssertEqual(log.severityNumber, expectedSeverity, 
+                          "Level \(level) should derive severity number \(expectedSeverity)")
+        }
+    }
+
     func testEncode() throws {
         let data = try encodeToJSONData(data: log)
         let json = try XCTUnwrap(JSONSerialization.jsonObject(with: data) as? [String: Any])
diff --git a/Tests/SentryTests/SentryLogBatcherTests.swift b/Tests/SentryTests/SentryLogBatcherTests.swift
@@ -61,6 +61,7 @@ class SentryLogBatcherTests: XCTestCase {
     ) -> SentryLog {
         return SentryLog(
             timestamp: Date(timeIntervalSince1970: 1_627_846_801),
+            traceId: SentryId.empty,
             level: level,
             body: body,
             attributes: attributes
diff --git a/Tests/SentryTests/SentryLoggerTests.swift b/Tests/SentryTests/SentryLoggerTests.swift
@@ -271,6 +271,59 @@ final class SentryLoggerTests: XCTestCase {
         XCTAssertEqual(logs[5].level, .fatal)
     }
     
+    // MARK: - Default Attributes Tests
+    
+    func testCaptureLog_AddsDefaultAttributes() {
+        fixture.options.environment = "test-environment"
+        fixture.options.releaseName = "1.0.0"
+        
+        let span = fixture.hub.startTransaction(name: "Test Transaction", operation: "test-operation")
+        fixture.hub.scope.span = span
+        
+        sut.info("Test log message")
+        
+        let capturedLog = getLastCapturedLog()
+        
+        // Verify default attributes were added to the log
+        XCTAssertEqual(capturedLog.attributes["sentry.sdk.name"]?.value as? String, SentryMeta.sdkName)
+        XCTAssertEqual(capturedLog.attributes["sentry.sdk.version"]?.value as? String, SentryMeta.versionString)
+        XCTAssertEqual(capturedLog.attributes["sentry.environment"]?.value as? String, "test-environment")
+        XCTAssertEqual(capturedLog.attributes["sentry.release"]?.value as? String, "1.0.0")
+        XCTAssertEqual(capturedLog.attributes["sentry.trace.parent_span_id"]?.value as? String, span.spanId.sentrySpanIdString)
+    }
+    
+    func testCaptureLog_DoesNotAddNilDefaultAttributes() {
+        fixture.options.releaseName = nil
+        
+        sut.info("Test log message")
+        
+        let capturedLog = getLastCapturedLog()
+        
+        XCTAssertNil(capturedLog.attributes["sentry.release"])
+        XCTAssertNil(capturedLog.attributes["sentry.trace.parent_span_id"])
+        
+        // But should still have the non-nil defaults
+        XCTAssertEqual(capturedLog.attributes["sentry.sdk.name"]?.value as? String, SentryMeta.sdkName)
+        XCTAssertEqual(capturedLog.attributes["sentry.sdk.version"]?.value as? String, SentryMeta.versionString)
+        XCTAssertEqual(capturedLog.attributes["sentry.environment"]?.value as? String, fixture.options.environment)
+    }
+
+    func testCaptureLog_SetsTraceIdFromPropagationContext() {
+        fixture.options.experimental.enableLogs = true
+        
+        let expectedTraceId = SentryId()
+        let propagationContext = SentryPropagationContext(trace: expectedTraceId, spanId: SpanId())
+        
+        fixture.hub.scope.propagationContext = propagationContext
+        
+        sut.info("Test log message with trace ID")
+        
+        let capturedLog = getLastCapturedLog()
+        
+        // Verify that the log's trace ID matches the one from the propagation context
+        XCTAssertEqual(capturedLog.traceId, expectedTraceId)
+    }
+    
     // MARK: - Helper Methods
     
     private func assertLogCaptured(
@@ -292,8 +345,9 @@ final class SentryLoggerTests: XCTestCase {
         XCTAssertEqual(capturedLog.body, expectedBody, "Log body mismatch", file: file, line: line)
         XCTAssertEqual(capturedLog.timestamp, fixture.dateProvider.date(), "Log timestamp mismatch", file: file, line: line)
         
+        let numberOfDefaultAttributes = 4
         // Compare attributes
-        XCTAssertEqual(capturedLog.attributes.count, expectedAttributes.count, "Attribute count mismatch", file: file, line: line)
+        XCTAssertEqual(capturedLog.attributes.count, expectedAttributes.count + numberOfDefaultAttributes, "Attribute count mismatch", file: file, line: line)
         
         for (key, expectedAttribute) in expectedAttributes {
             guard let actualAttribute = capturedLog.attributes[key] else {
@@ -322,7 +376,7 @@ final class SentryLoggerTests: XCTestCase {
         let logs = fixture.batcher.addInvocations.invocations
         guard let lastLog = logs.last else {
             XCTFail("No logs captured")
-            return SentryLog(timestamp: Date(), level: .info, body: "", attributes: [:])
+            return SentryLog(timestamp: Date(), traceId: .empty, level: .info, body: "", attributes: [:])
         }
         return lastLog
     }

Original file line number	Diff line number	Diff line change
`@@ -624,6 +624,11 @@ - (NSDictionary *)buildTraceContext:(nullable id<SentrySpan>)span`
`624`	`624`	`}`
`625`	`625`	`}`
`626`	`626`
	`627`	`+- (NSString *)propagationContextTraceIdString`
	`628`	`+{`
	`629`	`+ return [self.propagationContext.traceId sentryIdString];`
	`630`	`+}`
	`631`	`+`
`627`	`632`	`@end`
`628`	`633`
`629`	`634`	`NS_ASSUME_NONNULL_END`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,11 @@ import Foundation`
`7`	`7`
`8`	`8`	`private let client: SentryClient`
`9`	`9`
	`10`	`+ let options: Options`
	`11`	`+`
`10`	`12`	`@_spi(Private) public init(client: SentryClient) {`
`11`	`13`	`self.client = client`
	`14`	`+ self.options = client.options`
`12`	`15`	`super.init()`
`13`	`16`	`}`
`14`	`17`