Skip to main content

Migrating from 6.x to 7.x

note

This guide targets the 7.x release line. If you are setting up a brand-new project, start from the installation guide instead. For 6.x installs, see the 6.x installation guide.

This guide walks through every public-API change between Bugsee iOS SDK 6.x and 7.x.

TL;DR

7.x keeps the shape of the 6.x API, but much of it moved. Many 6.x methods still exist under a new name, the option keys were renamed and several defaults changed, feedback left the core framework for its own package, CocoaPods and Carthage are gone, and the minimum deployment target is now iOS 15. You will need code changes; a drop-in version bump is not possible.


1. Requirements and dependency​

1.1 Deployment target​

The minimum deployment target moves from iOS 12 to iOS 15. Raise it in your target's build settings before upgrading.

7.x also ships tvOS and visionOS slices:

Platform6.x7.x
iOS12.015.0
tvOS(not shipped)15.0
visionOS(not shipped)1.0

Simulator slices are built without the native crash reporter, exactly as in 6.x — run on a real device to exercise crash capture.

1.2 Dependency​

7.x is distributed through Swift Package Manager and as a direct-download XCFramework.

6.x7.x
Swift Package Manager, https://github.com/bugsee/spmSame repository. Move the dependency rule to Up to Next Major Version from 7.0.0
CocoaPods (pod 'Bugsee')(not supported) — switch to Swift Package Manager
Carthage (Bugsee.json)(not supported) — switch to Swift Package Manager or the direct download
Manual Bugsee.xcframework from download.bugsee.com/sdk/ios/dynamic/Direct download: https://download.bugsee.com/sdk/ios/spm/Bugsee-<version>.zip, which also holds the Tools/ scripts

The direct-download archive holds Bugsee.xcframework and a Tools/ folder with the BugseeAgent and BugseeClean scripts. Keep Tools/ inside the folder that contains your .xcodeproj, where the dSYM upload script looks for BugseeAgent. With Swift Package Manager the script stays where it was in 6.x, in the package checkout.

If you used the BugseeSwiftUI library product, keep it: it now requires iOS 15 as well. See the installation guide for details.


2. Option keys​

Every option now has a BugseeOption* constant, grouped by area, and its value is a com.bugsee.option.* string shared with the other Bugsee SDKs. The tables below map each 6.x key to its 7.x name.

The 6.x constants are kept for source compatibility. They now hold the new key strings, so a 6.x options dictionary keyed by BugseeShakeToReportKey, BugseeVideoEnabledKey and so on still builds and still works. The 6.x strings typed out by hand (@"ShakeToReport", @"VideoEnabled") are translated as well. Three 6.x keys are removed and no longer compile: BugseeKillDetectionKey, BugseeEnableMachExceptionsKey and BugseeCaptureVideoAdaptiveKey (see below).

Use the BugseeOption* names in new code: the options added in 7.x exist only under them, and they are the names this documentation uses. Moving to them is a search and replace with the tables below.

caution

Some options kept their key but changed their default. Those changes are silent. See §3.

2.1 Detection​

6.x7.x
BugseeCrashReportKeyBugseeOptionDetectAndReportCrash
BugseeAppLaunchCrashDetectionKeyBugseeOptionDetectAndReportEarlyCrash
BugseeDetectAppExitKeyBugseeOptionDetectAndReportExit
BugseeKillDetectionKey(removed)
(not available)BugseeOptionDetectAndReportAnomaly
(not available)BugseeOptionDetectAndReportHang
(not available)BugseeOptionDetectAndReportHangFairLevel
(not available)BugseeOptionDetectAndReportHangMediumLevel
(not available)BugseeOptionDetectAndReportHangSevereLevel
(not available)BugseeOptionDetectAndReportHttpErrors
(not available)BugseeOptionDetectAndReportMainThreadMisuse
(not available)BugseeOptionDetectCrashFillEmptyExceptionStacks
(not available)BugseeOptionDetectCrashSwiftAsyncStackTraces
(not available)BugseeOptionDetectFrustration

BugseeKillDetectionKey and the BugseeOptions.killDetection property are removed. Out-of-memory kills are reported through BugseeOptionDetectAndReportExit, which is on by default (see §3 and Exits). On iOS 27 and later, the Crash Report Extension adds the stack of every thread to these reports.

2.2 Capture​

6.x7.x
BugseeCaptureAVPlayerKeyBugseeOptionCaptureAVPlayer
BugseeMonitorBluetoothStatusKeyBugseeOptionCaptureBluetoothStatus
BugseeEnableMachExceptionsKey (removed)BugseeOptionCaptureCrashHandlerType (see below)
BugseeMonitorDiskSpaceKeyBugseeOptionCaptureDiskSpace
BugseeCaptureLogsKeyBugseeOptionCaptureLogs
BugseeMonitorNetworkKeyBugseeOptionCaptureNetwork
BugseeMaxNetworkBodySizeKeyBugseeOptionCaptureNetworkBodySizeLimit
BugseeSanitizeNetworkDataKeyBugseeOptionCaptureNetworkUseDefaultSanitizer
BugseeCaptureOSLogsKeyBugseeOptionCaptureOSLogs
BugseeEnableOnDeviceSymbolicationKeyBugseeOptionCaptureOnDeviceSymbolication
BugseeScreenshotEnabledKeyBugseeOptionCaptureScreenshot
BugseeStatusBarInfoKeyBugseeOptionCaptureStatusBarInfo
BugseeVideoEnabledKeyBugseeOptionCaptureVideo
BugseeCaptureVideoAdaptiveKey (removed)BugseeOptionCaptureVideoAdaptive
BugseeFrameRateKeyBugseeOptionCaptureVideoFrameRate
BugseeMaxFrameRateKeyBugseeOptionCaptureVideoMaxFramerate
BugseeMinFrameRateKeyBugseeOptionCaptureVideoMinFramerate
BugseeVideoScaleKeyBugseeOptionCaptureVideoScale
BugseeViewHierarchyEnabledKeyBugseeOptionCaptureViewHierarchy
BugseeMonitorWebSocketKeyBugseeOptionCaptureWebSocket
(not available)BugseeOptionCaptureBreadcrumbs
(not available)BugseeOptionCaptureBreadcrumbsExtras
(not available)BugseeOptionCaptureCameraPreview
(not available)BugseeOptionCaptureCrashSignals (see below)
BugseeCaptureDeviceAndNetworkNamesBugseeOptionCaptureDeviceAndNetworkNames
(not available)BugseeOptionCaptureLogsLevel
(not available)BugseeOptionCaptureNetworkBodyWithoutType
(not available)BugseeOptionCaptureNetworkOnLaunch
(not available)BugseeOptionCaptureSampleBufferDisplayLayer
(not available)BugseeOptionCaptureScreenshotScale
(not available)BugseeOptionCaptureVideoPrivacyBlur
(not available)BugseeOptionCaptureVideoQuality
(not available)BugseeOptionCaptureWebViewAdvanced
(not available)BugseeOptionCaptureWebViewReportTrigger

