iOS Tracker Setup 0.1 0.3

HOME > SNOWPLOW SETUP GUIDE > Step 2: Setup a Tracker > iOS tracker

Contents

• 1. Overview
• 2. Integration options
  • 2.1 Tracker compatibility
  • 2.2 Dependencies
• 3. Setup
  • 3.1 CocoaPods
  • 3.2 Manual setup

1. Overvew

The Snowplow iOS Tracker lets you add analytics to your iOS-based applications.

The Tracker should be relatively straightforward to setup if you are familiar with iOS development using CocoaPods.

Ready? Let's get started.

Back to top

2. Integration options

2.1 Tracker compatibility

With iOS backward compatibility is limited to a small range which it makes it easy to support. Hence, our goal was to make the iOS Tracker compatible with iOS 6+ with easy availability via CocoaPods.

Back to top

2.2 Dependencies

The tracker has dependencies limited to the AFNetworking and FMDB libraries for networking and database management respectively. Both of which have iOS 6+ support as well. If you're installing via CocoaPods, these dependencies are recursively downloaded for your project so you don't have to worry about it.

Back to top

3. Setup

3.1 CocoaPods

We support installing the iOS Tracker via CocoaPods since it's the easiest way to install the tracker. Doing so is simple:

1. Install CocoaPods using gem install cocoapods
2. Create the file Podfile in the root of your XCode project directory, if you don't have one already
3. Add the following line into it:

pod 'SnowplowTracker'

4. Run pod install in the same directory

Back to top

3.2 Manual Setup

If you prefer not to use CocoaPods, you can grab the tracker from our GitHub repo and import it into your project.

3.2.1 Clone the tracker

First, git clone the latest version of the tracker to your local machine:

git clone https://github.com/snowplow/snowplow-objc-tracker.git

If you don't have git installed locally, install it first.

3.2.2 Copy the tracker into your project

You only need to copy the tracker's Snowplow sub-folder into your XCode project's folder. The command will look something like this:

cp -r snowplow-objc-tracker/Snowplow MyObjcApp/MyObjcApp/

Replace MyObjcApp with the name of your own app, and tweak the source code sub-folder accordingly.

Next, drag and drop the sub-folder MyObjcApp/MyObjcApp/Snowplow into your XCode project's workspace:

Make sure that the suggested options for adding Snowplow are set Create groups, then click Finish:

3.2.1 Add the FMDB dependency

The tracker is dependent on FMDB version 2.3, an Objective-C wrapper around SQLite.

As before, git clone the dependency and copy the source into your XCode project's folder:

git clone https://github.com/ccgus/fmdb.git
cd fmdb && git checkout v2.3
cp -r src/fmdb ../MyObjcApp/MyObjcApp/

As before, drag and drop the sub-folder MyObjcApp/MyObjcApp/fmdb into your XCode project's workspace, making sure to Create groups.

Finally, you will need to edit Snowplow/SnowplowEmitter.m and Snowplow/SnowplowEventStore.m in X-Code and change:

#import <FMDB.h>

to:

#import "FMDB.h"

3.2.2 Import all required frameworks

The tracker also depends on various frameworks:

$ grep 'frameworks' ../snowplow-objc-tracker/SnowplowTracker.podspec
  s.ios.frameworks = 'CoreTelephony', 'UIKit', 'Foundation'
  s.osx.frameworks = 'AppKit', 'Foundation'

Go to Target > General tab > Linked Frameworks and Libraries section and add:

1. All of the frameworks for your target platform, as returned by the grep above
2. libsqlite3.dylib

This is what adding the frameworks to an OS-X application looks like:

3.2.3 (Temporary) Comment out DLogs

Until v0.4.0 of the tracker, you need to find all DLog(@ in the Snowplow sub-folder and replace with // DLog(@. You will have to manually comment out DLogs which span multiple lines.

Building

Now Build your project and you should see Build Succeeded. If you get a build error, check that you added Snowplow and fmdb as Groups, not just as Folders.

You are now ready to proceed to instrumenting your app. Just remember to use quotation marks not angle brackets, and the Snowplow sub-folder as necessary when importing the tracker:

#import "SnowplowTracker.h"
#import "SnowplowEmitter.h"