AsayerTracker

Overview

Asayer is a Frontend Application Monitoring (FAM) tool. It helps developers reproduce bugs, catch errors and track the performance of their web applications. You can find all the details on asayer.io.

Requirements

• SDK supports iOS 11+

Installation

Using Cocoapods

AsayerTracker is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'AsayerTracker'

Manual Installation

The SDK is available in Github Releases tab where you can download the compressed framework, you can find the latest release here.

1. Download the zip file containing this repository.
2. Uncompress the zip file and then move the AsayerTracker/Asayer.framework artefact into your project.
3. Add Asayer.framework located within your project to the Embedded binaries section in the General tab of you iOS app target.

Usage

Initialize the package from your codebase entry point and start the tracker. You must set the projectID option in the constructor. Its value can be found in your Asayer dashboard under Preferences > Projects.

import Asayer

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    Asayer.shared.start(projectID: "PROJECT_ID", options: .defaults)

    //...

    return true
}

You can either pass .defaults to options parameter in order to start defaults modules or specify a custom configuration :

let options = AsayerOptions(inspector: true,
                            crashs: true,
                            analytics: true,
                            performances: true,
                            logs: true,
                            inspectorOptions: .defaults)
Asayer.shared.start(projectID: "PROJECT_ID", options: options)

Options

The components that you can start are:

• inspector: Record screen changes in order to replay it later from yout Dashboard
• crashs: Record the uncaught exceptions that occured in your application.
• analytics: Record screen changes, user gestures, and text input.
• performances: Record app performances and the impact on the device.
• logs: Record the logs in order to facilitate the debugging.

If you enabled the inspector module, you may want to customize "inspectorOptions" parameter to choose what to record on the screen:

• recordNumbers: Record numeric values in input fields
• recordEmails: Record email adresses
• recordImages: Upload missing images/icons in order to make a better replay

Methods

userID

Associates the userID to the recorded session. The method should be called with one string argument.

Asayer.shared.userID('user@asayer.io');

userAnonymousID

Associates the userAnonymousID to the recorded session. The method should be called with one string argument.

Asayer.shared.userAnonymousID('Ishd43ada89');

metadata

Associates metadata value to the current session recording. These variables should be manually added beforehand under Preferences > Metadata in your dashboard. The method should be called with two string arguments (key and value).

Asayer.shared.metadata(key: "metadataKey", value: selectedPlan.title)

event

Sends custom event to the session recorder. These events are searchable by the first argument, which should be a string, and optionally can have a second argument with custom payload that should conform to Encodable.

Asayer.shared.metadata(name: "eventName", payload: selectedPlan)

Exclude views in the inspector

When the inspector is recording the screen content, you may want to exclude a view and it's subviews. Setting a view as obscure makes the content of the text fields masked. Setting a view as hidden makes it completely disappear from the replay.

Inspector.shared.setViewObscure(someView, obscure: true)
Inspector.shared.setViewHidden(someOtherView, hidden: true)

Author

Asayer.io

License

AsayerTracker is available under the MIT license. See the LICENSE file for more info.