BugseeEnableMachExceptionsKey and the BugseeOptions.enableMachExceptions property are removed. The crash handler is chosen with BugseeOptionCaptureCrashHandlerType (BugseeOptions.crashHandlerType), which takes a BugseeCrashHandlerType:

6.x7.xWhat Bugsee installs
BugseeEnableMachExceptionsKey: NO (6.x default)BugseeCrashHandlerTypeBSD (.bsd)BSD signal handlers
BugseeEnableMachExceptionsKey: YESBugseeCrashHandlerTypeMach (.mach)A Mach exception handler, plus a BSD signal handler for SIGABRT. Other signals raised by software (raise(), kill()) are not reported
(not available)BugseeCrashHandlerTypeMachAndBSD (.machAndBSD, 7.x default)Both, so hardware faults and signals raised by software are reported

tvOS always uses BSD signal handlers, whatever the value.

The removed key is ignored if it is still passed, including as a plain string (@"BugseeEnableMachExceptions", @"enableMachExceptions", @"com.bugsee.option.capture.mach-exceptions"). Bugsee logs a warning to the console the first time it sees one.

BugseeOptionCaptureCrashSignals (BugseeOptions.crashSignals) is new. It chooses which fatal signals Bugsee intercepts on iOS, tvOS and visionOS. Combine BugseeCrashSignals values:

7.xSwiftSignal
BugseeCrashSignalABRT.abrtSIGABRT: abort(), failed assertions, uncaught exceptions
BugseeCrashSignalSEGV.segvSIGSEGV: invalid memory access
BugseeCrashSignalBUS.busSIGBUS: misaligned or otherwise invalid memory access
BugseeCrashSignalILL.illSIGILL: illegal instruction
BugseeCrashSignalFPE.fpeSIGFPE: arithmetic exception
BugseeCrashSignalTRAP.trapSIGTRAP: breakpoint or trap instruction, including Swift runtime traps
BugseeCrashSignalsAll.allEvery signal above
BugseeCrashSignalsDefault.defaultBugsee chooses (default)

With the default, Bugsee intercepts every signal, except that the Xamarin and .NET SDKs leave out SIGSEGV and SIGBUS: the .NET runtime turns them into NullReferenceException. Any other value is used as given, so list every signal you want. BugseeCrashSignalsDefault works only on its own, not combined with other values.

BugseeOptions *options = [BugseeOptions defaultOptions];
options.crashSignals = BugseeCrashSignalABRT | BugseeCrashSignalILL | BugseeCrashSignalTRAP;

[Bugsee launchWithToken:@"<your_app_token>" options:options];
  • A bad memory access arrives as either SIGSEGV or SIGBUS, depending on the fault. With BugseeCrashHandlerTypeMach or BugseeCrashHandlerTypeMachAndBSD, it is intercepted if either of the two is selected. With BugseeCrashHandlerTypeBSD, and always on tvOS, only the selected signal is intercepted, so select both to catch every bad memory access. Leave both out to ignore bad memory accesses.
  • Leaving out SIGABRT also stops uncaught Objective-C exceptions from being reported, because they end in abort().
  • With BugseeCrashHandlerTypeMach, SIGABRT is the only signal raised by software that Bugsee reports. The other selected signals are reported only as hardware faults.
  • With no signals selected (BugseeCrashSignalsNone), Bugsee reports no crashes and no uncaught exceptions, and logs a warning to the console.

2.3 Reporting​

6.x7.x
BugseeDefaultBugPriorityKeyBugseeOptionReportingDefaultBugPriority
BugseeDefaultCrashPriorityKeyBugseeOptionReportingDefaultCrashPriority
BugseeDefaultErrorPriorityKeyBugseeOptionReportingDefaultErrorPriority
BugseeScreenshotToReportKeyBugseeOptionReportingTriggerByScreenshot
BugseeShakeToReportKeyBugseeOptionReportingTriggerByShake
BugseeReportDescriptionRequiredKeyBugseeOptionReportingUIDescriptionRequired
BugseeReportEmailRequiredKeyBugseeOptionReportingUIEmailRequired
BugseeReportLabelsEnabledKeyBugseeOptionReportingUILabelsEnabled
BugseeReportLabelsRequiredKeyBugseeOptionReportingUILabelsRequired
BugseeReportPrioritySelectorKeyBugseeOptionReportingUIPrioritySelectorEnabled
BugseeStyleKeyBugseeOptionReportingUIStyle
BugseeReportSummaryRequiredKeyBugseeOptionReportingUISummaryRequired

