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
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 |
|---|---|---|
|
|
@@ -46,13 +46,14 @@ | |
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @interface SentryClient () <SentryLogBatcherDelegate> | ||
|
|
||
| @property (nonatomic, strong) SentryTransportAdapter *transportAdapter; | ||
| @property (nonatomic, strong) SentryDebugImageProvider *debugImageProvider; | ||
| @property (nonatomic, strong) id<SentryRandomProtocol> random; | ||
| @property (nonatomic, strong) NSLocale *locale; | ||
| @property (nonatomic, strong) NSTimeZone *timezone; | ||
| @property (nonatomic, strong) SentryLogBatcher *logBatcher; | ||
|
|
||
| @end | ||
|
|
||
|
|
@@ -149,6 +150,10 @@ - (instancetype)initWithOptions:(SentryOptions *)options | |
| self.locale = locale; | ||
| self.timezone = timezone; | ||
| self.attachmentProcessors = [[NSMutableArray alloc] init]; | ||
| self.logBatcher = [[SentryLogBatcher alloc] | ||
| initWithOptions:options | ||
| dispatchQueue:SentryDependencyContainer.sharedInstance.dispatchQueueWrapper]; | ||
| self.logBatcher.delegate = self; | ||
denrase marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| // The SDK stores the installationID in a file. The first call requires file IO. To avoid | ||
| // executing this on the main thread, we cache the installationID async here. | ||
|
|
@@ -654,7 +659,11 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event | |
|
|
||
| - (void)flush:(NSTimeInterval)timeout | ||
| { | ||
| NSTimeInterval captureLogsDuration = [self.logBatcher captureLogs]; | ||
| // Capturing batched logs should never take long, but we need to fall back to a sane value. | ||
| // This is a workaround for experimental logs, until we'll write batched logs to disk, | ||
| // to avoid data loss due to crashes. This is a trade-off until then. | ||
|
||
| [self.transportAdapter flush:fmax(timeout / 2, timeout - captureLogsDuration)]; | ||
denrase marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| - (void)close | ||
|
|
@@ -1111,7 +1120,12 @@ - (void)removeAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmen | |
| return processedAttachments; | ||
| } | ||
|
|
||
| - (void)captureLog:(SentryLog *)log withScope:(SentryScope *)scope | ||
| { | ||
| [self.logBatcher addLog:log scope:scope]; | ||
| } | ||
|
|
||
| - (void)captureLogsData:(NSData *)data with:(NSNumber *)itemCount | ||
| { | ||
| SentryEnvelopeItemHeader *header = | ||
| [[SentryEnvelopeItemHeader alloc] initWithType:SentryEnvelopeItemTypes.log | ||
|
|
||
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 |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| @_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, | ||
| // causing Swift-to-Objective-C bridging issues. These extensions work around that | ||
| // by providing Swift-native methods and properties that use dynamic dispatch internally. | ||
|
|
||
| @objc | ||
| protocol HubSelectors { | ||
| func captureLog(_ log: SentryLog) | ||
| func captureLog(_ log: SentryLog, withScope: Scope) | ||
| } | ||
|
|
||
| @objc | ||
| protocol ClientSelectors { | ||
| func captureLog(_ log: SentryLog, withScope: Scope) | ||
| } | ||
|
|
||
| #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") } | ||
| } | ||
| } | ||
|
|
||
| @objc | ||
| public extension SentryHub { | ||
| /// Captures a log entry and sends it to Sentry. | ||
| /// - Parameter log: The log entry to send to Sentry. | ||
| /// | ||
| /// This method is provided for SPM builds where the Objective-C `captureLog:` method | ||
| /// may not be properly bridged due to `SentryLog` being defined in Swift. | ||
| func capture(log: SentryLog) { | ||
| // Use dynamic dispatch to work around bridging limitations | ||
| perform(#selector(HubSelectors.captureLog(_:)), with: log) | ||
denrase marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| /// Captures a log entry and sends it to Sentry with a specific scope. | ||
| /// - Parameters: | ||
| /// - log: The log entry to send to Sentry. | ||
| /// - scope: The scope containing event metadata. | ||
| /// | ||
| /// This method is provided for SPM builds where the Objective-C `captureLog:withScope:` method | ||
| /// may not be properly bridged due to `SentryLog` being defined in Swift. | ||
| func capture(log: SentryLog, scope: Scope) { | ||
| // Use dynamic dispatch to work around bridging limitations | ||
| perform(#selector(HubSelectors.captureLog(_:withScope:)), with: log, with: scope) | ||
| } | ||
| } | ||
|
|
||
| /// Extension to provide log capture methods for SPM builds. | ||
| @objc | ||
| public extension SentryClient { | ||
| /// Captures a log entry and sends it to Sentry. | ||
| /// - Parameters: | ||
| /// - log: The log entry to send to Sentry. | ||
| /// - scope: The scope containing event metadata. | ||
| func captureLog(_ log: SentryLog, withScope scope: Scope) { | ||
| // Use dynamic dispatch to work around bridging limitations | ||
| perform(#selector(ClientSelectors.captureLog(_:withScope:)), with: log, with: scope) | ||
| } | ||
| } | ||
|
|
||
| #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
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.