Skip to content

Commit ff98205

Browse files
committed
smaller changes in readme
1 parent 1e39878 commit ff98205

File tree

3 files changed

+28
-19
lines changed

3 files changed

+28
-19
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Dynatrace OneAgent SDK for Java
22

33
This SDK allows Dynatrace customers to instrument java applications. This is useful for technologies where no out of the box sensor
4-
is provided or in customer application.
4+
is provided or in customer application are monitored.
55
It provides the java implementation of the [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK).
66

77
## Package contents
88

9-
- samples directory: contains sample application, which demonstrates the usage of the SDK. see readme inside the samples directory for more details
10-
- LICENSE file: license under which the whole SDK and sample applications are published
9+
- `samples`: contains sample application, which demonstrates the usage of the SDK. see readme inside the samples directory for more details
10+
- `LICENSE`: license under which the whole SDK and sample applications are published
11+
12+
## Features
13+
Dynatrace OneAgent SDK for Java adds support for following features (corresponding to features specified in [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK)):
14+
- outgoing and incoming remote call
1115

1216
## Integrating into your application
1317

@@ -36,9 +40,7 @@ As soon as SDK is active, but no paths are shown in Dynatrace UI, enable the age
3640

3741
debugOneAgentSdkJava=true
3842

39-
This will provide additional debug information in agent log.
40-
41-
Additionally ensure, that you have set an `LoggingCallback` in your application. For usage see class `StdErrLoggingCallback` in `remotecall-server` module (in samples/remotecall folder).
43+
This will provide SDK related debug information in agent log. Additionally ensure, that you have set an `LoggingCallback` in your application. For usage see class `StdErrLoggingCallback` in `remotecall-server` module (in samples/remotecall folder).
4244

4345
## OneAgent SDK for Java Requirements
4446

@@ -50,6 +52,11 @@ Additionally ensure, that you have set an `LoggingCallback` in your application.
5052
|:------|:--------|
5153
|1.0.1 |>=1.135 |
5254

55+
## Feedback
56+
57+
In case of questions, issues or feature requests feel free to contact [Michael Kopp](https://github.com/mikopp) or [Alram Lechner](https://github.com/AlramLechnerDynatrace). Your feedback is welcome!
58+
59+
5360
## OneAgent SDK for Java release notes
5461
|Version|Date|Description|
5562
|:------|:----------|:------------------|

samples/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# OneAgent SDK for Java sample applications
1+
# Sample applications for OneAgent SDK for Java
22

3-
Sample applications showing how to use Dynatrace OneAgent SDK for Java to create custom specific PurePaths.
3+
Sample applications showing how to use Dynatrace OneAgent SDK for Java to create custom specific PurePaths and service calls.
44

5-
## contents
5+
## Contents
66

7-
- remotecall shows usage of remote call API. allows you to tag remote calls in same or between different JVM's.
7+
- `remotecall`: shows usage of remote call API. Allows you to tag remote calls in same or between different JVM's.
88

99
## Build and prepare running sample applications
1010

1111
- ensure you have Apache Maven 3.5 installed, see: [Apache Maven](https://maven.apache.org/)
12-
- ensure Dynatrace OneAgent is installed. if not see our [free Trial](https://www.dynatrace.com/)
12+
- ensure Dynatrace OneAgent is installed. If not see our [free Trial](https://www.dynatrace.com/trial/?vehicle_name=https://github.com/Dynatrace/OneAgent-SDK-for-Java)
1313
- clone this repository
1414
- run `mvn package` in root directory of the desired sample
1515

samples/remotecall/parent/pom.xml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,16 @@
3838
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3939
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
4040

41-
<!-- uncomment and edit properties to match your local environment (in case of AppMon only): -->
42-
<!-- <agent.lib>C:\workspaces\ruxit\agent\devenv\build\agent\lib64\oneagentjava.dll</agent.lib> -->
43-
<!-- ensure DT_HOME environment variable is set and points to you AppMon installation directory: -->
44-
<!-- <agent.lib>${env.DT_HOME}\agent\lib64\oneagentloader.dll</agent.lib>
45-
<agent.server>http://localhost:8020</agent.server>
46-
<agent.options>,debugEnableOneAgentSdkJavaNative=true,debugTaggingSdkJava=true</agent.options>
47-
<agent.agentpath>-agentpath:"${agent.lib}=name=SdkSample,server=${agent.server}"${agent.options}</agent.agentpath>
48-
-->
41+
<!-- uncomment and replace url/tenant/token in case of manual agent injection -->
42+
<!--
43+
<agent.lib>path_to_installed_one_agent\agent\lib64\oneagentjava.dll</agent.lib>
44+
<agent.server>https://url.to.tenant.com:443</agent.server>
45+
<agent.tenant>tenantUUID</agent.tenant>
46+
<agent.tenantToken>tenantToken</agent.tenantToken>
47+
<agent.options>,debugOneAgentSdkJava=true</agent.options>
48+
<agent.agentpath>-agentpath:"${agent.lib}=name=SdkSample,server=${agent.server}"${agent.options},tenant=${agent.tenant},tenantToken=${agent.tenantToken}</agent.agentpath>
49+
-->
50+
4951
</properties>
5052

5153
</project>

0 commit comments

Comments
 (0)