2.4 Configuration​

6.x7.x
BugseeBuildTargetKeyBugseeOptionConfigBuildTarget
BugseeBuildTypeKeyBugseeOptionConfigBuildType
BugseeMaxRecordingTimeKeyBugseeOptionConfigDuration
BugseeMaxDataSizeKeyBugseeOptionConfigMaxDataSize (new default, see §3)
BugseeWifiOnlyUploadKeyBugseeOptionConfigWifiOnlyUpload
(not available)BugseeOptionConfigMaxPendingReports
(not available)BugseeOptionConfigMaxPendingReportAge
(not available)BugseeOptionConfigNotifyFlushDelay

BugseeOptionConfigMaxDataSize (maxDataSize), BugseeOptionConfigMaxPendingReports (maxPendingReports, default 30) and BugseeOptionConfigMaxPendingReportAge (maxPendingReportAge, default 30 days) cap the reports waiting to be sent. Past the size or count cap the oldest reports are deleted whole: errors first, then bug reports, then crashes, and the newest crash is kept. The age cap deletes every report older than the limit, crashes included.

2.5 Performance​

6.x7.x
BugseePerformanceAdaptiveSamplingKeyBugseeOptionPerformanceAdaptiveSampling
BugseePerformanceMonitoringKeyBugseeOptionPerformanceMonitoring
BugseePerformanceSampleRateKeyBugseeOptionPerformanceSampleRate

2.6 Options that have no BugseeOptions property​

Most of the settings 7.x adds exist only as keys: the detection options other than crash, exit and early crash, breadcrumbs, the video quality and privacy options, and others. The configuration reference says which options have a property. Reach the others through the dictionary launch overload, or fold them into a BugseeOptions object with updateLaunchOptions::

BugseeOptions *options = [BugseeOptions defaultOptions];
options.videoEnabled = YES;

[options updateLaunchOptions:@{
BugseeOptionDetectAndReportHang : @YES,
BugseeOptionCaptureBreadcrumbs : @YES,
}];

[Bugsee launchWithToken:@"<your_app_token>" options:options];

3. Defaults that changed​

Seven defaults that a 6.x app is running today changed. Most were realigned with the Android SDK, so the same option means the same thing on both platforms. The crash handler type is iOS's own, and the data size limit came with the new pending-report caps.

Option6.x7.x
BugseeOptionReportingTriggerByShakeNOYES
BugseeOptionReportingTriggerByScreenshotYESNO
BugseeOptionDetectAndReportExitNOYES
BugseeOptionDetectAndReportEarlyCrashNOYES
BugseeOptionCaptureVideoAdaptiveNOYES
BugseeOptionCaptureCrashHandlerTypeBSDMachAndBSD (iOS and visionOS)
BugseeOptionConfigMaxDataSize50 MB150 MB
Nothing tells you this happened

These are behavioral changes, not compile-time ones. Nothing fails to build and nothing warns at runtime. An app that never set these options gets the new behavior the moment it upgrades.

The consequence to plan for: taking a screenshot no longer opens the report dialog, and shaking the device now does. If your users were taught the screenshot gesture, set both keys explicitly.

With BugseeCrashHandlerTypeMachAndBSD, Bugsee installs a Mach exception handler and BSD signal handlers, so it also reports signals raised by software (raise(), kill()). tvOS always uses BSD signal handlers. See §2.2 for the three handler types.

To keep 6.x behavior, pin all seven:

NSDictionary *options = @{
BugseeOptionReportingTriggerByShake: @NO,
BugseeOptionReportingTriggerByScreenshot: @YES,
BugseeOptionDetectAndReportExit: @NO,
BugseeOptionDetectAndReportEarlyCrash: @NO,
BugseeOptionCaptureVideoAdaptive: @NO,
BugseeOptionCaptureCrashHandlerType: @(BugseeCrashHandlerTypeBSD),
BugseeOptionConfigMaxDataSize: @50,
};

[Bugsee launchWithToken:@"<your_app_token>" andOptions:options];

BugseeOptionCaptureVideoAdaptive is a deliberate difference from Android, not an oversight: iOS ships adaptive capture as opt-out because it was validated on device here, while Android keeps it opt-in.

BugseeOptionConfigMaxDataSize now caps the reports waiting to be sent, alongside the two new caps on their number and age (see §2.4).

Two of these options also report something different:

  • BugseeOptionDetectAndReportExit reports out-of-memory terminations: in the foreground as a crash, in the background as an error. A run that ended any other way, such as the user swiping the app away, is not reported. In 6.x, BugseeDetectAppExitKey reported those swipes. See Exits.
  • BugseeOptionDetectAndReportEarlyCrash acts when the previous launch ended before the app became active — a crash, but also a force-quit or a kill at that point — instead of the 6.x five-second window. See Crashes.

4. Launching and lifecycle​

4.1 Dictionary launch has a new Swift label​

In 6.x both launch overloads carried the Swift name launch(token:options:) and Swift picked one by argument type. In 7.x the dictionary overload is spelled out:

6.x (Swift)7.x (Swift)
Bugsee.launch(token:options:) (dictionary)Bugsee.launch(token:dictionaryOptions:)
Bugsee.launch(token:options:) (BugseeOptions)Bugsee.launch(token:options:)
Bugsee.relaunch(options:) (dictionary)Bugsee.relaunch(dictionaryOptions:)
Bugsee.relaunch(options:) (BugseeOptions)Bugsee.relaunch(options:)

Objective-C selectors are unchanged: launchWithToken:andOptions: and launchWithToken:options:.

