Skip to content

Commit

Permalink
Add library instrumentation docs (#3176)
Browse files Browse the repository at this point in the history
  • Loading branch information
trask committed Jun 3, 2021
1 parent 7ef31a0 commit 9a3c657
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ 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 [standalone library instrumentation](docs/standalone-library-instrumentation.md)
if you are looking for documentation on using those.

## Getting Started

Download the [latest version](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent-all.jar).
Expand Down
27 changes: 27 additions & 0 deletions docs/standalone-library-instrumentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Standalone library instrumentation

This repository also publishes standalone instrumentation for several libraries (and growing)
that can be used if you prefer that over using the Java agent:

* [Apache Dubbo](../instrumentation/apache-dubbo-2.7/library)
* [Armeria](../instrumentation/armeria-1.3/library)
* [AWS Lambda](../instrumentation/aws-lambda-1.0/library)
* [AWS SDK 1.11](../instrumentation/aws-sdk/aws-sdk-1.11/library)
* [AWS SDK 2.2+](../instrumentation/aws-sdk/aws-sdk-2.2/library)
* [gRPC](../instrumentation/grpc-1.6/library)
* [Guava](../instrumentation/guava-10.0/library)
* [Lettuce](../instrumentation/lettuce/lettuce-5.1/library)
* [Log4j](../instrumentation/log4j/log4j-2.13.2/library)
* [Logback](../instrumentation/logback-1.0/library)
* [MongoDB Driver](../instrumentation/mongo/mongo-3.1/library)
* [OkHttp](../instrumentation/okhttp/okhttp-3.0/library)
* [OSHI](../instrumentation/oshi/library)
* [Reactor](../instrumentation/reactor-3.1/library)
* [RocketMQ](../instrumentation/rocketmq-client-4.8/library)
* [Runtime metrics](../instrumentation/runtime-metrics/library)
* [RxJava 1.0](../instrumentation/rxjava/rxjava-1.0/library)
* [RxJava 2.0](../instrumentation/rxjava/rxjava-2.0/library)
* [RxJava 3.0](../instrumentation/rxjava/rxjava-3.0/library)
* [Spring RestTemplate](../instrumentation/spring/spring-web-3.1/library)
* [Spring Web MVC](../instrumentation/spring/spring-webmvc-3.1/library)
* [Spring WebFlux Client](../instrumentation/spring/spring-webflux-5.0/library)
2 changes: 1 addition & 1 deletion docs/supported-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ These are the supported libraries and frameworks:
| [Logback](http:https://logback.qos.ch/) | 1.0+ |
| [Metro](https://projects.eclipse.org/projects/ee4j.metro) | 2.2+ (not including 3.x yet) |
| [Mojarra](https://projects.eclipse.org/projects/ee4j.mojarra) | 1.2+ (not including 3.x yet) |
| [MongoDB Drivers](https://mongodb.github.io/mongo-java-driver/) | 3.3+ |
| [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/) | 3.1+ |
| [MyFaces](https://myfaces.apache.org/) | 1.2+ (not including 3.x yet) |
| [Netty](https://github.com/netty/netty) | 3.8+ |
| [OkHttp](https://github.com/square/okhttp/) | 3.0+ |
Expand Down

0 comments on commit 9a3c657

Please sign in to comment.