Introduction

The BugSplat macOS framework enables posting crash reports from Cocoa applications to BugSplat. This allows for your team to process macOS crash reports with BugSplat. Before integrating your application with BugSplat, make sure to review the Getting Started resources and complete the simple startup tasks listed below.

• ​Sign up for a BugSplat account

• ​Log in using your email address

• Create a new database for your application

Integration

BugSplatMac supports multiple methods for installing the library in a project.

Requirements

• BugSplatMac supports macOS 10.7 and later.

• BugSplatMac supports x86_64 and Apple Silicon applications

Installation with CocoaPods

CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like BugSplatMac in your projects. You can install it with the following command:

$ gem install cocoapods

Podfile

To integrate BugSplatMac into your Xcode project using CocoaPods, specify it in your Podfile:

target 'TargetName' do
pod 'BugsplatMac'
end

Then, run the following command:

$ pod install

The pod install command creates an xcworkspace file next to your application's xcodeproj file. Open the .xcworkspace file in lieu of the .xcodeproj file to ensure BugsplatMac.framework is included in your build.

Installation with Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate BugsplatMac into your Xcode project using Carthage, specify it in your Cartfile:

github "BugsplatGit/BugsplatMac"

Run carthage to build the framework and drag the built BugsplatMac.framework into your Xcode project.

Manual Setup

To use this library in your project manually you may:

1. Download the latest release which is provided as a zip file

2. Unzip the archive and add BugsplatMac.framework to your Xcode project

3. Drag & drop BugsplatMac.framework from your window in the Finder into your project in Xcode and move it to the desired location in the Project Navigator

4. A popup will appear. Select Create groups for any added folders and set the checkmark for your target. Then click Finish.

5. Configure the framework to be copied into your app bundle:

   • Click on your project in the Project Navigator (⌘+1).

   • Click your target in the project editor.

   • Click on the Build Phases tab.

   • Click the Add Build Phase button at the bottom and choose Add Copy Files.

   • Click the disclosure triangle next to the new build phase.

   • Choose Frameworks from the Destination list.

   • Drag BugsplatMac from the Project Navigator left sidebar to the list in the new Copy Files phase.

Usage

Configuration

BugSplatMac requires a few configuration steps in order to integrate the framework with your Bugsplat account.

Step 1

Add the following key to your app's Info.plist replacing DATABASE_NAME with your BugSplat database.

<key>BugsplatServerURL</key>
<string>https://DATABASE_NAME.bugsplat.com/</string>

Step 2

Create a ~/.bugsplat.conf file to store your Bugsplat credentials

BUGSPLAT_USER="<username>"
BUGSPLAT_PASS="<password>"

Add the upload-archive.sh script located in Bugsplat.framework/Versions/A/Resources as an Archive Post-action in your build scheme. The script will be invoked when archiving completes which will upload the .xcarchive to BugSplat for processing. You can view the script output in /tmp/bugsplat-upload.log. To share amongst your team, mark the scheme as Shared.

Initialization

@import BugsplatMac;

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
  [[BugsplatStartupManager sharedManager] start];                          
}

Crash Reporter UI Customization

Custom Banner Image

Bugsplat provides the ability to configure a custom image to be displayed in the crash reporter UI for branding purposes. The image view dimensions are 440x110 and will scale down proportionately. There are 2 ways developers can provide an image:

1. Set the image property directly on BugsplatStartupManager

2. Provide an image named bugsplat-logo in the main app bundle or asset catalog

User Details

Set askUserDetails to NO in order to prevent the name and email fields from displaying in the crash reporter UI

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
    [BugsplatStartupManager sharedManager].delegate = self
    [BugsplatStartupManager sharedManager].askUserDetails = NO;
    [[BugsplatStartupManager sharedManager] start];
}

Auto Submit

Set autoSubmitCrashReport to YES in order to send crash reports to the server automatically without presenting the crash reporter dialogue. Defaults to NO.

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
    [BugsplatStartupManager sharedManager].delegate = self
    [BugsplatStartupManager sharedManager].autoSubmitCrashReport = YES;
    [[BugsplatStartupManager sharedManager] start];
}

Persist User Details