4.2 pause and resume are gone​

+[Bugsee pause] and +[Bugsee resume] are removed.

Blackout is not a drop-in replacement

6.x pause suspended video and the loggers. 7.x blackout suppresses only what describes the screen — logs, network events and traces keep being captured. If you relied on pause to stop all capture, use +[Bugsee stop:] and launch again afterwards.

4.3 New: observing SDK status​

Bugsee finishes starting up in the background, so launchWithToken: returns before recording is live. Called from application:didFinishLaunchingWithOptions:, while the app is not active yet, the launch waits for the app to become active; the crash handler is installed right away. 7.x lets you see when recording starts.

// BugseeStatusStopped / Launching / Launched / Stopping
if ([Bugsee sharedInstance].status == BugseeStatusLaunched) { /* ... */ }

// Or observe every transition, on the main thread:
- (void)bugseeDidChangeStatus:(BugseeStatus)status {
NSLog(@"Bugsee status: %ld", (long)status);
}

The existing launched property still works, but it is NO during the Launching window. Prefer status, or bugsee(didChangeStatus:), for launch sequencing. The started: completion block of launchWithToken:options:started: says whether the launch was accepted, not that recording has started: a launch that waits for the app to become active reports YES at once.

4.4 New: relaunch with no arguments​

+[Bugsee relaunch] restarts with the current app token and default options.

Every relaunch form now follows the SDK lifecycle. A relaunch is refused, and its started: block receives NO at once on the calling thread, when the SDK is not launched or is launching or stopping. A second relaunch while one is in progress joins it, and a stop: during a relaunch cancels it.

4.5 Deleting collected data​

The 6.x call keeps its Objective-C selector. In Swift it is renamed from deleteCollectedData(completion:) to deleteCollectedDataOnDevice(completion:). It deletes everything Bugsee has collected on the device: the recording, reports not uploaded yet (their uploads are cancelled), crashes not reported yet and the performance baselines learned by anomaly detection.

7.x adds two forms that delete less. They always delete the recording, and keep the crashes not reported yet and the anomaly baselines:

  • deleteCollectedDataOnDevice:completion: keeps the reports waiting for upload. Pass YES to also delete the data already set aside for reports that are not assembled yet.
  • deleteCollectedDataOnDevice:includingBundles:completion: can also delete the reports waiting for upload. A report being uploaded or assembled at that moment cannot be stopped: it is kept, and the completion receives NO.
// 6.x and 7.x — deletes everything
[Bugsee deleteCollectedDataOnDevice:^(BOOL success) { /* ... */ }];

// 7.x only — keeps the reports waiting for upload
[Bugsee deleteCollectedDataOnDevice:YES completion:^(BOOL success) { /* ... */ }];

// 7.x only — deletes the reports waiting for upload too, keeps pending crashes
[Bugsee deleteCollectedDataOnDevice:YES includingBundles:YES completion:^(BOOL success) { /* ... */ }];

For every form:

  • Stop recording with +[Bugsee stop:] first, as in 6.x. Otherwise nothing is deleted and the completion receives NO.
  • The completion is called on the main thread once the deletion has finished, with YES if the data was deleted.
  • A launch called before the deletion has finished starts after it, unless you call stop before it starts.
  • The user identifier and the attributes are kept: none of the forms is a reset.

See Cleanup for the details.

4.6 BugseeDelegate methods have new Swift names​

Every BugseeDelegate method now declares its Swift name. The Objective-C selectors are unchanged; the Swift names Xcode derived from them in 6.x are not.

An old name is not an error

The delegate methods are optional, so not every 6.x name fails to build. The network and log filters, the lifecycle event and the synchronous pre-fill method stop the build with a "has been renamed" error. The attachment methods only raise a "nearly matches" warning. The completion and async forms of the pre-fill and finalize methods, and the removed bugsee(_:didReceiveNewFeedback:), compile without a word and are never called. Rename every implementation, and read the warnings.

6.x (Swift)7.x (Swift)
bugseeFilterNetworkEvent(_:completionHandler:)bugsee(filterNetworkEvent:completionHandler:)
bugseeFilterLog(_:completionHandler:)bugsee(filterLog:completionHandler:)
bugseeAttachments(for:)bugsee(attachmentsFor:)
bugseeAttachments(for:completionHandler:)bugsee(attachmentsFor:completionHandler:)
bugseeLifecycleEvent(_:)bugsee(lifecycleEvent:)
bugseeAddFieldsBeforeReportCreated()bugseePrepareReportFields()
bugseeAddFieldsBeforeReportCreated(_:)bugseePrepareReportFields(completion:)
bugseeAddFieldsBeforeReportCreatedWith() asyncbugseePrepareReportFields() async
bugseeCheckFields(afterReportCreated:)bugsee(finalizeReportFields:)
bugseeCheckFields(afterReportCreated:completionHandler:)bugsee(finalizeReportFields:completionHandler:)
(not available)bugsee(didChangeStatus:)

4.7 Other signature changes​

These still exist but changed shape; each shows up as a build error where it matters.

6.x7.x
+getLaunchOptions returns a nullable NSDictionaryReturns a non-null NSDictionary<NSString *, id>, the options in effect merged over the defaults. New: +getHostLaunchOptions, only the options the app passed
+setEmail: and +clearEmail return BOOL+setUserIdentifier: and +clearUserIdentifier return nothing
BugseeNetworkEvent.method is non-nullNullable
BugseeLogEvent.timestamp is writableRead-only
BugseeOptions.maxNetworkBodySize below 20480 is raised to 20480Used as given; 0 captures no bodies

BugseeDataEncryptionMode, BugseeAdditionalDataCaptureBlock and BugseeLogger.reactNativeLogger are no longer public.

