Documentation for library instrumentations #6947
Description
Documentation is missing for several library instrumentations
All library instrumentation should follow the template laid out in our contributing docs:
Every library instrumentation module must have a README.md file in the library directory root
(instrumentation/{some instrumentation}/library/README.md) that follows this pattern:
# Library Instrumentation for [Technology] version [X.Y] and higher
Provides OpenTelemetry instrumentation for [Technology link].
[Any other relevant context about the instrumentation]
## Quickstart
### Add these dependencies to your project
Replace `OPENTELEMETRY_VERSION` with the [latest release](maven-central-link).
For Maven, add to your `pom.xml` dependencies:
```xml
<dependencies>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>{library artifact name}</artifactId>
<version>OPENTELEMETRY_VERSION</version>
</dependency>
</dependencies>
```
For Gradle, add to your dependencies:
```kotlin
implementation("io.opentelemetry.instrumentation:{library artifact name}:OPENTELEMETRY_VERSION")
```
### Usage
[Code examples showing integration]Here is the current status:
- alibaba-druid-1.0 Batch of library instrumentation documentation #14606
- apache-dbcp-2.0
- apache-httpclient-4.3 Batch of library instrumentation documentation #14606
- apache-httpclient-5.2
- armeria-1.3 Batch of library instrumentation documentation #14606
- aws-lambda-core-1.0
- aws-lambda-events-2.2
- aws-lambda-events-3.11
- aws-sdk-1.11 Last batch of library readmes #14832
- aws-sdk-2.2
- c3p0-0.9
- cassandra-4.4 Batch of library instrumentation documentation #14606
- elasticsearch-rest-7.0 Batch of library instrumentation documentation #14606
- graphql-java-12.0
- graphql-java-20.0
- grpc-1.6
- hikaricp-3.0
- java-http-client
- java-http-server
- jdbc
- jetty-httpclient-12.0 Batch of library instrumentation documentation #14606
- jetty-httpclient-9.2 Batch of library instrumentation documentation #14606
- jmx-metrics Library readmes - batch 2 #14631
- kafka-clients-2.6
- ktor-1.0
- ktor-2.0
- ktor-3.0
- lettuce-5.1 Library readmes - batch 2 #14631
- log4j-appender-2.17
- logback-appender-1.0
- logback-mdc-1.0
- micrometer-1.5
- mongo-3.1
- netty-4.1 Library readmes - batch 2 #14631
- okhttp-3.0
- openai-java-1.1
- oracle-ucp-11.2
- oshi Library readmes - batch 2 #14631
- quartz-2.0 Library readmes - batch 2 #14631
- r2dbc-1.0
- ratpack-1.7 Library readmes - batch 3 #14680
- reactor-3.1 Library readmes - batch 3 #14680
- resources
- restlet-1.1 Library readmes - batch 3 #14680
- restlet-2.0 Library readmes - batch 3 #14680
- rocketmq-client-4.8
- runtime-telemetry-java17
- runtime-telemetry-java8
- rxjava-1.0 Library readmes - batch 3 #14680
- rxjava-2.0 Library readmes - batch 3 #14680
- rxjava-3.0 Library readmes - batch 3 #14680
- rxjava-3.1.1 Library readmes - batch 3 #14680
- spring-integration-4.1 Last batch of library readmes #14832
- spring-kafka-2.7 Last batch of library readmes #14832
- spring-security-config-6.0
- spring-web-3.1
- spring-webflux-5.3
- spring-webmvc-5.3
- spring-webmvc-6.0
- vibur-dbcp-11.0