OneAgent SDK for iOS

Dynatrace.startupWithInfoPlistSettings()

[Dynatrace startupWithInfoPlistSettings];

let startupDictionary: [String : Any?] = [
    kDTXApplicationID: "aaaa-bbbb-cccc-dddd-eeee-ffff",
    kDTXBeaconURL: "https://my.beacon.url/mbeacon",
    kDTXLogLevel: "WARNING"
]
Dynatrace.startup(withConfig: startupDictionary)

NSDictionary<NSString*, id> *startupDictionary = @{
    kDTXApplicationID: @"aaaa-bbbb-cccc-dddd-eeee-ffff",
    kDTXBeaconURL: @"https://my.beacon.url/mbeacon",
    kDTXLogLevel: @"WARNING"
};
[Dynatrace startupWithConfig:startupDictionary];

// start the "Tap on Search" action
let action = DTXAction.enter(withName: "Tap on Search")

// ...do some work here...

// close the "Tap on Search" action
action?.leave()

// start the "Tap on Search" action
DTXAction *action = [DTXAction enterActionWithName:@"Tap on Search"];

// ...do some work here...

// close the "Tap on Search" action
[action leaveAction];

// start a parent custom action
let searchAction = DTXAction.enter(withName: "Tap on Search")

// ...do some work here...

// start a child action
let parseAction = DTXAction.enter(withName: "Tap on Confirm", parentAction: searchAction)

// ...do some work here...

// close a child action
parseAction?.leave()

// ...do some work here...

// close a parent custom action
searchAction?.leave()

// start a parent custom action
DTXAction *searchAction = [DTXAction enterActionWithName: @"Tap on Search"];

// ...do some work here...

// start a child action
DTXAction *parseAction = [DTXAction enterActionWithName: @"Tap on Confirm" parentAction: searchAction];

// ...do some work here...

// close a child action
[parseAction leaveAction];

// ...do some work here...

// close a parent custom action
[searchAction leaveAction];

func countParameters(query: String?) -> Int {
    var count: Int = 0
    //create a parent custom action
    let checkQueryAction = DTXAction.enter(withName: "Tap on Check query")

    //report a value on an action
    checkQueryAction?.reportValue(withName: "query", stringValue: String(describing: query))

    let countParametersAction = DTXAction.enter(withName: "Count parameters", parentAction: checkQueryAction)
    if let query = query {
        count = query.components(separatedBy:"&").count
        //report a value
        countParametersAction?.reportValue(withName: "Parameters found", intValue: Int64(count))
        //close a child action
        countParametersAction?.leave()
    } else {
        //report an event
        countParametersAction?.reportEvent(withName: "No parameters found")
        //close a child action
        countParametersAction?.leave()
        //report an error
        checkQueryAction?.reportError(withName: "Query was nil", errorValue: -42)
    }
    //close a parent custom action - automatically closes all open child actions if not closed by API
    checkQueryAction?.leave()
    return count
}

- (int) countParameters: (NSString *) query {
    int count = 0;
    //create a parent custom action
    DTXAction *checkQueryAction = [DTXAction enterActionWithName:@"Tap on Check query"];

    //report a value on an action
    [checkQueryAction reportValueWithName:@"query" stringValue:query];

    DTXAction *countParametersAction = [DTXAction enterActionWithName:@"Count parameters" parentAction:checkQueryAction];
    if (query != nil) {
        count = [query componentsSeparatedByString:@"&"].count;
        //report a value
        [countParametersAction reportValueWithName:@"Parameters found" intValue:count];
        //close a child action
        [countParametersAction leaveAction];
    } else {
        //report an event
        [countParametersAction reportEventWithName:@"No parameters found"];
        //close a child action
        [countParametersAction leaveAction];
        //report an error
        [checkQueryAction reportErrorWithName:@"Query was nil" errorValue:-42];
    }
    //close a parent custom action - automatically closes all open child actions if not closed by API
    [checkQueryAction leaveAction];
    return count;
}

// start the "Tap on Search" action
let action = DTXAction.enter(withName: "Tap on Search")

// ...do some work here...

// cancel the "Tap on Search" action
action?.cancel()