4.8 Lifecycle events​

BugseeLifecycleEventStarted, BugseeLifecycleEventResumed and BugseeLifecycleEventPaused are removed: 7.x has no pause and resume, and nothing dispatched them. Three events are new:

7.xDispatched when
BugseeLifecycleEventBlackoutStartedA blackout begins (startBlackout)
BugseeLifecycleEventBlackoutEndedA blackout ends (endBlackout, or stop:)
BugseeLifecycleEventReportAssemblyFailedAssembling a report ran out of attempts in this process

BugseeLifecycleEventBeforeFeedbackShown and BugseeLifecycleEventAfterFeedbackShown remain declared but are not dispatched: the feedback UI moved to its own package.

BugseeLifecycleEventRelaunchedAfterCrash is dispatched only for a crash left by the crash handler, at most once per process. Exit reports (out of memory, and the watchdog and memory-limit reports of the Crash Report Extension) do not dispatch it.

Removing three values renumbered the ones after them. Code that switches on the names is fine. Code that stores or forwards the raw numbers (a bridge to another runtime, for example) must be rebuilt against the 7.x header. See Lifecycle & status for the full list.


5. Feedback moved to its own package​

Feedback is no longer part of the core framework. Every 6.x feedback symbol is removed, and the feature ships as a separate Swift package, BugseeFeedback, layered on top of the core SDK.

Package coordinates

Add https://github.com/bugsee/feedback-spm with the Exact Version rule, at the same version as the core SDK. Each BugseeFeedback release requires that core version exactly.

5.1 API mapping​

6.x7.x
+[Bugsee showFeedbackController][BugseeFeedback.shared showFeedbackUI]
+[Bugsee setDefaultFeedbackGreeting:][BugseeFeedback.shared setGreeting:]
-[BugseeDelegate bugsee:didReceiveNewFeedback:]-[BugseeFeedbackListener onNewMessagesReceived:] — called only while the chat is on screen
(not available)-[BugseeFeedbackListener onNewMessageSent:]
(not available)[BugseeFeedback.shared setListener:]

5.2 Register the extension​

The package registers itself with the SDK when the app loads. You can also register it explicitly; do it before Bugsee.launch.

@import BugseeFeedback;

[BugseeFeedback register];
[Bugsee launchWithToken:@"<your_app_token>"];

5.3 Rewrite the call sites​

Call the feature through BugseeFeedback.shared.

// 6.x
[Bugsee showFeedbackController];
[Bugsee setDefaultFeedbackGreeting:@"How can we help?"];

// 7.x
[BugseeFeedback.shared showFeedbackUI];
[BugseeFeedback.shared setGreeting:@"How can we help?"];

5.4 New-message callbacks​

The bugsee:didReceiveNewFeedback: delegate method is replaced by a dedicated listener on the extension. The chat checks for new messages only while it is on screen, so the listener hears about them only then; it cannot drive a badge for replies that arrive while the chat is closed.

// 7.x — your type conforms to BugseeFeedbackListener
[BugseeFeedback.shared setListener:self];

5.5 The extension registry​

Bugsee.ext(_:) returns a registered module by its type, for example Bugsee.ext(BugseeFeedback.self). It is the general mechanism for optional 7.x modules, not a feedback-specific hook; feedback is the first module to use it. Registering a module is the module's job (BugseeFeedback.register()): registerExt(_:) is part of the Bugsee.SPI submodule for Bugsee's own add-ons and wrappers, and import Bugsee does not include it.


6. Event filters​

6.1 removeNetworkEventFilter is gone​

All three filter setters now accept nil to remove the filter.

// 6.x
[Bugsee removeNetworkEventFilter];

// 7.x
[Bugsee setNetworkEventFilter:nil];

6.2 New: a block-based log filter​

6.x could only filter console logs through the bugseeFilterLog:completionHandler: delegate method. 7.x adds setLogEventFilter:. When both are set, only the block runs: it takes precedence over the delegate method. The same holds for setNetworkEventFilter: and bugseeFilterNetworkEvent:completionHandler:.

[Bugsee setLogEventFilter:^(BugseeLogEvent *event, BugseeLogFilterDecisionBlock decision) {
if ([event.text containsString:@"password"]) {
decision(nil); // drop it
return;
}
decision(event);
}];

6.3 New: a breadcrumb filter​

Breadcrumbs are new in 7.x, and setBreadcrumbFilter: is the only filter they pass through. See §9.3.

6.4 Filters must answer within 10 seconds​

Every filter — the network and log filters, block or delegate, and the breadcrumb filter — must call its decision block once, within 10 seconds. Past that the event is dropped, and a later call is ignored. In 6.x a filter that never answered held its event forever.

6.5 New: keeping the built-in network redaction in a filter​

As in 6.x, installing a network filter (block or delegate) turns off the built-in redaction of sensitive query parameters, headers and JSON body values (BugseeOptionCaptureNetworkUseDefaultSanitizer, formerly BugseeSanitizeNetworkDataKey). 7.x lets a filter keep it: call Bugsee.defaultNetworkSanitizer first.

[Bugsee setNetworkEventFilter:^(BugseeNetworkEvent *event, BugseeNetworkFilterDecisionBlock decision) {
[Bugsee.defaultNetworkSanitizer sanitize:event];
// ...your own redaction...
decision(event);
}];

7. Manual reports​

7.1 showReportController is now showReportDialog​

6.x7.x
showReportControllershowReportDialog
showReportControllerWithSummary:description:severity:showReportDialogWithSummary:description:severity:
showReportControllerWithSummary:description:severity:labels:showReportDialogWithSummary:description:severity:labels:
(not available)showReportDialogWithSummary:description:

