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

A few README updates (#292) 

* A few README updates

* Add OTLP exporter to README
This commit is contained in:
Trask Stalnaker 2020-03-29 21:23:14 -07:00 committed by GitHub
parent f0354033b2
commit 2b500788f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,12 +1,8 @@
# OpenTelemetry Auto-Instrumentation for Java
## Notice - Work in Progress!
*This project is still in the early phases of development and is not yet stable.* You are welcome to experiment with it,
but we strongly discourage any production use!
## Introduction
This project uses a technique known as bytecode instrumentation to add tracing to a Java application.
Simply put, we provide a Java agent that can be attached to any Java 7+ application and dynamically adds code to enable tracing.
This project provides a Java agent that can be attached to any Java 7+ application and dynamically injects bytecode
to capture telemetry from a number of popular libraries and frameworks.
## Supported Java libraries and frameworks
@ -60,11 +56,6 @@ Simply put, we provide a Java agent that can be attached to any Java 7+ applicat
| [Spymemcached](https://github.com/couchbase/spymemcached) | 2.12+ |
| [Twilio](https://github.com/twilio/twilio-java) | 6.6+ |
## Using the agent
As mentioned above, this project is in a very early phase of development and not yet stable.
However, you can try it on your Java application by following these instructions.
### Download and run
Download the [latest release](https://github.com/open-telemetry/opentelemetry-auto-instr-java/releases).
@ -86,23 +77,31 @@ java -javaagent:path/to/opentelemetry-auto-<version>.jar \
| ota.exporter.jar | OTA_EXPORTER_JAR | Path to the exporter fat-jar that you want to use |
### Available exporters
Currently two exporters are available and bundled with this project. They area available under the ```exporter-adapters``` directory.
There are three exporters available under
[releases](https://github.com/open-telemetry/opentelemetry-auto-instr-java/releases).
#### Jaeger exporter
A simple wrapper for the Jaeger exporter of opentelemetry-java. It currently only supports gRPC as its communications protocol.
| System property | Environment variable | Purpose |
|----------------------------------|----------------------------------|----------------------------------------------------------------------|
| ota.exporter.jaeger.host | OTA_EXPORTER_JAEGER_ENDPOINT | The Jaeger endpoint to connect to. Currently only gRPC is supported. |
| ota.exporter.jaeger.endpoint | OTA_EXPORTER_JAEGER_ENDPOINT | The Jaeger endpoint to connect to. Currently only gRPC is supported. |
| ota.exporter.jaeger.service.name | OTA_EXPORTER_JAEGER_SERVICE_NAME | The service name of this JVM instance |
#### OTLP exporter
A simple wrapper for the OTLP exporter of opentelemetry-java.
| System property | Environment variable | Purpose |
|----------------------------------|----------------------------------|----------------------------------------------------------------------|
| ota.exporter.otlp.endpoint | OTA_EXPORTER_OTLP_ENDPOINT | The OTLP endpoint to connect to. |
#### Logging Exporter
The logging exporter simply prints the name of the span along with its attributes to stdout. It is used manly
for testing and debugging. It takes a single configuration parameter.
for testing and debugging.
| System property | Environment variable | Purpose |
|-----------------------------|-----------------------------|--------------------------------------------------------------------|
| ota.exporter.logging.prefix | OTA_EXPORTER_LOGGING_PREFIX | A string that is printed in front of the span name and attributes. |
| System property | Environment variable | Purpose |
|-----------------------------|-----------------------------|------------------------------------------------------------------------------|
| ota.exporter.logging.prefix | OTA_EXPORTER_LOGGING_PREFIX | An optional string that is printed in front of the span name and attributes. |
These parameter names are very likely to change over time, so please check back here when trying out a new version!