Dynatrace OpenKit API methods

1String applicationID = "application-id";
2long deviceID = Util.getDeviceID();
3String endpointURL = "https://tenantid.beaconurl.com/mbeacon";
4
5OpenKit openKit = new DynatraceOpenKitBuilder(endpointURL, applicationID, deviceID).build();

1class MyCustomTrustManager implements SSLTrustManager {
2    // implement interface methods
3}
4
5SSLTrustManager trustManager = new MyCustomTrustManager()
6
7OpenKit openKit = new DynatraceOpenKitBuilder(endpointURL, applicationID, deviceID)
8    .withTrustManager(trustManager)
9    .build();

1// wait until the OpenKit instance is fully initialized
2boolean success = openKit.waitForInitCompletion();
3
4// wait up to 10 seconds for OpenKit to complete initialization
5long timeoutInMilliseconds = 10 * 1000;
6boolean success = openKit.waitForInitCompletion(timeoutInMilliseconds);

1boolean isInitialized = openKit.isInitialized();
2if (isInitialized) {
3    System.out.println("OpenKit is initialized");
4} else {
5    System.out.println("OpenKit is not yet initialized");
6}

1// create a session and pass an IP address
2String clientIPAddress = "12.34.56.78";
3Session sessionWithArgument = openKit.createSession(clientIPAddress);
4
5// create a session and let the IP be assigned on the server side
6// this overloaded method is available since OpenKit Java 1.4.0
7Session sessionWithoutArgument = openKit.createSession();

1session.identifyUser("jane.doe@example.com");

1session.end();
2session = null; // not needed, just used to indicate that the session is no longer valid.

1private static int div(int numerator, int denominator) {
2    return numerator / denominator;
3}
4
5public static void divWithCrash() {
6    int numerator = 5;
7    int denominator = 0;
8    try {
9        System.out.println("Got: " + div(numerator, denominator));
10    } catch (Exception e) {
11        String errorName = e.getClass().getName();
12        String reason = e.getMessage();
13        String stackTrace = getStackTraceAsString(e); // get the stacktrace as string, similar as e.printStackTrace()
14        // and now report the application crash via the session
15        session.reportCrash(errorName, reason, stackTrace);
16    }
17}

1String rootActionName = "rootActionName";
2String childActionName = "childActionName";
3// create a custom action for a session
4RootAction rootAction = session.enterAction(rootActionName);
5// create a child action for the custom action
6Action childAction = rootAction.enterAction(childActionName);

1Action parentAction = action.leaveAction(); // returns the appropriate custom action
2Action parent = parentAction.leaveAction(); // will always return null

1Action parentAction = action.cancelAction(); // returns the appropriate custom action
2Action parent = parentAction.cancelAction(); // will always return null

1String eventName = "eventName";
2action.reportEvent(eventName);
3
4// also report on the RootAction
5rootAction.reportEvent(eventName);

1// first report a 32-bit int value
2String keyIntType = "intType";
3int valueInt = 42;
4action.reportValue(keyIntType, valueInt);
5
6// then let's report a 64-bit long value
7String keyLongType = "longType";
8long valueLong = Long.MIN_VALUE;
9action.reportValue(keyLongType, valueLong);
10
11// then let's report a double value
12String keyDoubleType = "doubleType";
13double valueDouble = 3.141592653589793;
14action.reportValue(keyDoubleType, valueDouble);
15
16// and also a string value
17String keyStringType = "stringType";
18String valueString = "The quick brown fox jumps over the lazy dog";
19action.reportValue(keyStringType, valueString);

1String errorName = "Unknown Error";
2int errorCode = 42;
3
4action.reportError(errorName, errorCode);

1public void restrictedMethod() {
2    if (!isUserAuthorized()) {
3        // user is not authorized - report this as an error
4        String errorName = "Authorization error";
5        String causeName = "User not authorized";
6        String causeDescription = "The current user is not authorized to call restrictedMethod.";
7        String stackTrace = null; // no stack trace is reported
8
9        action.reportError(errorName, causeName, causeDescription, stackTrace);
10
11        return;
12    }
13
14    // ... further processing ...
15}

1try {
2    // call a method that is throwing an exception
3    callMethodThrowingException();
4} catch(Exception caughtException) {
5    // report the caught exception as error via OpenKit
6    String errorName = "Unknown Error";
7    action.reportError(errorName, caughtException);
8}

1Map <String, JSONValue> attributes = new HashMap<String, JSONValue>();
2attributes.put("event.name", JSONStringValue.fromString("Confirmed Booking"));
3attributes.put("screen", JSONStringValue.fromString("booking-confirmation"));
4attributes.put("product", JSONStringValue.fromString("Danube Anna Hotel"));
5attributes.put("amount", JSONNumberValue.fromDouble(358.35));
6attributes.put("currency", JSONStringValue.fromString("USD"));
7attributes.put("reviewScore", JSONNumberValue.fromDouble(4.8));
8attributes.put("arrivalDate", JSONStringValue.fromString("2022-11-05"));
9attributes.put("departureDate", JSONStringValue.fromString("2022-11-15"));
10attributes.put("journeyDuration", JSONNumberValue.fromLong(10));
11attributes.put("adultTravelers", JSONNumberValue.fromLong(2));
12attributes.put("childrenTravelers", JSONNumberValue.fromLong(0));
13
14session.sendBizEvent('com.easytravel.funnel.booking-finished', attributes);

1// create URL and open URLConnection
2URL url = new URL("http://www.my-backend.com/api/v3/users");
3URLConnection urlConnection = url.openConnection();
4
5// create the WebRequestTracer
6WebRequestTracer webRequestTracer = action.traceWebRequest(urlConnection);
7webRequestTracer.start();
8
9// consume data
10BufferedReader in = new BufferedReader(new InputStreamReader(uc.getInputStream()));
11String inputLine;
12while ((inputLine = in.readLine()) != null) {
13    // TODO - do something useful with response
14}
15in.close();
16
17// stop web request tracing when done
18webRequestTracer.stop(200); // would use the HTTP response code normally.
19
20// --------------------------------------------
21// alternative solution not using URLConnection
22// --------------------------------------------
23
24String url = "http://www.my-backend.com/api/v3/users";
25
26// create the WebRequestTracer
27WebRequestTracer webRequestTracer = action.traceWebRequest(url);
28
29// this is the HTTP header name & value which needs to be added to the HTTP request.
30String headerName = OpenKitConstants.WEBREQUEST_TAG_HEADER;
31String headerValue = webRequestTracer.getTag();
32
33webRequestTracer.start();
34
35// perform the request here & do not forget to add the HTTP header
36
37webRequestTracer.setBytesSent(12345);     // 12345 bytes sent
38webRequestTracer.setBytesReceived(67890); // 67890 bytes received
39webRequestTracer.stop(200);               // 200 was the response code

1import com.dynatrace.openkit.DataCollectionLevel;
2import com.dynatrace.openkit.CrashReportingLevel;
3
4OpenKit openKit = new DynatraceOpenKitBuilder(endpointURL, applicationID, deviceID)
5// set a data collection level (user allowed you to capture performance and personal data)
6        .withDataCollectionLevel(DataCollectionLevel.USER_BEHAVIOR)
7// allow crash reporting (user allowed you to collect information on crashes)
8        .withCrashReportingLevel(CrashReportingLevel.OPT_IN_CRASHES)
9        .build();

1openKit.shutdown();