The OpenKit provides an easy and lightweight way to get insights into applications with Dynatrace/AppMon by instrumenting the source code of those applications.
It is best suited for applications running separated from their backend and communicating via HTTP, like rich-client-applications, embedded devices, terminals, and so on.
The big advantages of the OpenKit are that it's designed to
- be as easy-to-use as possible
- be as dependency-free as possible (no third party libraries or Dynatrace/AppMon Agent needed)
- be easily portable to other languages and platforms
This repository contains the reference implementation in pure Java. Other implementations are listed as follows:
- .NET: https://github.com/Dynatrace/openkit-dotnet/
- C/C++: https://github.com/Dynatrace/openkit-native/
- JavaScript: https://github.com/Dynatrace/openkit-js
- Create Sessions and User Actions
- Report values, events, errors and crashes
- Trace web requests to server-side PurePaths
- Tag Sessions with a user tag
- Use it together with Dynatrace or AppMon
- Create server-side PurePaths (this functionality is provided by OneAgent SDKs)
- Create metrics (use the Custom network devices & metrics API to report metrics)
- API should be as simple and easy-to-understand as possible
- Incorrect usage of the OpenKit should still lead to valid results, if possible
- In case of errors, the API should not throw exceptions, but only log those errors (in verbose mode)
- No usage of third-party libraries, should run without any dependencies
- Avoid usage of newest Java APIs, should be running on older Java VMs, too
- Avoid usage of too much Java-specific APIs to allow rather easy porting to other languages
- Design reentrant APIs and document them
- All non binary files within the repository are formatted with unix style (LF) line endings.
- Java Runtime Environment (JRE) 6, 7 or 8
- Java Development Kit (JDK) 6, 7 or 8
- Environment Variable JAVA_HOME set to JDK install directory
- Java Runtime Environment (JRE) 6, 7 or 8
Dependencies for testing (JUnit, Hamcrest, Mockito) are managed by Gradle.
OpenKit is available as Maven package on JCenter and should be used via Maven, Gradle or Ivy.
Assuming you are in OpenKit's top level directory
gradlew jarThe built jar file(s) openkit-<version>-java<java_version>.jar will be located in the build/dist directory.
gradlew javadocThe generated javadoc will be located in the build/docs/javadoc directory.
In this part the concepts used throughout OpenKit are explained. A short sample how to use OpenKit is also provided. For detailed code samples have a look into example.md.
A DynatraceOpenKitBuilder/AppMonOpenKitBuilder instance is responsible for setting
application relevant information, e.g. the application's version and device specific information, and to create
an OpenKit instance.
The OpenKit is responsible for creating user sessions (see Session).
Although it would be possible to have multiple OpenKit instances connected to the same endpoint
(Dynatrace/AppMon) within one process, there should be one unique instance. OpenKit is designed to be
thread safe and therefore the instance can be shared among threads.
On application shutdown, shutdown() needs to be called on the OpenKit instance.
A Session represents kind of a user session, similar to a browser session in a web application.
However the application developer is free to choose how to treat a Session.
The Session is used to create RootAction instances and report application crashes.
When a Session is no longer required, it's highly recommended to end it, using the Session.end() method.
The RootAction and Action are named hierarchical nodes for timing and attaching further details.
A RootAction is created from the Session and it can create Action instances. Both, RootAction and
Action, provide the possibility to attach key-value pairs, named events and errors, and can be used
for tracing web requests.
When the application developer wants to trace a web request, which is served by a service
instrumented by Dynatrace, a WebRequestTracer should be used, which can be
requested from a Session or an Action.
A named Event is attached to an Action and contains a name.
For an Action key-value pairs can also be reported. The key is always a String
and the value may be an Integer (int), a floating point (double) or a String.
Errors are a way to report an erroneous condition on an Action.
Crashes are used to report (unhandled) exceptions on a Session.
OpenKit enables you to tag sessions with unique user tags. The user tag is a String that allows to uniquely identify a single user.
This small example provides a rough overview how OpenKit can be used.
Detailed explanation is available in example.md.
String applicationName = "My OpenKit application";
String applicationID = "application-id";
long deviceID = 42;
String endpointURL = "https://tenantid.beaconurl.com/mbeacon";
OpenKit openKit = new DynatraceOpenKitBuilder(endpointURL, applicationID, deviceID)
.withApplicationName(applicationName)
.withApplicationVersion("1.0.0.0")
.withOperatingSystem("Windows 10")
.withManufacturer("MyCompany")
.withModelID("MyModelID")
.build();
String clientIP = "8.8.8.8";
Session session = openKit.createSession(clientIP);
session.identifyUser("jane.doe@example.com");
String rootActionName = "rootActionName";
RootAction rootAction = session.enterAction(rootActionName);
String childActionName = "childAction";
Action childAction = rootAction.enterAction(childActionName);
childAction.leaveAction();
rootAction.leaveAction();
session.end();
openKit.shutdown();- problem with SSL keysize > 1024 for Diffie-Hellman (used by Dynatrace) in Java 6 (http://bugs.java.com/bugdatabase/view_bug.do?bug_id=7044060)
- fixed in Java 6u171, which is only available via Oracle support (http://bugs.java.com/bugdatabase/view_bug.do?bug_id=8182231)