7.2 includeVideo: overloads and logError:labels: are gone​

uploadWithSummary:…:includeVideo: loses its last parameter. Drop the argument; the shorter overload already exists in 6.x. logError:labels:includeVideo: and logError:labels: are gone too: call logError:, and add labels in bugseeAttachmentsForReport: (see §7.5 for how far such a label reaches).

// 6.x
[Bugsee uploadWithSummary:@"s" description:@"d" severity:BugseeSeverityHigh
labels:nil includeVideo:YES];

// 7.x
[Bugsee uploadWithSummary:@"s" description:@"d" severity:BugseeSeverityHigh labels:nil];

// 6.x
[Bugsee logError:error labels:@[@"checkout"]];

// 7.x: labels in bugseeAttachmentsForReport:, see §7.5
[Bugsee logError:error];

7.x also adds a two-argument uploadWithSummary:description:.

7.3 uploadReport: is upload(_:) in Swift​

The Objective-C selector uploadReport: is unchanged; only its Swift name moves from Bugsee.uploadReport(_:) to Bugsee.upload(_:). A completion: overload is new.

7.4 The report the delegate receives is live​

In 6.x, the BugseeReport passed to bugseeAttachmentsForReport: carried three properties: type, severity and labels. In 7.x it is a handle on the report about to be uploaded, and whatever you change on it is what gets uploaded.

  • type is read-only. The trigger decides it: BugseeReportTypeBug, BugseeReportTypeCrash or BugseeReportTypeError.
  • labels is no longer nullable. Assign an empty array to clear them, or call clearLabels.
  • There is no public initializer. Bugsee creates the object; do not keep it past the delegate call.
  • severity accepts only BugseeSeverityLow…BugseeSeverityBlocker (1–5). Any other value is ignored and logged, and the current severity is kept. The same rule applies to the severity in the BugseeReportFields your delegate returns, and to the BugseeOptionReportingDefault*Priority options: an out-of-range default leaves the report's severity unset.

New on the report: reportId, summary, reportDescription, email, its attributes (getAttribute:, setAttribute:withValue:, removeAttribute:, clearAllAttributes), addLabel: / addLabels: / clearLabels, and addAttachment: / clearAttachments. Attachments added on the report during the delegate call share the delegate's budget of three attachments of at most 3 MB each.

- (NSArray<BugseeAttachment *> *)bugseeAttachmentsForReport:(BugseeReport *)report {
[report addLabel:@"beta"];
[report setAttribute:@"plan" withValue:@"pro"];
return @[];
}

7.5 BugseeExceptionLoggingOptions is gone​

logException takes the exception domain and the number of frames to skip as parameters, as on Android 7.x. BugseeExceptionLoggingOptions, BugseeMergingRulesSkipFramesKey and both options: overloads are removed.

6.x7.x
logException:options:completion: with nil optionslogException:completion:
logException:reason:options:completion: with nil optionslogException:reason:completion:
logException:options:completion: with optionslogException:domain:skipFrames:completion:
logException:reason:options:completion: with optionslogException:reason:domain:skipFrames:completion:
exceptionDomaindomain:
mergingRules[BugseeMergingRulesSkipFramesKey]skipFrames:
labelsaddLabels: on the report in bugseeAttachmentsForReport: — see §7.4
includeVideo— leaving the video out of a single report is not supported

A 6.x call that passed an options object without setting includeVideo to YES filed its report without video. In 7.x the same call files it with video.

domain is recorded with the report. skipFrames is how many top frames of the stack recorded for the report are left out of its signature, which groups reports into issues; a negative value counts as 0.

// 6.x
BugseeExceptionLoggingOptions *options = [BugseeExceptionLoggingOptions new];
options.exceptionDomain = @"Payments";
options.labels = @[@"checkout"];
options.mergingRules = @{BugseeMergingRulesSkipFramesKey : @1};
[Bugsee logException:exception options:options completion:nil];

// 7.x
[Bugsee logException:exception domain:@"Payments" skipFrames:1 completion:nil];

// 7.x labels, in your BugseeDelegate
- (NSArray<BugseeAttachment *> *)bugseeAttachmentsForReport:(BugseeReport *)report {
if ([report.type isEqualToString:BugseeReportTypeError]) {
[report addLabels:@[@"checkout"]];
}
return @[];
}

The delegate is asked about every report. type tells an error report from a bug or crash report, but not a logException report from a logError report or from an error report Bugsee files on its own, so a label added this way goes on all of them.

On simulators and Mac Catalyst logError: and logException file nothing; the completion of logException is still called.

7.6 exportVideoToPath:withCompletion: writes no file​

In 7.0, -[BugseeExtendedReport exportVideoToPath:withCompletion:] (Swift exportVideo(path:completion:)) calls its completion without writing a video file. The video is still part of the report you upload with uploadReport:. Code that read the exported file must check that the file exists, which the 6.x documentation already advised.

7.7 New: a report handler​

+[Bugsee setReportHandler:] takes an object conforming to BugseeReportHandler. Its two optional callbacks, onBeforeReportCreated and onAfterReportCreated, receive every report — bug, error and crash, including a crash recovered at the next launch — as the same live BugseeReport, and must call their completion. Set the handler before launchWithToken: so it also sees the recovered reports. The BugseeDelegate callbacks keep working alongside it.

@interface MyReportHandler : NSObject <BugseeReportHandler>
@end

@implementation MyReportHandler
- (void)onBeforeReportCreated:(BugseeReport *)report
isTerminating:(BOOL)isTerminating
completion:(BugseeEmptyBlock)completion {
report.labels = @[@"beta"];
completion();
}
@end

