Overview

The BugsplatMac OS X framework enables posting crash reports from Cocoa applications to BugSplat. This allows for your team to process OS X crash reports with BugSplat.

Requirements

Integration

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

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:

Podfile

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

Then, run the following command:

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:

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

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 from https://github.com/BugSplatGit/BugsplatMac/releases 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:

Usage


Configuration

BugsplatMac requires a few configuration steps in order integrate the framework with your Bugsplat account

  1. Add the following key to your app's Info.plist replacing DATABASE_NAME with your account name
  2. You must upload an xcarchive containing your app's binary and symbols to the Bugsplat server in order to symbolicate crash reports.

Initialization

Crash Reporter UI Customization

  1. Custom banner image
  2. User details

Attachments

  1. 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.

Command line utility support

  1. Add "Other Linker Flags" build setting to embed Info.plist
  2. -sectcreate __TEXT __info_plist "$(SRCROOT)/BugsplatTesterCLI/Info.plist"
  3. Add @executable_path/ to "Runtime Search Paths" build setting
  4. Follow the main configuration steps listed above, however, use upload-archive-cl.sh for uploading archives.
  5. Initialize as follows:
  6. 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:

  1. Clone the BugsplatMac repo and run the following:
  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.
  3. Click the "crash" button when prompted.
  4. Click the run button a second time in Xcode. The BugSplat crash dialog will appear the next time the app is launched.
  5. Fill out the crash dialog and submit the crash report.
  6. Visit BugSplat's Crashes page. When prompted for credentials enter user "fred@bugsplat.com" and password "Flintstone". The crash you posted from BugsplatTester should be at the top of the list of crashes.
  7. Click the link in the "Crash Id" column to view more details about your crash.
  8. You will notice there are no function names or line numbers, this is because you need to upload the application's xcarchive. See step 2 in the "Configuration" section above for more information.
  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.