// start the "Tap on Search" action
DTXAction *action = [DTXAction enterActionWithName:@"Tap on Search"];

// ...do some work here...

// cancel the "Tap on Search" action
[action cancelAction];

let myAction = DTXAction.enter(withName: "My action")
myAction?.reportEvent(withName: "Something important just happened")
myAction?.leave()

// report an event
- (DTX_StatusCode) reportEventWithName:(NSString *)eventName

DTXAction.reportError(withName: "My custom error", error: NSError(domain: "Global issue", code: 007, userInfo: nil))

let myAction = DTXAction.enter(withName: "My action")
myAction?.reportError(withName: "My custom error", error: NSError(domain: "Action issue", code: 007, userInfo: nil))
myAction?.leave()

// report an error
DTXAction *action;
NSError* error;
[action reportErrorWithName:@"CommunicationError" errorValue:[error code]];

let myAction = DTXAction.enter(withName: "My action")
myAction?.reportValue(withName: "My int value", intValue: 1234)
myAction?.reportValue(withName: "My double value", doubleValue: 12.34)
myAction?.reportValue(withName: "My string value", stringValue: "Hello World!")
myAction?.leave()

- (DTX_StatusCode) reportValueWithName:(NSString *)valueName
                               intValue:(NSInteger)value
- (DTX_StatusCode) reportValueWithName:(NSString *)valueName
                            doubleValue:(double)doubleValue
- (DTX_StatusCode) reportValueWithName:(NSString *)valueName
                            stringValue:(NSString *)stringValue

let attributes: [String: Any] = [
    "event.name": "Confirmed Booking",
    "screen": "booking-confirmation",
    "product": "Danube Anna Hotel",
    "amount": 358.35,
    "currency": "USD",
    "reviewScore": 4.8,
    "arrivalDate": "2022-11-05",
    "departureDate": "2022-11-15",
    "journeyDuration": 10,
    "adultTravelers": 2,
    "childrenTravelers": 0
]
Dynatrace.sendBizEvent(withType: "com.easytravel.funnel.booking-finished", attributes: attributes)

NSDictionary<NSString*, id> *attributes = @{
        @"event.name": @"Confirmed Booking",
        @"screen": @"booking-confirmation",
        @"product": @"Danube Anna Hotel",
        @"amount": @358.35,
        @"currency": @"USD",
        @"reviewScore": @4.8,
        @"arrivalDate": @"2022-11-05",
        @"departureDate": @"2022-11-15",
        @"journeyDuration": @10,
        @"adultTravelers": @2,
        @"childrenTravelers": @0
    };
[Dynatrace sendBizEventWithType: @"com.easytravel.funnel.booking-finished" attributes: attributes];

import UIKit
import Dynatrace

class ViewController: UIViewController {

    override func viewDidLoad() {
        guard let parentAction = DTXAction.enter(withName: #function) else {
            print("unable to enter action")
            return
        }
        defer { parentAction.leave() }
        webSocketMonitoringExample(parentAction: parentAction)
    }

    func webSocketMonitoringExample(parentAction : DTXAction) {
        guard let childAction = DTXAction.enter(withName: #function, parentAction: parentAction) else {
            print("unable to enter child action")
            return
        }
        defer { childAction.leave() }

        let urlSession = URLSession(configuration: .default)
        guard let url = URL(string: "wss://....") else {
            print("unable to create URL")
            return
        }

        // not sending the tag, just using it for internal reference
        guard let tag = childAction.getTagFor(url) else {
            print("unable to create tag")
            return
        }
        let webrequestTiming = DTXWebRequestTiming.getDTXWebRequestTiming(tag, request: url)

        let webSocketTask = urlSession.webSocketTask(with: url)
        webSocketTask.resume()

        webrequestTiming?.start()

        let messageString = "Hello World"
        let bytesSent = Int64(messageString.data(using: .utf8)?.count ?? 0) // sample
        let message = URLSessionWebSocketTask.Message.string(messageString)
        webSocketTask.send(message) { error in
            if let error = error {
                print("send error: \(error.localizedDescription)")
            }
        }

        // synchronous example
        let receiveDispatch = DispatchGroup()
        receiveDispatch.enter()
        var bytesReceived:Int64 = 0
        webSocketTask.receive { result in
            let receievedString = "\(result)"
            print("received data: \(receievedString)")
            bytesReceived = Int64(receievedString.data(using: .utf8)?.count ?? 0) // sample
            receiveDispatch.leave()
        }
        receiveDispatch.wait()

        webSocketTask.cancel()
        webrequestTiming?.stop(String(URLSessionWebSocketTask.CloseCode.normalClosure.rawValue), bytesSent: bytesSent, bytesReceived: bytesReceived)
    }
}

