Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/dynatrace/oneagent-sdk-for-java

Enables custom tracing of Java applications in Dynatrace
https://github.com/dynatrace/oneagent-sdk-for-java

agent apm data-ingestion dev-program dynatrace oneagent sdk sdk-java

Last synced: about 1 month ago
JSON representation

Enables custom tracing of Java applications in Dynatrace

Awesome Lists containing this project

README 

        
# Dynatrace OneAgent SDK for Java



This SDK allows Dynatrace customers to instrument java applications. This is useful to enhance the visibility for proprietary frameworks or

custom frameworks not directly supported by Dynatrace OneAgent out-of-the-box.



This is the official Java implementation of the [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK).



## Table of Contents



* [Package contents](#package-contents)

* [Requirements](#requirements)

* [Integration](#integration)

  * [Dependencies](#dependencies)

  * [Troubleshooting](#troubleshooting)

* [API concepts](#api-concepts)

  * [OneAgentSDK object](#oneagentsdk-object)

  * [Trace Context](#tracecontext)

  * [Tracers](#tracers)

* [Features](#features)

  * [Trace incoming and outgoing remote calls](#trace-incoming-and-outgoing-remote-calls)

  * [In process linking](#in-process-linking)

  * [Add custom request attributes](#add-custom-request-attributes)

  * [Custom services](#custom-services)

  * [Trace web requests](#trace-web-requests)

    * [Trace incoming web requests](#trace-incoming-web-requests)

    * [Trace outgoing web requests](#trace-outgoing-web-requests)

  * [Trace messaging](#trace-messaging)

  * [Trace SQL database requests](#trace-sql-database-requests)

* [Further reading](#further-reading)

* [Help & support](#help-&-support)

* [Release notes](#release-notes)



## Package contents



* `samples`: contains sample application, which demonstrates the usage of the SDK. See readme inside the samples directory for more details.

* `docs`: contains the reference documentation (javadoc). The most recent version is also available online at [https://dynatrace.github.io/OneAgent-SDK-for-Java/](https://dynatrace.github.io/OneAgent-SDK-for-Java/).

* `LICENSE`: license under which the whole SDK and sample applications are published.



## Requirements



* An JRE that is both supported with a supported version of OneAgent and at least JRE 1.6-compatible.

* Dynatrace OneAgent (for required versions, see table below)

* The OneAgent SDK is not supported on serverless code modules, including those for AWS Lambda.

  Consider using [OpenTelemetry](https://www.dynatrace.com/support/help/shortlink/opentel-lambda)

  instead in these scenarios.



|OneAgent SDK for Java|Required OneAgent version|Support status|

|:--------------------|:------------------------|:-------------|

|1.9.0                |>=1.261                  |Supported     |

|1.8.0                |>=1.201                  |Supported     |

|1.7.0                |>=1.167                  |Deprecated with support ending 2023-09-01 |

|1.6.0                |>=1.161                  |Deprecated with support ending 2023-09-01 |

|1.4.0                |>=1.151                  |Deprecated with support ending 2023-09-01 |

|1.3.0                |>=1.149                  |Deprecated with support ending 2023-09-01 |

|1.2.0                |>=1.147                  |Deprecated with support ending 2023-09-01 |

|1.1.0                |>=1.143                  |Deprecated with support ending 2023-09-01 |

|1.0.3                |>=1.135                  |Deprecated with support ending 2023-09-01 |



## Integration



### Dependencies



If you want to integrate the OneAgent SDK into your application, just add the following Maven dependency:



```xml



  com.dynatrace.oneagent.sdk.java

  oneagent-sdk

  1.9.0

  compile



```



If you prefer to integrate the SDK using plain jar file, just download them from Maven Central, e.g. from

.



The Dynatrace OneAgent SDK for Java has no further dependencies.



### Troubleshooting



If the SDK can't connect to the OneAgent (see usage of SDKState in samples) or you you don't see the desired result in the Dynatrace UI,

you can set the following system property to print debug information to standard out:



```java

-Dcom.dynatrace.oneagent.sdk.debug=true

```



Additionally you should/have to ensure, that you have set a `LoggingCallback`. For usage see class `StdErrLoggingCallback` in

`remotecall-server` module (in samples/remotecall folder).



## API concepts



Common concepts of the Dynatrace OneAgent SDK are explained in the [Dynatrace OneAgent SDK repository](https://github.com/Dynatrace/OneAgent-SDK#apiconcepts).



### OneAgentSDK object



Use OneAgentSDKFactory.createInstance() to obtain an OneAgentSDK instance. You should reuse this object throughout the whole application

and, if possible, JVM lifetime:



```Java

OneAgentSDK oneAgentSdk = OneAgentSDKFactory.createInstance();

switch (oneAgentSdk.getCurrentState()) {

case ACTIVE:

  break;

case PERMANENTLY_INACTIVE:

  break;

case TEMPORARILY_INACTIVE:

  break;

default:

  break;

}

```



It is good practice to check the SDK state regularly as it may change at any point in time (except for PERMANENTLY_INACTIVE, which never

changes throughout the JVM lifetime).






## Trace Context



An instance of the `OneAgentSDK` can be used to get the current `ITraceContextInfo` which holds information

about the *Trace-Id* and *Span-Id* of the current PurePath node.

This information can then be used to provide e.g. additional context in log messages.



Please note that `TraceContextInfo` is not intended for tagging or context-propagation use cases.

Dedicated APIs (e.g. [remote calls](#remoting) or [web requests](#webrequests)) as well as

built-in OneAgent sensors take care of linking services correctly.



```Java

TraceContextInfo traceContextInfo = oneAgentSdk.getTraceContextInfo();

String traceId = traceContextInfo.getTraceId();

String spanId = traceContextInfo.getSpanId();

System.out.printf("[!dt dt.trace_id=%s,dt.span_id=%s] sending request... have trace ctx: %s%n",

traceId, spanId, traceContextInfo.isValid());

```



### Tracers



To trace any kind of call you first need to create a Tracer. The Tracer object represents the logical and physical endpoint that

you want to call. A Tracer serves two purposes. First, to time the call (duration, cpu and more) and report errors. That is why

each Tracer has these three methods. The error method must be called only once, and it must be in between start and end.



A Tracer instance can only be used from the thread on which it was created.

See [in process linking](#in-process-linking) for tracing across thread boundaries, and see further below in this section

for how to cross process boundaries.



```Java

void start();



void error(String message);



void end();

```



`start()` records the active PurePath node on the current Java thread

as parent (if any; whether created by another Tracer or the OneAgent), creates a new PurePath node

and sets the new one as the currently active one. The OneAgent also requires that a child node ends

before all parent nodes (Stated another way, tracers on the same thread must be ended in the opposite

order of how they were started. While this may sound odd if you hear it the first time, it corresponds

to the most natural usage pattern and you usually don't even need to think about it).



While the tracer's automatic parent-child relationship works very intuitively in most cases,

it does not work with **asynchronous patterns**, where the same thread handles multiple logically

separate operations in an interleaved way on the same Java thread. If you need to instrument

such patterns, it is recommended to use the OneAgent's [OpenTelemetry interoperability][oa-otel].



[oa-otel]: https://www.dynatrace.com/support/help/shortlink/opent-java



The second purpose of a Tracer is to allow tracing across process boundaries. To achieve that these kind of traces supply so called

tags. Tags are strings or byte arrays that enable Dynatrace to trace a transaction end to end. As such the tag is the one information

that you need to transport across these calls as an SDK user.



## Features



The feature sets differ slightly with each language implementation. More functionality will be added over time, see Planned features for OneAgent SDK

for details on upcoming features.



A more detailed specification of the features can be found in [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK#features).



|Feature                                        |Required OneAgent SDK for Java version|

|:----------------------------------------------|:-------------------------------------|

|Trace context for log enrichment               |>=1.9.0                               |

|Custom services                                |>=1.8.0                               |

|Trace database requests                        |>=1.7.0                               |

|Trace messaging                                |>=1.6.0                               |

|Outgoing web requests                          |>=1.4.0                               |

|Incoming web requests                          |>=1.3.0                               |

|Custom request attributes                      |>=1.2.0                               |

|In process linking                             |>=1.1.0                               |

|Trace incoming and outgoing remote calls       |>=1.0.3                               |






### Trace incoming and outgoing remote calls



You can use the SDK to trace proprietary IPC communication from one process to the other. This will enable you to see full Service Flow, PurePath

and Smartscape topology for remoting technologies that Dynatrace is not aware of.



To trace any kind of remote call you first need to create a Tracer. The Tracer object represents the endpoint that you want to call, as such you

need to supply the name of the remote service and remote method. In addition you need to transport the tag in your remote call to the server side

if you want to trace it end to end.



```Java

OneAgentSDK oneAgentSdk = OneAgentSDKFactory.createInstance();

OutgoingRemoteCallTracer outgoingRemoteCall = oneAgentSdk.traceOutgoingRemoteCall("remoteMethodToCall", "RemoteServiceName", "rmi://Endpoint/service", ChannelType.TCP_IP, "remoteHost:1234");

outgoingRemoteCall.setProtocolName("RMI/custom");

outgoingRemoteCall.start();

try {

	String tag = outgoingRemoteCall.getDynatraceStringTag();

	// make the call and transport the tag across to server

} catch (Throwable e) {

	outgoingRemoteCall.error(e);

	// rethrow or add your exception handling

} finally {

	outgoingRemoteCall.end();

}

```



On the server side you need to wrap the handling and processing of your remote call as well. This will not only trace the server side call and

everything that happens, it will also connect it to the calling side.



```Java

OneAgentSDK oneAgentSdk = OneAgentSDKFactory.createInstance();

IncomingRemoteCallTracer incomingRemoteCall = oneAgentSdk.traceIncomingRemoteCall("remoteMethodToCall", "RemoteServiceName", "rmi://Endpoint/service");

incomingRemoteCall.setDynatraceStringTag(tag);

incomingRemoteCall.start();

try {

	incomingRemoteCall.setProtocolName("RMI/custom");

	doSomeWork(); // process the remoteCall

} catch (Exception e) {

	incomingRemoteCall.error(e);

	// rethrow or add your exception handling

} finally{

	incomingRemoteCall.end();

}

```



### In process linking



You can use the SDK to link inside a single process. To link for eg. an asynchronous execution, you need the following code:



```Java

OneAgentSDK oneAgentSdk = OneAgentSDKFactory.createInstance();

InProcessLink inProcessLink = oneAgentSdk.createInProcessLink();

```



Provide the returned ``inProcessLink`` to the code, that does the asynchronous execution:



```Java

OneAgentSDK oneAgentSdk = OneAgentSDKFactory.createInstance();

InProcessLinkTracer inProcessLinkTracer = oneAgentSdk.traceInProcessLink(inProcessLink);

inProcessLinkTracer.start();

try {

	// do the work ...

} catch (Exception e) {

	inProcessLinkTracer.error(e);

	// rethrow or add your exception handling

} finally {

	inProcessLinkTracer.end();

}

```



### Add custom request attributes



You can use the SDK to add custom request attributes to the current traced service. Custom request attributes allow you to do advanced filtering of

your requests in Dynatrace.



Adding custom request attributes to the currently traced service call is simple. Just call one of the addCustomRequestAttribute methods with your key and value:



```Java

oneAgentSDK.addCustomRequestAttribute("region", "EMEA");

oneAgentSDK.addCustomRequestAttribute("salesAmount", 2500);

```



When no service call is being traced, the custom request attributes are dropped.



### Custom services



You can use the SDK to trace custom service methods. A custom service method is a meaningful

part of your code that you want to trace but that does not fit any other tracer.

An example could be the callback of a periodic timer.



```Java

String serviceMethod = "onTimer";

String serviceName = "PeriodicCleanupTask";

CustomServiceTracer tracer = oneAgentSDK.traceCustomService(serviceMethod, serviceName);

tracer.start();

try {

	doMyCleanup();

} catch (Exception e) {

	tracer.error(e.getMessage());

	throw e;

} finally {

	tracer.end();

}

```






### Trace web requests



#### Trace incoming web requests



You can use the SDK to trace incoming web requests. This might be useful if Dynatrace does not support the respective web server framework or language

processing the incoming web requests.



To trace an incoming web request you first need to create a WebApplicationInfo object. The info object represents the endpoint of your web server (web server name, application name and context root). This object should be reused for all traced web requests within for the same application.



```Java

WebApplicationInfo wsInfo = oneAgentSdk.createWebApplicationInfo("WebShopProduction", "CheckoutService", "/api/service/checkout");

```



To trace a specific incoming web request you then need to create a Tracer object. Make sure you provide all http headers from the request to the SDK by

calling addRequestHeader(...). This ensures that tagging with our built-in sensor will work, but note that only the proprietary x-dynatrace header

will be processed (meaning, W3C trace context is not supported for tracing with the OneAgent SDKs, use OpenTelemetry instead if you require this).



```Java

IncomingWebRequestTracer tracer = oneAgentSdk.traceIncomingWebRequest(wsInfo,"https://www.oursupershop.com/api/service/checkout/save", "POST")



for (Entry headerField : httpRequest.getHeaders().entrySet()) {

	tracer.addRequestHeader(headerField.getKey(), headerField.getValue());

}



for (Entry> parameterEntry : httpRequest.getParameters().entrySet()) {

	for (String value : parameterEntry.getValue()) {

		tracer.addParameter(parameterEntry.getKey(), value);

	}

}



tracer.setRemoteAddress(httpRequest.getRemoteHostName());



tracer.start();

try {

	int statusCodeReturnedToClient = processWebRequest();

	tracer.setStatusCode(statusCodeReturnedToClient);

} catch (Exception e) {

	tracer.setStatusCode(500); // we expect that the container sends HTTP 500 status code in case request processing throws an exception

	tracer.error(e);

	throw e;

} finally {

	tracer.end();

}

```



#### Trace outgoing web requests



You can use the SDK to trace outgoing web requests. This might be useful if Dynatrace does not support the respective http library or

language sending the request.



To trace an outgoing web request you need to create a Tracer object. It is important to send the Dynatrace Header. This ensures that

tagging with our built-in sensor will work.



```Java

OutgoingWebRequestTracer outgoingWebRequestTracer = oneAgentSdk.traceOutgoingWebRequest(url, "GET");



// provide all request headers to outgoingWebRequestTracer (optional):

for (Entry entry : yourHttpClient.getRequestHeaders().entrySet()) {

	outgoingWebRequestTracer.addRequestHeader(entry.getKey(), entry.getValue());

}



outgoingWebRequestTracer.start();

try {

	yourHttpClient.setUrl(url);



	// sending HTTP header OneAgentSDK.DYNATRACE_HTTP_HEADERNAME is necessary for tagging:

	yourHttpClient.addRequestHeader(OneAgentSDK.DYNATRACE_HTTP_HEADERNAME, outgoingWebRequestTracer.getDynatraceStringTag());



	yourHttpClient.processHttpRequest();



	for (Entry> entry : yourHttpClient.getHeaderFields().entrySet()) {

		for (String value : entry.getValue()) {

			outgoingWebRequestTracer.addResponseHeader(entry.getKey(), value);

		}

	}

	outgoingWebRequestTracer.setStatusCode(yourHttpClient.getResponseCode());



} catch (Exception e) {

	outgoingWebRequestTracer.error(e);

	// rethrow or add your exception handling

} finally {

	outgoingWebRequestTracer.end();

}

```



### Trace messaging



You can use the SDK to trace messages sent or received via messaging & queuing systems. When tracing messages, we distinguish between:



* sending a message

* receiving a message

* processing a received message



To trace an outgoing message, you simply need to create a MessagingSystemInfo and call traceOutgoingMessage with that instance:



```Java

MessagingSystemInfo messagingSystemInfo = oneAgentSDK.createMessagingSystemInfo("myMessagingSystem",

		"requestQueue", MessageDestinationType.QUEUE, ChannelType.TCP_IP, "localhost:4711");

OutgoingMessageTracer outgoingMessageTracer = oneAgentSDK.traceOutgoingMessage(messagingSystemInfo);

outgoingMessageTracer.start();

try {

	// transport the dynatrace tag along with the message: 	

	messageToSend.setHeaderField(

		OneAgentSDK.DYNATRACE_MESSAGE_PROPERTYNAME, outgoingMessageTracer.getDynatraceStringTag());

	// optional:  add application provided correlationId

	outgoingMessageTracer.setCorrelationId(toSend.correlationId);



	theQueue.send(messageToSend);



	// optional:  add messageid provided from messaging system

	outgoingMessageTracer.setVendorMessageId(toSend.getMessageId());

} catch (Exception e) {

	outgoingMessageTracer.error(e.getMessage());

	// rethrow or add your exception handling

} finally {

	outgoingMessageTracer.end();

}

```



On the incoming side, we need to differentiate between the blocking receiving part and processing the received message. Therefore two

different tracers are being used: `IncomingMessageReceiveTracer` and `IncomingMessageProcessTracer`.



```Java

MessagingSystemInfo messagingSystemInfo = oneAgentSDK.createMessagingSystemInfo("myMessagingSystem",

		"requestQueue", MessageDestinationType.QUEUE, ChannelType.TCP_IP, "localhost:4711");



// message receiving daemon task:

while(true) {

	IncomingMessageReceiveTracer incomingMessageReceiveTracer =

		oneAgentSDK.traceIncomingMessageReceive(messagingSystemInfo);

	incomingMessageReceiveTracer.start();

	try {

		// blocking call - until message is being available:

		Message queryMessage = theQueue.receive("client queries");

		IncomingMessageProcessTracer incomingMessageProcessTracer = oneAgentSDK

			.traceIncomingMessageProcess(messagingSystemInfo);

		incomingMessageProcessTracer.setDynatraceStringTag(

			queryMessage.getHeaderField(OneAgentSDK.DYNATRACE_MESSAGE_PROPERTYNAME));

		incomingMessageProcessTracer.setVendorMessageId(queryMessage.msgId);

		incomingMessageProcessTracer.setCorrelationId(queryMessage.correlationId);

		incomingMessageProcessTracer.start();

		try {

			// do the work ...

		} catch (Exception e) {

			incomingMessageProcessTracer.error(e.getMessage());

			Logger.logError(e);

		} finally {

			incomingMessageProcessTracer.end();

		}

	} catch (Exception e) {

		incomingMessageReceiveTracer.error(e.getMessage());

		// rethrow or add your exception handling

	} finally {

		incomingMessageReceiveTracer.end();

	}

}

```



In case of non-blocking receive (e. g. via event handler), there is no need to use `IncomingMessageReceiveTracer` - just trace processing

of the message by using the `IncomingMessageProcessTracer`:



```Java

MessagingSystemInfo messagingSystemInfo = oneAgentSDK.createMessagingSystemInfo("myMessagingSystem",

	"requestQueue", MessageDestinationType.QUEUE, ChannelType.TCP_IP, "localhost:4711");



public void onMessage(Message message) {

	IncomingMessageProcessTracer incomingMessageProcessTracer = oneAgentSDK

		.traceIncomingMessageProcess(messagingSystemInfo);

	incomingMessageProcessTracer.setDynatraceStringTag((String)

		message.getObjectProperty(OneAgentSDK.DYNATRACE_MESSAGE_PROPERTYNAME));

	incomingMessageProcessTracer.setVendorMessageId(queryMessage.msgId);

	incomingMessageProcessTracer.setCorrelationId(queryMessage.correlationId);

	incomingMessageProcessTracer.start();

	try {

		// do the work ...

	} catch (Exception e) {

		incomingMessageProcessTracer.error(e.getMessage());

		// rethrow or add your exception handling

	} finally {

		incomingMessageProcessTracer.end();

	}

}

```



> Please also see the [documentation on messaging tracers in the specification repository](https://github.com/Dynatrace/OneAgent-SDK#messaging).



### Trace SQL database requests



A SQL database request is traced by calling `traceSqlDatabaseRequest`. For details about usage see the [OneAgentSDK specification](https://github.com/Dynatrace/OneAgent-SDK#database)



```java

String sql = "SELECT * FROM transformationdata WHERE transformation_id = " + id;



DatabaseInfo databaseInfo = oneAgentSdk.createDatabaseInfo("TransformationDb", DatabaseVendor.FIREBIRD.getVendorName(), ChannelType.TCP_IP, "db-serv01.acme.com:2323");



DatabaseRequestTracer databaseTracer = oneAgentSdk.traceSqlDatabaseRequest(databaseInfo, sql);

databaseTracer.start();

try {

	Result result = executeTheDatabaseCall(sql);

	databaseTracer.setReturnedRowCount(result.getRows().getLength());

} catch (InterruptedException e) {

	databaseTracer.error(e);

    // handle or rethrow

} finally {

	databaseTracer.end();

}

```



Please note that SQL database traces are only created if they occur within some other SDK trace (e.g. incoming remote call)

or a OneAgent built-in trace (e.g. incoming web request).



## Further reading



* What is the OneAgent SDK? in the Dynatrace documentation

* Feedback & Roadmap thread in AnswerHub

* Blog: Dynatrace OneAgent SDK for Java: End-to-end monitoring for proprietary Java frameworks



## Help & support



### Support policy



The Dynatrace OneAgent SDK for Java has GA status. The features are fully supported by Dynatrace.



For detailed support policy see [Dynatrace OneAgent SDK help](https://github.com/Dynatrace/OneAgent-SDK#help).



### Get help



* Ask a question in the product forums

* Read the product documentation



**Open a GitHub issue to:**



* Report minor defects, minor items or typos

* Ask for improvements or changes in the SDK API

* Ask any questions related to the community effort



SLAs don't apply for GitHub tickets



**Customers can open a ticket on the Dynatrace support portal to:**



* Get support from the Dynatrace technical support engineering team

* Manage and resolve product related technical issues



SLAs apply according to the customer's support level.



## Release notes



### Version 1.9.0



* [Add support to retrieve W3C trace context information for log enrichment.](#tracecontext)



### Other announcements



* ⚠️ **Deprecation announcement for older SDK versions:** Version 1.7 and all older versions have been put on the path to deprecation and will no longer be supported starting September 1, 2023. We advise customers to upgrade to newest version. Customers need to upgrade to at least 1.8 but are encouraged to upgrade to the newest available version (1.9).



### Older versions



See  for older release notes.