// Before launch:
[Bugsee setReportHandler:[MyReportHandler new]];
[Bugsee launchWithToken:@"<your_app_token>"];

See Report handler for the timing rules.


8. Privacy and secure areas​

8.1 Blackout​

New in 7.x. Blackout suppresses every capture that describes the screen — video (a black placeholder frame), the report screenshot, touch and gesture recording, the keyboard and focus breadcrumbs, and the view hierarchy. Logs, network events and traces keep flowing.

[Bugsee startBlackout];
// ... sensitive flow ...
[Bugsee endBlackout];

BOOL hidden = [Bugsee isBlackout];

Two lifecycle events report the transitions: BugseeLifecycleEventBlackoutStarted and BugseeLifecycleEventBlackoutEnded.

A blackout lasts until endBlackout or stop:, and the next launch starts without one. A relaunch keeps it, and a blackout started before launch applies to that launch.

8.2 Secure views​

setView:asHidden: is split into two explicit methods.

// 6.x
[Bugsee setView:myView asHidden:YES];
[Bugsee setView:myView asHidden:NO];

// 7.x
[Bugsee addSecureView:myView];
[Bugsee removeSecureView:myView];

isViewHidden: is removed with no replacement. The UIView.bugseeProtectedView property and addSecureWebView: are unchanged.

8.3 Secure rectangles renamed​

Rect becomes Rectangle throughout. The coordinates are unchanged: points, in the screen's coordinate space. Two things behave differently:

  • Touches inside a rectangle are now dropped from the report, as they already were for secure views.
  • With several of the app's windows on the screen (iPad Split View or Stage Manager, iPhone Duo side by side), every window is recorded. A rectangle measured in a window that does not start at the screen's top-left corner must be converted to screen coordinates before you add it.
6.x7.x
addSecureRect:addSecureRectangle:
removeSecureRect:removeSecureRectangle:
removeAllSecureRectsremoveAllSecureRectangles
getAllSecureRectsgetAllSecureRectangles
setInternalSecureRectangles:(removed)

9. New capabilities​

9.1 User identity replaces email​

setEmail: recorded an email address. 7.x records an arbitrary user identifier instead — same storage, wider meaning.

// 6.x
[Bugsee setEmail:@"user@example.com"];
NSString *email = [Bugsee getEmail];
[Bugsee clearEmail];

// 7.x
[Bugsee setUserIdentifier:@"user@example.com"];
NSString *identifier = [Bugsee getUserIdentifier];
[Bugsee clearUserIdentifier];

9.2 Reading all attributes​

7.x adds getAllAttributes, which returns every attribute currently set.

NSDictionary<NSString *, id> *all = [Bugsee getAllAttributes];

9.3 Breadcrumbs​

New in 7.x. The SDK collects breadcrumbs automatically once BugseeOptionCaptureBreadcrumbs is enabled, and you can add your own — they need the option too: with it off, addBreadcrumb: records nothing. Build the breadcrumb through the SDK's factory, then record it.

id<BGSBreadcrumb> crumb = [[Bugsee getExchangeFactory] createBreadcrumb];
crumb.category = @"checkout";
crumb.message = @"Coupon applied";
crumb.type = @"user";
[crumb setDataValue:@"SUMMER25" forKey:@"code"];

[Bugsee addBreadcrumb:crumb];

addBreadcrumb:requiresFiltering: with NO records a breadcrumb as is, for one your own code has already run through the app's breadcrumb filter.

Network filters do not reach breadcrumbs

setBreadcrumbFilter: is the only filter breadcrumbs pass through. A URL your setNetworkEventFilter: (or bugseeFilterNetworkEvent:) drops or rewrites still appears in the breadcrumb trail unless you repeat the rule in the breadcrumb filter. The built-in query-parameter sanitizer does apply to breadcrumb URLs; a custom filter does not.

[Bugsee setBreadcrumbFilter:^(id<BGSBreadcrumb> crumb,
BugseeBreadcrumbFilterDecisionBlock decision) {
if ([crumb.category isEqualToString:@"internal"]) {
decision(nil); // drop it
return;
}
decision(crumb);
}];

9.4 Notification relay​

notify already existed in 6.3: it sends a lightweight notification straight to the app's configured messaging integrations, bypassing the bug-report pipeline — no video, logs or events are attached. Notifications are persisted offline and uploaded in batches. New in 7.x are the urgent: overload and the BugseeOptionConfigNotifyFlushDelay option.

There is no option to enable or disable it; it is available once the SDK has launched, and calls made before launch are ignored. title must be non-empty.

[Bugsee notifyWithTitle:@"Checkout failed"];

[Bugsee notifyWithTitle:@"Checkout failed"
body:@"Payment provider returned 502"
severity:BugseeSeverityHigh
fields:@{@"orderId": @"A-1721"}
urgent:YES];

The shorter overloads are non-urgent. BugseeOptionConfigNotifyFlushDelay (also the notifyFlushDelay property) sets the upload coalescing delay in milliseconds. The default is 0 — the notification is written to disk and posted as soon as it lands there. A positive value delays the flush so that notify calls made close together batch into one upload. 6.x always waited one second. Same default as Android's com.bugsee.option.config.notify-flush-delay.

9.5 Crash Report Extension (iOS 27+)​

Some terminations end an app before any in-process crash handler can run: the launch watchdog and memory-limit kills. On iOS 27 and later, a Crash Reporter Extension target built on the BugseeCrashExtension library of the Bugsee package reports them with the stack of every thread. The app keeps its own deployment target, and nothing changes in the app's code. See Crash Report Extension.


10. Appearance​

