Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revise attemptDeliveryOnCrash changelog and header docs #1494

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Revise attemptDeliveryOnCrash changelog and header docs #1494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 23 additions & 27 deletions Bugsnag/include/Bugsnag/BugsnagConfiguration.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,29 @@ BUGSNAG_EXTERN
*/
@property (nonatomic) BOOL sendLaunchCrashesSynchronously;

/**
* Whether Bugsnag should try to send crashing errors prior to app termination.
*
* Delivery will only be attempted for uncaught Objective-C exceptions, and
* while in progress will block the crashing thread for up to 3 seconds.
*
* Delivery will be unreliable due to the necessary short timeout and potential
* memory corruption that caused the crashing error in the first place.
*
* If it fails prior to termination, delivery will be reattempted at next launch
* (the default behavior).
*
* Use of this feature is discouraged because it:
* - may cause the app to hang while delivery occurs and impact the hang rate
* reported in Xcode Organizer
* - will result in duplicate crashes in your dashboard for crashes that were
* fully sent but without receiving an HTTP response within the timeout
* - may prevent other crash reporters from detecting the crash.
*
* By default this value is false.
*/
@property (nonatomic) BOOL attemptDeliveryOnCrash;

/**
* The types of breadcrumbs which will be captured. By default, this is all types.
*/
Expand Down Expand Up @@ -488,33 +511,6 @@ BUGSNAG_EXTERN
*/
@property (nonatomic) BSGTelemetryOptions telemetry;

// =============================================================================
// MARK: - Experimental
// =============================================================================

/**
* Whether Bugsnag should try to send crashing errors prior to app termination.
*
* Delivery will only be attempted for uncaught Objective-C exceptions, and
* while in progress will block the crashing thread for up to 3 seconds.
*
* Delivery will be unreliable due to the necessary short timeout and potential
* memory corruption that caused the crashing error in the first place.
*
* If it fails prior to termination, delivery will be reattempted at next launch
* (the default behavior).
*
* Use of this feature is discouraged because it:
* - may cause the app to hang while delivery occurs and impact the hang rate
* reported in Xcode Organizer
* - will result in duplicate crashes in your dashboard for crashes that were
* fully sent but without receiving an HTTP response within the timeout
* - may prevent other crash reporters from detecting the crash.
*
* By default this value is false.
*/
@property (nonatomic) BOOL attemptDeliveryOnCrash;

// =============================================================================
// MARK: - Plugins
// =============================================================================
Expand Down
6 changes: 4 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ Changelog

### Enhancements

* Add (experimental) `configuration.attemptDeliveryOnCrash` to allow uncaught
Objective-C exceptions to be sent at crash time, prior to app termination.
* Add `configuration.attemptDeliveryOnCrash` to allow uncaught Objective-C
exceptions to be sent at crash time, prior to app termination. Use of this
feature may impair user experience and other crash reporters; please read
https://docs.bugsnag.com/platforms/ios/configuration-options/#attemptdeliveryoncrash
[#1488](https://github.com/bugsnag/bugsnag-cocoa/pull/1488)

### Bug fixes
Expand Down