OpenTelemetry auto-instrumentation and instrumentation libraries for Java
Go to file
Trask Stalnaker f827399801
Remove unused var (#7192)
Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>
2022-11-16 09:04:24 +01:00
.githooks Use Spotless for formatting (DataDog/dd-trace-java#1619) 2020-06-30 11:15:48 -07:00
.github GitHub action sync (#7150) 2022-11-15 09:35:30 -08:00
benchmark-jfr-analyzer Remove unshaded javax.annotation classes from bootstrap class loader (#4454) 2021-10-21 14:47:50 -07:00
benchmark-overhead More spotless (#7126) 2022-11-11 05:01:21 +00:00
benchmark-overhead-jmh Remove the 'noop API' feature (#6313) 2022-07-12 10:36:19 -07:00
bom Introduce non-alpha bom (#6576) 2022-09-11 12:17:38 -07:00
bom-alpha Add dependency from alpha bom to stable bom (#6611) 2022-09-14 08:22:29 -07:00
buildscripts Add OWASP dependency check (#6978) 2022-10-27 19:21:38 -07:00
conventions Stop relocating :instrumentation:resources:library (#7136) 2022-11-15 22:37:17 +00:00
custom-checks Enable PrivateConstructorForUtilityClass errorprone check (#6427) 2022-08-10 11:30:22 +03:00
dependencyManagement Consolidate dependabot updates (#7176) 2022-11-15 08:56:49 +01:00
docs GitHub action sync (#7150) 2022-11-15 09:35:30 -08:00
examples Remove unused var (#7192) 2022-11-16 09:04:24 +01:00
gradle/wrapper Update gradle to 7.5.1 (#6359) 2022-08-12 12:03:43 +02:00
gradle-plugins Stop relocating :instrumentation:resources:library (#7136) 2022-11-15 22:37:17 +00:00
instrumentation JMX Metric Insight (#6573) 2022-11-15 19:52:12 -08:00
instrumentation-annotations Stabilize annotations (#7046) 2022-11-08 08:46:11 -08:00
instrumentation-annotations-support Enable PrivateConstructorForUtilityClass errorprone check (#6427) 2022-08-10 11:30:22 +03:00
instrumentation-annotations-support-testing Add code attributes to several instrumentations (#6365) 2022-07-27 09:37:01 +02:00
instrumentation-api Run context customizers before span start instead of after (#6634) 2022-10-06 12:11:17 -07:00
instrumentation-api-semconv Migrate some SQL sanitizer tests to java (#7148) 2022-11-15 06:15:32 +00:00
javaagent More spotless (#7126) 2022-11-11 05:01:21 +00:00
javaagent-bootstrap Make java.sql classes available to the agent and extensions (#7038) 2022-11-03 11:42:28 -07:00
javaagent-extension-api Rename kafka propagation setting and clarify behavior (#6957) 2022-10-24 08:49:48 -07:00
javaagent-internal-logging-simple Update to slf4j 2.0.2 (#6774) 2022-10-06 01:28:53 +00:00
javaagent-tooling Stop relocating :instrumentation:resources:library (#7136) 2022-11-15 22:37:17 +00:00
licenses More spotless (#7126) 2022-11-11 05:01:21 +00:00
muzzle Update error prone (#6646) 2022-09-23 11:24:40 -07:00
opentelemetry-api-shaded-for-instrumenting Upgrade to otel java 1.19.0 (#6757) 2022-10-12 09:19:37 -07:00
opentelemetry-ext-annotations-shaded-for-instrumenting Support new annotations (and change of instrumentation name for opentelemetry-annotations) (#6296) 2022-07-11 14:34:26 -07:00
opentelemetry-instrumentation-annotations-shaded-for-instrumenting Support new annotations (and change of instrumentation name for opentelemetry-annotations) (#6296) 2022-07-11 14:34:26 -07:00
opentelemetry-instrumentation-api-shaded-for-instrumenting Instrument SpanKey directly (#5933) 2022-05-03 14:56:33 -07:00
smoke-tests Add shell check (#7125) 2022-11-11 14:58:05 -08:00
testing Upgrade to otel java 1.19.0 (#6757) 2022-10-12 09:19:37 -07:00
testing-common End groovy files with newline (#7127) 2022-11-10 12:21:55 +01:00
.editorconfig Update .editorconfig for properties files (#3677) 2021-07-26 14:16:36 -07:00
.gitattributes Add task to generate license report into licenses folder. (#2239) 2021-02-12 17:20:08 +09:00
.gitignore Remove and ignore .attach_pid files (#5348) 2022-02-11 09:37:52 -08:00
CHANGELOG.md Copy change log updates from release/v1.19.x (#7026) 2022-11-02 09:56:21 +01:00
CONTRIBUTING.md Update (rewrite) the javaagent structure doc; document bootstrap modules (#6227) 2022-06-28 20:23:27 -07:00
LICENSE Update to standard LICENSE file for OpenTelemetry (#19) 2019-11-19 09:46:10 -08:00
README.md Add semantic conventions column to supported libraries doc (#6974) 2022-11-01 11:26:41 -07:00
RELEASING.md Add a release step (#7128) 2022-11-10 13:37:12 +02:00
VERSIONING.md Add guidance about dropping support for older library versions (#4802) 2021-12-06 22:37:29 -08:00
build.gradle.kts Sync github actions (#5695) 2022-03-29 10:21:17 -07:00
code-of-conduct.md Add code-of-conduct file. (#2341) 2021-02-19 16:24:41 +09:00
gradle.properties Try to reduce CI failures due to maven central flakiness (#7164) 2022-11-14 18:55:53 -08:00
gradlew Update gradle to 7.5.1 (#6359) 2022-08-12 12:03:43 +02:00
gradlew.bat Update gradle to 7.5.1 (#6359) 2022-08-12 12:03:43 +02:00
include-conventions.gradle.kts Fix dependabot (#6986) 2022-10-27 13:31:38 +03:00
settings.gradle.kts JMX Metric Insight (#6573) 2022-11-15 19:52:12 -08:00
version.gradle.kts Update version to 1.20.0-SNAPSHOT (#6861) 2022-10-12 22:01:43 +00:00

README.md

<p align="center"> <strong> <a href="https://github.com/open-telemetry/opentelemetry-java-instrumentation#getting-started">Getting Started</a>   •   <a href="https://github.com/open-telemetry/community#special-interest-groups">Getting Involved</a>   •   <a href="https://github.com/open-telemetry/opentelemetry-java-instrumentation/discussions">Getting In Touch</a> </strong> </p> <p align="center"> <a href="https://github.com/open-telemetry/opentelemetry-java-instrumentation/actions/workflows/build.yml"> <img alt="Build Status" src="https://img.shields.io/github/workflow/status/open-telemetry/opentelemetry-java-instrumentation/Build?style=for-the-badge"> </a> <a href="https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases"> <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/open-telemetry/opentelemetry-java-instrumentation?include_prereleases&style=for-the-badge"> </a> <img alt="Beta" src="https://img.shields.io/badge/status-beta-informational?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAACQAAAAAQAAAJAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAA8A2UOAAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABK5JREFUSA2dVm1sFEUYfmd2b/f2Pkqghn5eEQWKrRgjpkYgpoRCLC0oxV5apAiGUDEpJvwxEQ2raWPU+Kf8INU/RtEedwTCR9tYPloxGNJYTTQUwYqJ1aNpaLH3sXu3t7vjvFevpSqt7eSyM+/czvM8877PzB3APBoLgoDLsNePF56LBwqa07EKlDGg84CcWsI4CEbhNnDpAd951lXE2NkiNknCCTLv4HtzZuvPm1C/IKv4oDNXqNDHragety2XVzjECZsJARuBMyRzJrh1O0gQwLXuxofxsPSj4hG8fMLQo7bl9JJD8XZfC1E5yWFOMtd07dvX5kDwg6+2++Chq8txHGtfPoAp0gOFmhYoNFkHjn2TNUmrwRdna7W1QSkU8hvbGk4uThLrapaiLA2E6QY4u/lS9ItHfvJkxYsTMVtnAJLipYIWtVrcdX+8+b8IVnPl/R81prbuPZ1jpYw+0aEUGSkdFsgyBIaFTXCm6nyaxMtJ4n+TeDhJzGqZtQZcuYDgqDwDbqb0JF9oRpIG1Oea3bC1Y6N3x/WV8Zh83emhCs++hlaghDw+8w5UlYKq2lU7Pl8IkvS9KDqXmKmEwdMppVPKwGSEilmyAwJhRwWcq7wYC6z4wZ1rrEoMWxecdOjZWXeAQClBcYDN3NwVwD9pGwqUSyQgclcmxpNJqCuwLmDh3WtvPqXdlt+6Oz70HPGDNSNBee/EOen+rGbEFqDENBPDbtdCp0ukPANmzO0QQJYUpyS5IJJI3Hqt4maS+EB3199ozm8EDU/6fVNU2dQpdx3ZnKzeFXyaUTiasEV/gZMzJMjr3Z+WvAdQ+hs/zw9savimxUntDSaBdZ2f+Idbm1rlNY8esFffBit9HtK5/MejsrJVxikOXlb1Ukir2X+Rbdkd1KG2Ixfn2Ql4JRmELnYK9mEM8G36fAA3xEQ89fxXihC8q+sAKi9jhHxNqagY2hiaYgRCm0f0QP7H4Fp11LSXiuBY2aYFlh0DeDIVVFUJQn5rCnpiNI2gvLxHnASn9DIVHJJlm5rXvQAGEo4zvKq2w5G1NxENN7jrft1oxMdekETjxdH2Z3x+VTVYsPb+O0C/9/auN6v2hNZw5b2UOmSbG5/rkC3LBA+1PdxFxORjxpQ81GcxKc+ybVjEBvUJvaGJ7p7n5A5KSwe4AzkasA+crmzFtowoIVTiLjANm8GDsrWW35ScI3JY8Urv83tnkF8JR0yLvEt2hO/0qNyy3Jb3YKeHeHeLeOuVLRpNF+pkf85OW7/zJxWdXsbsKBUk2TC0BCPwMq5Q/CPvaJFkNS/1l1qUPe+uH3oD59erYGI/Y4sce6KaXYElAIOLt+0O3t2+/xJDF1XvOlWGC1W1B8VMszbGfOvT5qaRRAIFK3BCO164nZ0uYLH2YjNN8thXS2v2BK9gTfD7jHVxzHr4roOlEvYYz9QIz+Vl/sLDXInsctFsXjqIRnO2ZO387lxmIboLDZCJ59KLFliNIgh9ipt6tLg9SihpRPDO1ia5byw7de1aCQmF5geOQtK509rzfdwxaKOIq+73AvwCC5/5fcV4vo3+3LpMdtWHh0ywsJC/ZGoCb8/9D8F/ifgLLl8S8QWfU8cAAAAASUVORK5CYII="> </p> <p align="center"> <strong> <a href="CONTRIBUTING.md">Contributing<a/>   •   <a href="docs/scope.md">Scope<a/> </strong> </p>

Getting Started   •   Getting Involved   •   Getting In Touch

Build Status GitHub release (latest by date including pre-releases) Beta

Contributing   •   Scope

OpenTelemetry Icon OpenTelemetry Instrumentation for Java

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 OTLP exporter configured to send data to OpenTelemetry collector at http://localhost:4317.

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.

Click here to see the detailed list of configuration environment variables and system properties.

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.

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.

Triagers (@open-telemetry/java-instrumentation-triagers):

Approvers (@open-telemetry/java-instrumentation-approvers):

Maintainers (@open-telemetry/java-instrumentation-maintainers):

Emeritus maintainers:

Learn more about roles in the community repository.

Thanks to all the people who already contributed!