com.dynatrace.openkit.api

Interface Session

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

NullSession, SessionImpl, SessionProxyImpl

public interface Session
extends java.io.Closeable

This interface provides functionality to create Actions in a Session.

Method Summary

Modifier and Type	Method and Description
void	end() Ends this Session and marks it as ready for immediate sending.
RootAction	enterAction(java.lang.String actionName) Enters an Action with a specified name in this Session.
void	identifyUser(java.lang.String userTag) Tags a session with the provided userTag.
void	reportCrash(java.lang.String errorName, java.lang.String reason, java.lang.String stacktrace) Reports a crash with a specified error name, crash reason and a stacktrace.
void	reportCrash(java.lang.Throwable throwable) Reports a crash with error name, crash reason and stacktrace determined from given Throwable.
WebRequestTracer	traceWebRequest(java.lang.String url) Allows tracing and timing of a web request handled by any 3rd party HTTP Client (e.g.
WebRequestTracer	traceWebRequest(java.net.URLConnection connection) Traces a web request - which is provided as a URLConnection - and allows adding timing information to this request.

Methods inherited from interface java.io.Closeable

close

Method Detail

enterAction

RootAction enterAction(java.lang.String actionName)

Enters an Action with a specified name in this Session.

If the given actionName is null or an empty string, no reporting will happen on that RootAction.

Parameters:

actionName - name of the Action

Returns:

Action instance to work with

identifyUser

void identifyUser(java.lang.String userTag)

Tags a session with the provided userTag.

If the given userTag is null or an empty string, this is equivalent to logging off the user.

The last non-empty userTag is re-applied to split sessions. Details are described in https://github.com/Dynatrace/openkit-java/blob/main/docs/internals.md#identify-users-on-split-sessions.

Parameters:

userTag - id of the user or null/"" to simulate a log off.

reportCrash

void reportCrash(java.lang.String errorName,
                 java.lang.String reason,
                 java.lang.String stacktrace)

Reports a crash with a specified error name, crash reason and a stacktrace.

If the given errorName is null or an empty string, no crash report will be sent to the server.

Parameters:

errorName - name of the error leading to the crash (e.g. Exception class)

reason - reason or description of that error

stacktrace - stacktrace leading to that crash

reportCrash

void reportCrash(java.lang.Throwable throwable)

Reports a crash with error name, crash reason and stacktrace determined from given Throwable.

This method is offered as convenience method for reportCrash(Throwable).

Parameters:

throwable - The Throwable causing the crash.

traceWebRequest

WebRequestTracer traceWebRequest(java.net.URLConnection connection)

Traces a web request - which is provided as a URLConnection - and allows adding timing information to this request. If the web request is continued on a server-side Agent (e.g. Java, .NET, ...) this Session will be correlated to the resulting server-side PurePath.

Parameters:

connection - the URLConnection of the HTTP request to be tagged and timed

Returns:

a WebRequestTracer which allows adding timing information

traceWebRequest

WebRequestTracer traceWebRequest(java.lang.String url)

Allows tracing and timing of a web request handled by any 3rd party HTTP Client (e.g. Apache, Google, Jetty, ...). In this case the Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER) has to be set manually to the tag value of this WebRequestTracer.
If the web request is continued on a server-side Agent (e.g. Java, .NET, ...) this Session will be correlated to the resulting server-side PurePath.

Parameters:

url - the URL of the web request to be tagged and timed

Returns:

a WebRequestTracer which allows getting the tag value and adding timing information

end

void end()

Ends this Session and marks it as ready for immediate sending.