Structured Logs: Add log APIs to Hub and Client
#6518
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ | |
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @interface SentryHubInternal () <SentryLoggerDelegate> | ||
|
|
||
| @property (nullable, atomic, strong) SentryClientInternal *client; | ||
| @property (nullable, nonatomic, strong) SentryScope *scope; | ||
|
|
@@ -73,6 +73,10 @@ - (instancetype)initWithClient:(nullable SentryClientInternal *)client | |
| if (_scope) { | ||
| [_crashWrapper enrichScope:SENTRY_UNWRAP_NULLABLE(SentryScope, _scope)]; | ||
| } | ||
|
|
||
| __swiftLogger = [[SentryLogger alloc] | ||
| initWithDelegate:self | ||
| dateProvider:SentryDependencyContainer.sharedInstance.dateProvider]; | ||
| } | ||
|
|
||
| return self; | ||
|
|
@@ -833,6 +837,34 @@ - (void)unregisterSessionListener:(id<SentrySessionListener>)listener | |
| } | ||
| } | ||
|
|
||
| // SentryLoggerDelegate | ||
|
|
||
| - (void)captureLog:(SentryLog *)log | ||
| { | ||
| SentryClientInternal *client = self.client; | ||
| if (client != nil) { | ||
| #if SENTRY_TARGET_REPLAY_SUPPORTED | ||
| NSString *scopeReplayId = self.scope.replayId; | ||
| if (scopeReplayId != nil) { | ||
| // Session mode: use scope replay ID | ||
| [log setAttribute:[[SentryStructuredLogAttribute alloc] initWithString:scopeReplayId] | ||
| forKey:@"sentry.replay_id"]; | ||
| } else { | ||
| // Buffer mode: check if hub has a session replay ID | ||
| NSString *sessionReplayId = [self getSessionReplayId]; | ||
| if (sessionReplayId != nil) { | ||
| [log setAttribute:[[SentryStructuredLogAttribute alloc] | ||
| initWithString:sessionReplayId] | ||
| forKey:@"sentry.replay_id"]; | ||
| [log setAttribute:[[SentryStructuredLogAttribute alloc] initWithBoolean:YES] | ||
| forKey:@"sentry._internal.replay_is_buffering"]; | ||
| } | ||
| } | ||
| #endif | ||
|
There was a problem hiding this comment. Bug: Swift-Objective-C mismatch crashes from log attributesThe |
||
| [client _swiftCaptureLog:log withScope:self.scope]; | ||
| } | ||
| } | ||
|
|
||
| #pragma mark - Protected | ||
|
|
||
| - (NSArray<NSString *> *)trimmedInstalledIntegrationNames | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -633,8 +633,6 @@ + (void)close | |
|
|
||
| [SentrySDKInternal setCurrentHub:nil]; | ||
|
|
||
| [SentryDependencyContainer.sharedInstance.crashWrapper stopBinaryImageCache]; | ||
| [SentryDependencyContainer.sharedInstance.binaryImageCache stop]; | ||
|
|
||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -78,6 +78,10 @@ NS_ASSUME_NONNULL_BEGIN | |
| - (void)addAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor; | ||
| - (void)removeAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor; | ||
|
|
||
| // Do not use this directly, instead use the non-underscored `captureLog` method that is | ||
| // defined through a SentryClient.swift file. | ||
| - (void)_swiftCaptureLog:(NSObject *)log withScope:(SentryScope *)scope; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -29,6 +29,10 @@ NS_ASSUME_NONNULL_BEGIN | |
|
|
||
| @property (nonatomic, strong) NSMutableArray<id<SentryIntegrationProtocol>> *installedIntegrations; | ||
|
|
||
| // Do not use this directly, instead use the non-underscored `logger` property that is | ||
| // defined through a SentryHub.swift file. | ||
| @property (nonatomic, readonly, strong) NSObject *_swiftLogger; | ||
|
|
||
| /** | ||
| * Every integration starts with "Sentry" and ends with "Integration". To keep the payload of the | ||
| * event small we remove both. | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -28,7 +28,6 @@ | |
| #import "SentryANRTrackerV1.h" | ||
| #import "SentryANRTrackerV2.h" | ||
| #import "SentryAsyncLog.h" | ||
| #import "SentryContinuousProfiler.h" | ||
| #import "SentryCrash.h" | ||
| #import "SentryCrashDebug.h" | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| @_implementationOnly import _SentryPrivate | ||
| import Foundation | ||
|
|
||
| // Swift extensions to provide properly typed log-related APIs for SPM builds. | ||
| // In SPM builds, SentryLog is only forward declared in the Objective-C headers, | ||
| // which causes Swift-to-Objective-C bridging issues. These extensions work around | ||
| // that limitation by providing Swift-native methods and properties that use dynamic | ||
| // dispatch internally. | ||
|
|
||
| #if SWIFT_PACKAGE | ||
|
There was a problem hiding this comment. @noahsmartin, can you please double-check if this approach works? There was a problem hiding this comment. This is existing code, I just moved it to its own file so it stays on our radar. Circular dependency issue when installing through SPM, before that, the SPM target on CI would not compile. |
||
|
|
||
| /** | ||
| * Use this callback to drop or modify a log before the SDK sends it to Sentry. Return `nil` to | ||
| * drop the log. | ||
| */ | ||
| public typealias SentryBeforeSendLogCallback = (SentryLog) -> SentryLog? | ||
|
|
||
| @objc | ||
| public extension Options { | ||
| /** | ||
| * Use this callback to drop or modify a log before the SDK sends it to Sentry. Return `nil` to | ||
| * drop the log. | ||
| */ | ||
| @objc | ||
| var beforeSendLog: SentryBeforeSendLogCallback? { | ||
| get { return value(forKey: "beforeSendLogDynamic") as? SentryBeforeSendLogCallback } | ||
| set { setValue(newValue, forKey: "beforeSendLogDynamic") } | ||
| } | ||
| } | ||
|
|
||
| #endif // SWIFT_PACKAGE | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -27,28 +27,13 @@ import Foundation | |
|
|
||
| /// API to access Sentry logs | ||
| @objc public static var logger: SentryLogger { | ||
| if !SentrySDKInternal.isEnabled { | ||
| SentrySDKLog.fatal("Logs called before SentrySDK.start() will be dropped.") | ||
| } | ||
| // We know the type so it's fine to force cast. | ||
| // swiftlint:disable force_cast | ||
| return SentrySDKInternal.currentHub()._swiftLogger as! SentryLogger | ||
| // swiftlint:enable force_cast | ||
|
Comment on lines
+34
to
+36
There was a problem hiding this comment.
There was a problem hiding this comment. Same issue as above, when using SPM, logger would not be visible here due tu circular dependency between Swift/Objc parts of the SDK. |
||
| } | ||
|
|
||
| /// Inits and configures Sentry (`SentryHub`, `SentryClient`) and sets up all integrations. Make sure to | ||
|
|
@@ -360,18 +345,12 @@ import Foundation | |
| /// - note: This might take slightly longer than the specified timeout if there are many batched logs to capture. | ||
| @objc(flush:) | ||
| public static func flush(timeout: TimeInterval) { | ||
| SentrySDKInternal.flush(timeout: timeout) | ||
| } | ||
|
|
||
| /// Closes the SDK, uninstalls all the integrations, and calls `flush` with | ||
| /// `SentryOptions.shutdownTimeInterval`. | ||
| @objc public static func close() { | ||
| SentrySDKInternal.close() | ||
| } | ||
|
|
||
|
|
@@ -412,32 +391,6 @@ import Foundation | |
| SentrySDKInternal.stopProfiler() | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| // swiftlint:enable file_length | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.