com.dynatrace.oneagent.sdk.api
Interface OneAgentSDK

public interface OneAgentSDK

Root interface contains provided Agent SDK API calls. Basically the whole API is designed according to following rules:

• API calls never throw any exception
• API calls never return null values. e. g. they returning NOOP Objects in case of any issue or required parameters are null.

Single API calls might differ from that rules. Those rules are explicitly documented.

Method Summary

InProcessLink	createInProcessLink() Creates a link for in-process-linking.
SDKState	getCurrentState() Returns the current SDKState.
void	setLoggingCallback(LoggingCallback loggingCallback) Installs a callback that gets informed, if any SDK action has failed.
IncomingRemoteCallTracer	traceIncomingRemoteCall(java.lang.String serviceMethod, java.lang.String serviceName, java.lang.String serviceEndpoint) Traces an incoming remote call.
InProcessLinkTracer	traceInProcessLink(InProcessLink inProcessLink) Traces the start of in-process-linking.
OutgoingRemoteCallTracer	traceOutgoingRemoteCall(java.lang.String serviceMethod, java.lang.String serviceName, java.lang.String serviceEndpoint, ChannelType channelType, java.lang.String channelEndpoint) Traces an outgoing remote call.

Method Detail

traceIncomingRemoteCall

IncomingRemoteCallTracer traceIncomingRemoteCall(java.lang.String serviceMethod,
                                                 java.lang.String serviceName,
                                                 java.lang.String serviceEndpoint)

Traces an incoming remote call.

Parameters:

serviceMethod - name of the called remote method. (required)

serviceName - name of the remote service. (required)

serviceEndpoint - endpoint on the server side. (required)

Returns:

IncomingRemoteCallTracer instance to work with

Since:

1.0

traceOutgoingRemoteCall

OutgoingRemoteCallTracer traceOutgoingRemoteCall(java.lang.String serviceMethod,
                                                 java.lang.String serviceName,
                                                 java.lang.String serviceEndpoint,
                                                 ChannelType channelType,
                                                 java.lang.String channelEndpoint)

Traces an outgoing remote call.

Parameters:

serviceMethod - name of the called remote method. (required)

serviceName - name of the remote service. (required)

serviceEndpoint - endpoint on the server side. (required)

channelType - communication protocol used by remote call. See ChannelType for available types. (required)

channelEndpoint - optional and depending on channelType:

• for TCP/IP: host name/IP of the server-side (can include port)
• for UNIX domain sockets: path of domain socket file
• for named pipes: name of pipe

Returns:

OutgoingRemoteCallTracer instance to work with

Since:

1.0

createInProcessLink

InProcessLink createInProcessLink()

Creates a link for in-process-linking.

Returns:

InProcessLink instance to work with. Use it with traceInProcessLink(InProcessLink)

Since:

1.1

traceInProcessLink

InProcessLinkTracer traceInProcessLink(InProcessLink inProcessLink)

Traces the start of in-process-linking.

Parameters:

inProcessLink - a InProcessLink received via createInProcessLink()

Returns:

InProcessLinkTracer to work with.

Since:

1.1

setLoggingCallback

void setLoggingCallback(LoggingCallback loggingCallback)

Installs a callback that gets informed, if any SDK action has failed. For details see LoggingCallback interface. The provided callback must be thread-safe, when using this OneAgentSDK instance in multi-threaded environments.

Parameters:

loggingCallback - may be null, to remove current callback. provided callback replaces any previously set callback.

Since:

1.0

getCurrentState

SDKState getCurrentState()

Returns the current SDKState. See SDKState for details.

Returns:

current state - never null.

Since:

1.0