Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Analytics framework for iOS
Objective-C Other

Merge pull request #27 from oronbz/patch-1

Enable multiple GA instances with different IDs
latest commit 9971466068
@twobitlabs authored
Failed to load latest commit information.
AnalyticsKit Added multiple google trackers instance testing
Categories Fixes for some Xcode int format warnings. Fix for Parse provider in l…
Providers Merge pull request #27 from oronbz/patch-1
.gitignore added workspace and user files to .gitignore
.travis.yml only try to upgrade xctool if it is outdated, fixes travis build error
AnalyticsKit.h Added project file and unit tests so the project can be built and ver…
AnalyticsKit.m When logging an analytics kit event with a nil property or nil value
AnalyticsKit.podspec Update AnalyticsKit.podspec
AnalyticsKitDebugProvider.h Added AnalyticsKitUnitTestProvider and AnalyticsKitEvent for inspecting
AnalyticsKitDebugProvider.m only synthesize weak alert property under ARC
AnalyticsKitEvent.h Added project file and unit tests so the project can be built and ver…
AnalyticsKitEvent.m Added project file and unit tests so the project can be built and ver…
AnalyticsKitUnitTestProvider.h Added instance method on unit test provider to clear events
AnalyticsKitUnitTestProvider.m Fix xcode 6.3 warning
CONTRIBUTING.md template file for contributing
LICENSE Update and rename MIT-LICENSE to LICENSE
README.md Updated NewRelic, removed it from tests, marked it as unsupported

README.md

Build Status Gitter chat

AnalyticsKit

The goal of AnalyticsKit is to provide a consistent API for analytics regardless of the provider. With AnalyticsKit, you just call one logging method and AnalyticsKit relays that logging message to each registered provider. AnalyticsKit works in both Swift and Objective-C projects

Supported Providers

Unsupported Providers

The following providers are included but not supported. YMMV.

  • New Relic

    We've had a number of problems integrating the New Relic framework into the test app, so we can't verify that events are logged correctly.

If you would like to add support for a new provider or to update the code for an existing one, simply fork the master repo, make your changes, and submit a pull request.

How to Use

Cocoapods

***Please Note -- While we welcome contributions, Two Bit Labs does not officially support Cocoapods for AnalyticsKit. If you run into problems integrating AnalyticsKit using Cocoapods, please log a GitHub issue.

If your project uses Cocoapods, you can simply include AnalyticsKit for full provider support, or you can specify your provider using Cocoapods subspecs.

  • AdjustIO - pod 'AnalyticsKit/AdjustIO'
  • Flurry - pod 'AnalyticsKit/Flurry'
  • Google Analytics - pod 'AnalyticsKit/GoogleAnalytics'
  • Localytics - pod 'AnalyticsKit/Localytics'
  • Mixpanel - pod 'AnalyticsKit/Mixpanel'
  • New Relic - pod 'AnalyticsKit/NewRelic'
  • TestFlight - pod 'AnalyticsKit/TestFlight'

***Please Note -- The Parse subspec has been removed, as it won't integrate correctly using Cocoapods.

Installation

  1. Download the provider's SDK and add it to your project, or install via cocoapods.
  2. Add AnalyticsKit to your project either as a git submodule or copying the source into your project. In Xcode, only include AnalyticsKit.h/.m and any providers you plan to use.
  3. In your AppDelegate's applicationDidFinishLaunchingWithOptions: method, create an array with your provider instance(s) and call initializeLoggers:.

Objective-C:

Initialize AnalyticsKit in applicationDidFinishLaunchingWithOptions

AnalyticsKitFlurryProvider *flurry = [[AnalyticsKitFlurryProvider alloc] initWithAPIKey:@"[YOUR KEY]"];
[AnalyticsKit initializeLoggers:@[flurry]];

To log an event, simply call the logEvent: method.

[AnalyticsKit logEvent:@"Log In" withProperties:infoDict];

Depending on which analytics providers you use you may need to include the following method calls in your app delegate (or just go ahead and include them to be safe):

[AnalyticsKit applicationWillEnterForeground]; 
[AnalyticsKit applicationDidEnterBackground];  
[AnalyticsKit applicationWillTerminate];  

Swift:

Import AnalyticsKit and any providers in your bridging header:

#import "AnalyticsKit.h"
#import "AnalyticsKitNewRelicProvider.h"

Initialize AnalyticsKit in application:didFinishLaunchingWithOptions:

let newRelic = AnalyticsKitNewRelicProvider(APIKey: "[YOUR KEY]")
AnalyticsKit.initializeLoggers([newRelic])

Depending on which analytics providers you use you may need to include the following method calls in your app delegate (or just go ahead and include them to be safe):

AnalyticsKit.applicationWillEnterForeground()
AnalyticsKit.applicationDidEnterBackground() 
AnalyticsKit.applicationWillTerminate]()

See AnalyticsKit.h for an exhaustive list of the logging methods available.

Apple Watch Analytics

AnalyticsKit now provides support for logging from your Apple Watch Extension.

Supported Providers

Installation

  1. If you haven't already done so, follow the installation steps above to add your provider's SDK and AnalyticsKit to your project.
  2. Adding Provider's API Key.

Objective-C:

Initialize AnalyticsKit in awakeWithContext

AnalyticsKitWatchExtensionFlurryProvider *flurry = [AnalyticsKitWatchExtensionFlurryProvider new];
[AnalyticsKit initializeLoggers:@[flurry]];

To log an event, simply call the logEvent: method.

[AnalyticsKit logEvent:@"Launching Watch App"];

Swift:

Import AnalyticsKit and any providers in your bridging header:

#import "AnalyticsKit.h"
#import "AnalyticsKitWatchExtensionFlurryProvider.h"

Initialize AnalyticsKit in awakeWithContext

let flurryLogger = AnalyticsKitWatchExtensionFlurryProvider()
AnalyticsKit.initializeLoggers([flurryLogger])

To log an event, simply call the logEvent method.

AnalyticsKit.logEvent("Launching Watch App");

Contributors

Something went wrong with that request. Please try again.