Skip to content

Commit a0a8390

Browse files
author
Sonja Chèvre
authored
Update README.md
1 parent 5f997eb commit a0a8390

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,11 @@ This is the official Java implementation of the [Dynatrace OneAgent SDK](https:/
1717
- JRE 1.6 or higher
1818
- Dynatrace OneAgent (required versions see below)
1919

20-
|OneAgent SDK for Java|Dynatrace OneAgent Java|
20+
|OneAgent SDK for Java|Required OneAgent version|
2121
|:------|:--------|
2222
|1.1.0 |>=1.143 |
2323
|1.0.3 |>=1.135 |
2424

25-
26-
## Features
27-
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)):
28-
- outgoing and incoming remote calls
29-
3025
## Integrating into your application
3126

3227
### Dependencies
@@ -51,12 +46,11 @@ If the SDK can't connect to the OneAgent (see usage of SDKState in samples) or y
5146
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).
5247

5348

54-
55-
# API Concepts
49+
## API Concepts
5650

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

59-
## Get an Api object
53+
### Get an Api object
6054

6155
Use OneAgentSDKFactory.createInstance() to obtain an OneAgentSDK instance. You should reuse this object over the whole application
6256
and if possible JVM lifetime:
@@ -77,7 +71,7 @@ default:
7771

7872
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).
7973

80-
## Common concepts: Tracers
74+
### Common concepts: Tracers
8175

8276
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.
8377

@@ -91,7 +85,12 @@ void end();
9185
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.
9286

9387

94-
## Trace incoming and outgoing remote calls
88+
## Features
89+
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)):
90+
- outgoing and incoming remote calls
91+
92+
93+
### Trace incoming and outgoing remote calls
9594

9695
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.
9796

@@ -129,7 +128,7 @@ try {
129128
}
130129
```
131130

132-
## Link in process
131+
### In process linking
133132

134133
You can use the SDK to link inside a single process. To link for eg. an asynchronous execution, you need the following code:
135134
```Java
@@ -153,13 +152,14 @@ try {
153152
}
154153
```
155154

155+
## Further readings
156156

157157

158-
## Feedback
158+
## Help & Support
159159

160160
In case of questions, issues or feature requests feel free to contact the maintainer by dynatrace.oneagent.sdk(at)dynatrace(dot)com or file an issue. Your feedback is welcome!
161161

162-
## OneAgent SDK for Java release notes
162+
## Release notes
163163
|Version|Description|Links|
164164
|:------|:--------------------------------------|:----------------------------------------|
165165
|1.1.0 |Added support for in-process-linking |[binary](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.1.0/oneagent-sdk-1.1.0.jar) [source](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.0.3/oneagent-sdk-1.0.3-sources.jar) [javadoc](https://search.maven.org/remotecontent?filepath=com/dynatrace/oneagent/sdk/java/oneagent-sdk/1.0.3/oneagent-sdk-1.1.0-javadoc.jar)|

0 commit comments

Comments
 (0)