BugSplat Documents

OS X osx_crashreporting_bugsplat

The BugSplatMac OS X framework allows posting of crash reports from Cocoa applications to BugSplat. Visit our GitHub repository for more information on this integration.


Requirements

  • BugsplatMac supports OS X 10.7 and later.
  • BugsplatMac supports x86_64 applications only.

Integration

BugsplatMac supports many different 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 third-party libraries, such as 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

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 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 and 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.
  6. Click on your project in the Project Navigator (⌘+1).
  7. Click your target in the project editor.
  8. Click on the Build Phases tab.
  9. Click the Add Build Phase button at the bottom and choose Add Copy Files.
  10. Click the disclosure triangle next to the new build phase.
  11. Choose Frameworks from the Destination list.
  12. 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 to 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

    <key>BugsplatServerURL</key>
    <string>https://DATABASE_NAME.bugsplat.com/</string>
    
  2. You must upload an xcarchive containing your app’s binary and symbols to the Bugsplat server in order to symbolicate crash reports.

    • 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.’

      post-archive-script

Initialization

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