Skip to content

Commit 1651cd2

Browse files
author
Sonja Chèvre
authored
Update README.md
1 parent 7f86c25 commit 1651cd2

File tree

1 file changed

+45
-3
lines changed

1 file changed

+45
-3
lines changed

README.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,33 @@ This SDK allows Dynatrace customers to instrument java applications. This is use
66

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

9+
#### Table of Contents
10+
11+
* [Package contents](#package)
12+
* [Requirements](#requirements)
13+
* [Integration](#integration)
14+
* [Dependencies](#dependencies)
15+
* [Troubleshooting](#troubleshooting)
16+
* [API Concepts](#apiconcepts)
17+
* [OneAgentSDK object](#oneagentsdkobject)
18+
* [Tracers](#tracers)
19+
* [Features](#features)
20+
* [Trace incoming and outgoing remote calls](#remoting)
21+
* [In process linking](#inprocess)
22+
* [Further reading](#furtherreading)
23+
* [Help & Support](#help)
24+
* [Release notes](#releasenotes)
25+
26+
<a name="package" />
27+
928
## Package contents
1029

1130
- `samples`: contains sample application, which demonstrates the usage of the SDK. see readme inside the samples directory for more details
1231
- `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/).
1332
- `LICENSE`: license under which the whole SDK and sample applications are published
1433

34+
<a name="requirements" />
35+
1536
## Requirements
1637

1738
- JRE 1.6 or higher
@@ -22,7 +43,11 @@ This is the official Java implementation of the [Dynatrace OneAgent SDK](https:/
2243
|1.1.0 |>=1.143 |
2344
|1.0.3 |>=1.135 |
2445

25-
## Integrating into your application
46+
<a name="integration" />
47+
48+
## Integration
49+
50+
<a name="dependencies" />
2651

2752
### Dependencies
2853
If you want to integrate the OneAgent SDK into your application, just add the following maven dependency:
@@ -38,19 +63,24 @@ If you prefer to integrate the SDK using plain jar file, just download them from
3863

3964
The Dynatrace OneAgent SDK for Java has no further dependencies.
4065

66+
<a name="troubleshooting" />
67+
4168
### Troubleshooting
4269
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:
4370

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

4673
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).
4774

75+
<a name="apiconcepts" />
4876

4977
## API Concepts
5078

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

53-
### Get an Api object
81+
<a name="oneagentsdkobject" />
82+
83+
### OneAgentSDK object
5484

5585
Use OneAgentSDKFactory.createInstance() to obtain an OneAgentSDK instance. You should reuse this object over the whole application
5686
and if possible JVM lifetime:
@@ -71,7 +101,9 @@ default:
71101

72102
It is good practice to check the SDK state regularly as it may change at every point of time (except PERMANENTLY_INACTIVE never changes over JVM lifetime).
73103

74-
### Common concepts: Tracers
104+
<a name="tracers" />
105+
106+
### Tracers
75107

76108
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 (duraction, 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.
77109

@@ -84,11 +116,13 @@ void end();
84116
```
85117
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 yourselfs.
86118

119+
<a name="features" />
87120

88121
## Features
89122
Dynatrace OneAgent SDK for Java currently implements support for the following features (corresponding to features specified in [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK)):
90123
- outgoing and incoming remote calls
91124

125+
<a name="remoting" />
92126

93127
### Trace incoming and outgoing remote calls
94128

@@ -128,6 +162,8 @@ try {
128162
}
129163
```
130164

165+
<a name="inprocess" />
166+
131167
### In process linking
132168

133169
You can use the SDK to link inside a single process. To link for eg. an asynchronous execution, you need the following code:
@@ -152,16 +188,22 @@ try {
152188
}
153189
```
154190

191+
<a name="furtherreading" />
192+
155193
## Further readings
156194

157195
* <a href="https://www.dynatrace.com/support/help/extend-dynatrace/oneagent-sdk/what-is-oneagent-sdk/" target="_blank">What is the OneAgent SDK?</a> in the Dynatrace documentation
158196
* <a href="https://answers.dynatrace.com/spaces/483/dynatrace-product-ideas/idea/198106/planned-features-for-oneagent-sdk.html" target="_blank">Feedback & Roadmap thread in AnswerHub</a>
159197
* <a href="https://www.dynatrace.com/news/blog/dynatrace-oneagent-sdk-for-java-end-to-end-monitoring-for-proprietary-java-frameworks/" target="_blank">Blog: Dynatrace OneAgent SDK for Java: End-to-end monitoring for proprietary Java frameworks</a>
160198

199+
<a name="help" />
200+
161201
## Help & Support
162202

163203
The Dynatrace OneAgent SDK is an open source project, in beta status. Feedback and feature requests can be filed directly on GitHub or on the <a href="https://answers.dynatrace.com/spaces/483/dynatrace-product-ideas/idea/198106/planned-features-for-oneagent-sdk.html" target="_blank">Feedback & Roadmap thread in AnswerHub</a>.
164204

205+
<a name="releasenotes" />
206+
165207
## Release notes
166208
|Version|Description|Links|
167209
|:------|:--------------------------------------|:----------------------------------------|

0 commit comments

Comments
 (0)