#import "ViewController.h"
#import <Dynatrace/Dynatrace.h>

@interface ViewController ()

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    DTXAction* parent = [DTXAction enterActionWithName: [NSString stringWithFormat:@"%s", __FUNCTION__]];
    [self webSocketMonitoringExample:parent];
    [parent leaveAction];
}

- (void)webSocketMonitoringExample:(DTXAction*)parentAction {
    DTXAction* childAction = [DTXAction enterActionWithName:[NSString stringWithFormat:@"%s", __FUNCTION__] parentAction:parentAction];

    NSURLSession* urlSession = [NSURLSession sessionWithConfiguration:NSURLSessionConfiguration.defaultSessionConfiguration];
    NSURL* url = [NSURL URLWithString:@"wss://...."]; // example echo wss server

    NSString* tag = [childAction getTagForURL:url]; // not sending the tag, just using it for internal reference
    DTXWebRequestTiming* webrequestTiming = [DTXWebRequestTiming getDTXWebRequestTiming:tag requestUrl:url];

    NSURLSessionWebSocketTask* webSocketTask = [urlSession webSocketTaskWithURL:url];
    [webSocketTask resume];

    [webrequestTiming startWebRequestTiming];

    NSURLSessionWebSocketMessage* message = [[NSURLSessionWebSocketMessage alloc] initWithString:@"Hello World"];
    NSUInteger bytesSent = [message.string dataUsingEncoding:NSUTF8StringEncoding].length; // sample
    [webSocketTask sendMessage:message completionHandler:^(NSError * _Nullable error) {
        if (error) {
            NSLog(@"send error: %@", error.localizedDescription);
        }
    }];

    // synchronous example
    __block NSUInteger bytesReceieved;
    dispatch_group_t receiveDispatch = dispatch_group_create();
    dispatch_group_enter(receiveDispatch);
    [webSocketTask receiveMessageWithCompletionHandler:^(NSURLSessionWebSocketMessage * _Nullable message, NSError * _Nullable error) {
        bytesReceieved = [message.string dataUsingEncoding:NSUTF8StringEncoding].length; // sample
        NSLog(@"received data: %@", message.string);
        dispatch_group_leave(receiveDispatch);
    }];
    dispatch_group_wait(receiveDispatch, DISPATCH_TIME_FOREVER);

    [webSocketTask cancel];
    [webrequestTiming stopWebRequestTiming:[NSString stringWithFormat:@"%ld", (long)NSURLSessionWebSocketCloseCodeNormalClosure] bytesSent:bytesSent bytesReceived:bytesReceieved];
    [childAction leaveAction];
}

@end

Dynatrace.identifyUser("userId")

[Dynatrace identifyUser:@"userId"];

Dynatrace.endVisit()

[Dynatrace endVisit];

import Dynatrace
…
let privacyConfig = Dynatrace.userPrivacyOptions()
// set a data collection level (user allowed you to capture performance and personal data)
privacyConfig.dataCollectionLevel = .userBehavior
// allow crash reporting (user allowed you to collect information on crashes)
privacyConfig.crashReportingOptedIn = true
// allow Session Replay on crashes (user allowed you to record replays of crashes via Session Replay)
privacyConfig.crashReplayOptedIn = true
// callback after privacy changed
Dynatrace.applyUserPrivacyOptions(privacyConfig) { (successful) in
}

