Blue Triangle Analytics SDK for iOS

Table of Contents

• Overview
• Installation
• Using Timers
  • Overview
  • Timer Types
  • Instance Properties
  • Instance Methods
  • Enumerations
• Classes
• Type Aliases

Overview

Use Blue Triangle's Native App Real User Monitoring Module to collect end user experience data for measuring application speed, responsiveness, errors conditions, and network calls.

Installation

Xcode 13: go to File > Add Packages…, enter the package repository URLhttps://github.com/blue-triangle-tech/btt-swift-sdk.git, and click Add Package.

Xcode 11 - 12: go to File > Swift Packages > Add Package Dependency…and enter the package repository URLhttps://github.com/blue-triangle-tech/btt-swift-sdk.git, then follow the instructions.

Configuration

Before sending timers you must first configureBlueTriangle. It is recommended to do this in yourAppDelegate.application(_:didFinishLaunchingWithOptions:)method:

BlueTriangle.configure { config in
    config.siteID="MY_SITE_ID"
    config.isReturningVisitor=true
    config.abTestID="MY_AB_TEST_ID"
    config.campaignMedium="MY_CAMPAIGN_MEDIUM"
    config.campaignName="MY_CAMPAIGN_NAME"
    config.campaignSource="MY_CAMPAIGN_SOURCE"
    config.dataCenter="MY_DATA_CENTER"
    config.trafficSegmentName="MY_SEGMENT_NAME"
    config.crashTracking= .nsException
    config.performanceMonitorSampleRate=1.0
}

Using Timers

Overview

Create timers to measure responses to user interactions. 

To measure the duration of a user interaction, initialize a Page object describing that interaction and pass it to startTimer(page:timerType:) to receive a running timer instance.

let page =Page(pageName: "MY_PAGE")
let timer =BlueTriangle.startTimer(page: page)

If you need to defer the start of the timer, use makeTimer(page:timerType:) and call the returned timer’s start()method when you are ready to start timing:

let page =Page(pageName: "MY_PAGE")
let timer =BlueTriangle.makeTimer(page: page)...timer.start()

In both cases, pass your timer to endTimer(_:purchaseConfirmation:)to send it to the Blue Triangle server.

BlueTriangle.endTimer(timer)

Running timers are automatically stopped when passed to endTimer(_:purchaseConfirmation:), though you can end timing earlier by calling the timer’s end()method.

timer.end()...
// You must still pass the timer to `BlueTriangle.endTimer(_:)` to send it to the Blue Triangle serverBlueTriangle.endTimer(timer)

For timers that are associated with checkout, create aPurchaseConfirmationobject to pass along with the timer toendTimer(_:purchaseConfirmation:):

timer.end()
let purchaseConfirmation =PurchaseConfirmation(cartValue: 99.00)
BlueTriangle.endTimer(timer, purchaseConfirmation: purchaseConfirmation)

Timer Types

makeTimer(page:timerType:) and startTimer(page:timerType:) have a timerType parameter to specify the type of the timer they return. By default, both methods return main timers with the type BTTimer.TimerType.main. When Network Capture is enabled, requests made with one of the bt-prefixed URLSession methods will be associated with the last main timer to have been started at the time the request completes. It is recommended to only have a single main timer running at any given time. If you need overlapping timers, create additional custom timers by specifying a BTTimer.TimerType.custom timer type:

let mainTimer =BlueTriangle.startTimer(page: Page(pageName: "MY_PAGE"))
let customTimer =BlueTriangle.startTimer(page: Page(pageName: "MY_OTHER_TIMER"), timerType: .custom)
// ...BlueTriangle.endTimer(mainTimer)
// ...BlueTriangle.endTimer(customTimer)

Instance Properties

var endTime: TimeInterval The epoch time interval at which the timer was ended.

var hasEnded:Bool

var interactiveTime: TimeIntervalThe epoch time interval at which the timer was marked interactive.

var page: PageAn object describing the user interaction measured by the timer.

var startTime:TimeIntervalThe epoch time interval at which the timer was started.

var state:StateThe state of the timer.

let type: TimerTypeThe type of the timer.

Network Capture

The Blue Triangle SDK offersbt-prefixed versions of commonURLSessionmethods that can be used to gather information about network requests when network capture is enabled:

To enable network capture, configure the SDK with a non-zero network sample rate:

BlueTriangle.configure { config in...
    config.networkSampleRate=0.05
}

A value of0.05, for example, means that network capture will be randomly enabled for 5% of user sessions. Network requests made using one of thebt-prefixedURLSessionmethods will be associated with the last main timer to have been started.

let timer = BlueTriangle.startTimer(page: Page(pageName: "MY_PAGE"))
URLSession.shared.btDataTask(with: URL(string: "https://example.com")!) { data, response, error in
// ...}.resume()

Requests are not associated with a timer until the request ends.

Classes

classBlueTriangle: The entry point for interacting with the Blue Triangle SDK.

classBlueTriangleConfiguration: Configuration object for the Blue Triangle SDK.

Type Aliases

typealiasIdentifier: An 18-digit identifier.

typealiasMillisecond: The milliseconds between an event and 00:00:00 UTC on 1 January 1970.