+[Bugsee appearance] is renamed to +[Bugsee getAppearance]. The report screen properties behave as in 6.x. The feedback chat is now the BugseeFeedback package's own screen, and it reads only feedbackBackgroundColor and the four feedbackEmail* colors; the other feedback* properties are not applied. See Appearance.

reportCloseButtonColor and reportSendButtonColor are deprecated: the report screen uses the system Cancel and Done buttons.

// 6.x
[Bugsee appearance].reportBackgroundColor = UIColor.blackColor;

// 7.x
[Bugsee getAppearance].reportBackgroundColor = UIColor.blackColor;

11. Cheat sheet​

Renamed — a plain search and replace does most of these.

6.x7.x
Bugsee*Key option constantsBugseeOption* constants — see §2 (the 6.x names still compile)
Bugsee.appearance()Bugsee.getAppearance()
Bugsee.activeSpan()Bugsee.getActiveSpan()
registerEvent:event:
registerEvent:withParams:event:params: (params now optional)
traceKey:withValue:trace:value:
Swift Bugsee.trace(key:value:)Swift Bugsee.trace(_:value:)
registerNetworkEvent: (Swift register(_:))addNetworkEvent: (Swift addNetworkEvent(_:))
registerNetworkEvent:needsToBeFiltered: (Swift register(_:needsToBeFiltered:))addNetworkEvent:requiresFiltering:
Swift logUnhandledException(exception:comlletion:)Swift logUnhandledException(exception:completion:)
removeNetworkEventFiltersetNetworkEventFilter:nil
showReportController*showReportDialog*
setView:asHidden:addSecureView: / removeSecureView:
addSecureRect:addSecureRectangle:
removeSecureRect:removeSecureRectangle:
removeAllSecureRectsremoveAllSecureRectangles
getAllSecureRectsgetAllSecureRectangles
setEmail: / getEmail / clearEmailsetUserIdentifier: / getUserIdentifier / clearUserIdentifier
clearAllAttributeclearAllAttributes
testExceptionCrash / testSignalCrashtestCrash
uploadWithSummary:…:includeVideo:uploadWithSummary:description:severity:labels:
logError:labels:includeVideo: / logError:labels:logError:; labels through the delegate's report — see §7.2
logException:options:completion:logException:completion: / logException:domain:skipFrames:completion: — see §7.5
logException:reason:options:completion:logException:reason:completion: / logException:reason:domain:skipFrames:completion:
BugseeExceptionLoggingOptionsdomain: / skipFrames: parameters of logException; labels through the delegate's report
Swift Bugsee.launch(token:options:) (dictionary)Swift Bugsee.launch(token:dictionaryOptions:)
Swift Bugsee.relaunch(options:) (dictionary)Swift Bugsee.relaunch(dictionaryOptions:)
Swift Bugsee.uploadReport(_:)Swift Bugsee.upload(_:)
Swift Bugsee.deleteCollectedData(completion:)Swift Bugsee.deleteCollectedDataOnDevice(completion:) — see §4.5
Swift BugseeDelegate methodsNew Swift names — see §4.6
showFeedbackController[BugseeFeedback.shared showFeedbackUI]
setDefaultFeedbackGreeting:[BugseeFeedback.shared setGreeting:]
bugsee:didReceiveNewFeedback:BugseeFeedbackListener

Removed with no direct replacement.

6.xNotes
pause / resumeClosest is startBlackout / endBlackout, which is narrower — see §4.2
getDeviceId—
accessToken—
isViewHidden:—
hideKeyboard:—
setInternalSecureRectangles:—
logAssert:withLocation: / BUGSEE_ASSERTUse logException:reason:completion:
log:level:timestamp:log:level:requiresFiltering: takes the slot but does something different — it opts the message into the log filter
setDefaultCrashPriority:BugseeOptionReportingDefaultCrashPriority at launch
setDefaultErrorPriority:BugseeOptionReportingDefaultErrorPriority at launch
setDefaultBugPriority:BugseeOptionReportingDefaultBugPriority at launch
BugseeAttachmentOverrideLabels—
BugseeOptions.captureVideoAdaptive / BugseeCaptureVideoAdaptiveKeyBugseeOptionCaptureVideoAdaptive key
BugseeOptions.killDetection / BugseeKillDetectionKeyBugseeOptionDetectAndReportExit — see §2.1
BugseeOptions.enableMachExceptions / BugseeEnableMachExceptionsKeyBugseeOptionCaptureCrashHandlerType — see §2.2
BugseeLifecycleEventStarted / Resumed / Paused— see §4.8
CocoaPods and CarthageSwift Package Manager or the direct download — see §1.2

  1. Raise the deployment target to iOS 15 and switch the dependency to 7.x — through Swift Package Manager or the direct download if you were on CocoaPods or Carthage (§1).
  2. Check the defaults that changed (§3) and pin any your app relies on — nothing warns you about these, at build time or at runtime.
  3. Build, and work down the errors. The removed option keys, the renamed methods and the removed APIs in §4 to §10 all show up as build errors; the cheat sheet covers most of them. Two changes do not reliably: the delegate methods' new Swift names (§4.6), where some old names only warn and some compile silently — rename those by hand — and the lifecycle event numbers, if you forward them as raw values (§4.8).
  4. Rewire feedback through BugseeFeedback (§5) — the largest single change, and the only one that needs a new dependency.
  5. Look at your pause calls by hand. This is the one place where the obvious replacement is not quite right — blackout keeps recording logs and network traffic.
  6. Move to the BugseeOption* names (§2). The 6.x constants still work, so this can wait, but new options exist only under the new names.
  7. (Optional) Adopt the report handler, breadcrumbs, notify, the new detection options and, on iOS 27, the Crash Report Extension.

Build and run after each step.

Found an issue, typo, or wrong statement on this page? Report it now →