#import <Dynatrace/Dynatrace.h>
…
id<DTXUserPrivacyOptions> privacyConfig = [Dynatrace userPrivacyOptions];
// set a data collection level (user allowed you to capture performance and personal data)
privacyConfig.dataCollectionLevel = DTX_DataCollectionUserBehavior;
// allow crash reporting (user allowed you to collect information on crashes)
privacyConfig.crashReportingOptedIn = YES;
// allow Session Replay on crashes (user allowed you to record replays of crashes via Session Replay)
privacyConfig.crashReplayOptedIn = YES;
// callback after privacy changed
[Dynatrace applyUserPrivacyOptions:privacyConfig completion:^(BOOL successful) {
}];

import Dynatrace
…
let privacyOptions = Dynatrace.userPrivacyOptions()
let dataCollectionLevel = privacyConfig.dataCollectionLevel
let crashReporting = privacyConfig.crashReportingOptedIn
let crashReplay = privacyConfig.crashReplayOptedIn

#import <Dynatrace/Dynatrace.h>
…
id<DTXUserPrivacyOptions> privacyConfig = [Dynatrace userPrivacyOptions];
DTX_DataCollectionLevel level=  privacyConfig.dataCollectionLevel;
BOOL crashReporting = privacyConfig.crashReportingOptedIn;
BOOL crashReplay = privacyConfig.crashReplayOptedIn;

var button: UIButton
button.dtxCustomControlName("Custom button title")

var tableCell: UITableViewCell
tableCell.dtxCustomCellName("Custom table cell title")

var collectionCell: UICollectionViewCell
collectionCell.dtxCustomCellName("Custom collection cell title")

UIButton *button;
[button dtxCustomControlName:@"Custom button title"];

UIButton *tableCell;
[tableCell dtxCustomCellName:@"Custom table cell title"];

UIButton *collectionCell;
[collectionCell dtxCustomCellName:@"Custom collection cell title"];

@IBAction func buttonTouchUp(_ sender: Any) {
    //for example, handle button touch, get values that should be put into user action name

    //fetch current autogenerated action and modify it
    Dynatrace.modifyUserAction( { (action) -> () in
        let oldName = action?.getName()
        action?.setName("This is a renamed auto user action (was '\(oldName)')")
        action?.reportValue(withName: "The Answer to the Ultimate Question of Life, the Universe, and Everything", intValue: 42)
        action?.reportValue(withName: "G-force", doubleValue: 9.81)
        action?.reportValue(withName: "Palindrome", stringValue: "Was it a car or a cat I saw?")
        action?.reportError(withName: "Some error", errorValue: -1)
        //other reportError also possible, skipping in this example
    })
}

- (IBAction)buttontouchUp:(UIButton *)sender {
    //for example, handle button touch, get values that should be put into user action name

    //fetch current autogenerated action and modify it
    [Dynatrace modifyUserAction:^(DTXAction * _Nullable modifiableAction) {
        NSString* oldName = [modifiableAction getName];
        [modifiableAction setName:[NSString stringWithFormat: @"This is a renamed auto user action (was '%@')", oldName]];
        [modifiableAction reportValueWithName: @"The Answer to the Ultimate Question of Life, the Universe, and Everything" intValue: 42];
        [modifiableAction reportValueWithName: @"G-force" doubleValue: 9.81];
        [modifiableAction reportValueWithName: @"Palindrome" stringValue: @"Was it a car or a cat I saw?"];
        [modifiableAction reportErrorWithName: @"Some error" errorValue: -1];
        //other reportError also possible, skipping in this example
    }];
}

Dynatrace.setAutoUserActionCreationCallback { modifiableAction in
    guard let modifiableAction = modifiableAction else {
        return
    }
    if modifiableAction.getName().starts(with: "Loading") {
        modifiableAction.cancel()
    } else {
        modifiableAction.setName("Modified Action: " + modifiableAction.getName())
    }
}

[Dynatrace setAutoUserActionCreationCallback:^(DTXAction * _Nullable modifiableAction) {
    if (!modifiableAction) {
        return;
    }
    if ([[modifiableAction getName] hasPrefix:@"Loading"]) {
        [modifiableAction cancelAction];
    } else {
        [modifiableAction setName:[NSString stringWithFormat:@"Modified Action: %@", [modifiableAction getName]]];
    }
}];