Set persistUserDetails to YES to save and restore the user's name and email when presenting the crash reporter dialogue. Defaults to NO.

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
    [BugsplatStartupManager sharedManager].delegate = self
    [BugsplatStartupManager sharedManager].persistUserDetails = YES;
    [[BugsplatStartupManager sharedManager] start];
}

Expiration Time

Set expirationTimeInterval to a desired value (in seconds) whereby if the difference in time between when the crash occurred and next launch is greater than the set expiration time, auto send the report without presenting the crash reporter dialogue. Defaults to -1, which represents no expiration.

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
    [BugsplatStartupManager sharedManager].delegate = self
    [BugsplatStartupManager sharedManager].expirationTimeInterval = 2200;
    [[BugsplatStartupManager sharedManager] start];
}

Attachments

Bugsplat supports uploading attachments with crash reports. There's a delegate method provided by BugsplatStartupManagerDelegate that can be implemented to provide an attachment to be uploaded.

- (NSArray<BugsplatAttachment *> *)attachmentsForBugsplatStartupManager:(BugsplatStartupManager *)bugsplatStartupManager
{
    NSURL *fileURL = [[NSBundle mainBundle] URLForResource:@"generated" withExtension:@"json"];
    NSData *data = [NSData dataWithContentsOfURL:fileURL];
​
    NSMutableArray *attachments = [[NSMutableArray alloc] init];
​
    for (NSUInteger i = 0; i < 4; i++)
    {
        BugsplatAttachment *attachment = [[BugsplatAttachment alloc] initWithFilename:[NSString stringWithFormat:@"generated%@.json", @(i)]
                                                                       attachmentData:data
                                                                          contentType:@"application/json"];
​
        [attachments addObject:attachment];
    }
​
​
    return attachments;
}

Localization

The BugSplat crash dialogue can be localized and supports 8 languages out of the box.

• English

• Finnish

• French

• German

• Italian

• Japanese

• Norwegian

• Swedish

Additional languages may be supported by adding the language bundle and strings file to BugsplatMac.framework/Versions/A/Frameworks/HockeySDK.framework/Versions/A/Resources/

Command Line Utility support

Step 1

Add "Other Linker Flags" build setting to embed Info.plist -sectcreate __TEXT __info_plist "$(SRCROOT)/BugsplatTesterCLI/Info.plist"

Step 2

Add @executable_path/ to "Runtime Search Paths" build setting

Step 3

Follow the main configuration steps listed above, however, use upload-archive-cl.sh for uploading archives.

Step 4

Initialize as follows:

[BugsplatStartupManager sharedManager].autoSubmitCrashReport = YES;
[BugsplatStartupManager sharedManager].askUserDetails = NO;
[[BugsplatStartupManager sharedManager] start];

Step 5

Given the "Runtime Search Paths" setting change in step 2, be sure any 3rd party dependencies are located in the same directory as the CLI program so they can be found at runtime.

Sample Application

We have provided BugsplatTester as a sample application for you to test BugSplat. The quickest way to test BugSplat is to do the following:

Step 1

Clone the BugsplatMac repo and run the following:

git submodule init
git submodule update

Step 2

Open the BugsplatTester.xcworkspace file. Edit the current scheme and uncheck Debug executable in the Run section, close the scheme editor and run the application.

Step 3

Click the Crash button when prompted.

Step 4

Click the run button a second time in Xcode. The BugSplat crash dialog will appear the next time the app is launched.

Step 5

Fill out the crash dialog and submit the crash report.

Step 6

Visit BugSplat's Crashes page. When prompted for credentials enter user [email protected] and password Flintstone. The crash you posted from BugsplatTester should be at the top of the list of crashes.

Step 7

Click the link in the ID column to view more details about your crash.

Step 8

You will notice there are no function names or line numbers, this is because you need to upload the application's xcarchive. See the Configuration section above for more information.

Step 9

Repeat this process with the executable from the xcarchive you created with BugsplatTester. To find the executable within the xcarchive, right click the xcarchive in finder and select Show Package Contents. The executable should be located in .../Products/Applications. BugSplat will display function names and line numbers for all crashes posted from this executable.