open-telemetry
/
opentelemetry-java-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-java-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Simplify getting started (#533)

This commit is contained in:
Trask Stalnaker 2020-06-16 11:44:07 -07:00 committed by GitHub
parent a59bb19192
commit 64e39f064d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -18,16 +18,15 @@ data from a Java application without code changes.
## Getting Started ## Getting Started
[ ![Download](https://api.bintray.com/packages/open-telemetry/maven/opentelemetry-java-instrumentation/images/download.svg) ](https://bintray.com/open-telemetry/maven/opentelemetry-java-instrumentation/_latestVersion) Download the [latest version](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-auto-all.jar).
The easiest way to start is to download "all-in" package, which includes instrumentation agent, This package includes the instrumentation agent,
instrumentations for all supported libraries and all available data exporters. instrumentations for all supported libraries and all available data exporters.
This provides completely automatic out of the box experience. This provides completely automatic out of the box experience.
TODO add here screenshot from Bintray download list.
The instrumentation agent is enabled using the `-javaagent` flag to the JVM. The instrumentation agent is enabled using the `-javaagent` flag to the JVM.
``` ```
java -javaagent:path/to/opentelemetry-auto-<version>-all.jar \ java -javaagent:path/to/opentelemetry-auto-all.jar \
-jar myapp.jar -jar myapp.jar
``` ```
By default OpenTelemetry Java agent uses By default OpenTelemetry Java agent uses
@ -39,7 +38,7 @@ at `localhost:55680`.
Configuration parameters are passed as Java system properties (`-D` flags) or Configuration parameters are passed as Java system properties (`-D` flags) or
as environment variables (see below for full list). For example: as environment variables (see below for full list). For example:
``` ```
java -javaagent:path/to/opentelemetry-auto-<version>-all.jar \ java -javaagent:path/to/opentelemetry-auto-all.jar \
-Dota.exporter=zipkin -Dota.exporter=zipkin
-jar myapp.jar -jar myapp.jar
``` ```