README.md
OpenTelemetry Instrumentation for Java
- About
- Getting Started
- Configuring the Agent
- Supported libraries, frameworks, and application servers
- Creating agent extensions
- Manually instrumenting
- Logger MDC auto-instrumentation
- Troubleshooting
- Contributing
About
This project provides a Java agent JAR that can be attached to any Java 8+ application and dynamically injects bytecode to capture telemetry from a number of popular libraries and frameworks. You can export the telemetry data in a variety of formats. You can also configure the agent and exporter via command line arguments or environment variables. The net result is the ability to gather telemetry data from a Java application without code changes.
This repository also publishes standalone instrumentation for several libraries (and growing) that can be used if you prefer that over using the Java agent. Please see the standalone library instrumentation column on Supported Libraries. If you are looking for documentation on using those.
Getting Started
Download the latest version.
This package includes the instrumentation agent as well as instrumentations for all supported libraries and all available data exporters. The package provides a completely automatic, out-of-the-box experience.
Enable the instrumentation agent using the -javaagent flag to the JVM.
java -javaagent:path/to/opentelemetry-javaagent.jar \
-jar myapp.jar
By default, the OpenTelemetry Java agent uses the
OTLP exporter
configured to send data to an
OpenTelemetry collector
at http://localhost:4318.
Configuration parameters are passed as Java system properties (-D flags) or
as environment variables. See the configuration documentation
for the full list of configuration items. For example:
java -javaagent:path/to/opentelemetry-javaagent.jar \
-Dotel.resource.attributes=service.name=your-service-name \
-Dotel.traces.exporter=zipkin \
-jar myapp.jar
Configuring the Agent
The agent is highly configurable! Many aspects of the agent's behavior can be configured for your needs, such as exporter choice, exporter config (like where data is sent), trace context propagation headers, and much more.
For a detailed list of agent configuration options, see the agent configuration docs.
For a detailed list of additional SDK configuration environment variables and system properties, see the SDK configuration docs.
Note: Config parameter names are very likely to change over time, so please check back here when trying out a new version! Please report any bugs or unexpected behavior you find.
Supported libraries, frameworks, and application servers
We support an impressively huge number of libraries and frameworks and a majority of the most popular application servers...right out of the box! Click here to see the full list and to learn more about disabled instrumentation and how to suppress unwanted instrumentation.
Creating agent extensions
Extensions add new features and capabilities to the agent without having to create a separate distribution or to fork this repository. For example, you can create custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a single jar file.
Creating an agent distribution
Distribution provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. Agent extensions are recommended instead for most users as they are simpler and do not require rebuilding with each OpenTelemetry Java agent release.
Manually instrumenting
For most users, the out-of-the-box instrumentation is completely sufficient and nothing more has to be done. Sometimes, however, users wish to add attributes to the otherwise automatic spans, or they might want to manually create spans for their own custom code.
For detailed instructions, see Manual instrumentation.
Logger MDC (Mapped Diagnostic Context) auto-instrumentation
It is possible to inject trace information like trace IDs and span IDs into your custom application logs. For details, see Logger MDC auto-instrumentation.
Troubleshooting
To turn on the agent's internal debug logging:
-Dotel.javaagent.debug=true
Note: These logs are extremely verbose. Enable debug logging only when needed. Debug logging negatively impacts the performance of your application.
Contributing
See CONTRIBUTING.md.
Maintainers
- Lauri Tulmin, Splunk
- Trask Stalnaker, Microsoft
For more information about the maintainer role, see the community repository.
Approvers
- Gregor Zeitlinger, Grafana
- Jack Berg, New Relic
- Jason Plumb, Splunk
- Jay DeLuca, Grafana
- Jean Bisutti, Microsoft
- John Watson, Cloudera
- Jonas Kunz, Elastic
- Steve Rao, Alibaba
- Sylvain Juge, Elastic
For more information about the approver role, see the community repository.
Emeritus maintainers
For more information about the emeritus role, see the community repository.