Library doc cleanup (#6948)

Related to #6947, but just cleans up the library module doc that already
existed (mostly for uniformity). Does not introduce any new doc.

docs/standalone-library-instrumentation.md

@@ -4,6 +4,7 @@ This repository also publishes standalone instrumentation for several libraries
 that can be used if you prefer that over using the Java agent:
 
 * [Apache Dubbo](../instrumentation/apache-dubbo-2.7/library-autoconfigure)
+* [Apache Kafka](../instrumentation/kafka/kafka-clients/kafka-clients-2.6/library)
 * [Armeria](../instrumentation/armeria-1.3/library)
 * [AWS Lambda](../instrumentation/aws-lambda/aws-lambda-core-1.0/library)
 * [AWS SDK 1.11](../instrumentation/aws-sdk/aws-sdk-1.11/library)

instrumentation/apache-dbcp-2.0/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for Apache DBCP
+# Library Instrumentation for Apache DBCP version 2.0 and higher
 
 Provides OpenTelemetry instrumentation for [Apache DBCP](https://commons.apache.org/proper/commons-dbcp/).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [Apache DBCP](https://commons.apache.
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.15.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-apache-dbcp-2.0).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>

instrumentation/aws-lambda/aws-lambda-core-1.0/library/README.md

@@ -48,6 +48,7 @@ link to tracing information provided by Lambda itself. To do so, add a dependenc
 you use.
 
 Gradle:
+
 ```kotlin
 dependencies {
   implementation("io.opentelemetry:opentelemetry-extension-trace-propagators:0.8.0")
@@ -55,6 +56,7 @@ dependencies {
 ```
 
 Maven:
+
 ```xml
 <dependencies>
   <dependency>

instrumentation/aws-lambda/aws-lambda-events-2.2/library/README.md

@@ -58,6 +58,7 @@ dependencies {
 ```
 
 Maven:
+
 ```xml
 <dependencies>
   <dependency>

instrumentation/c3p0-0.9/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for C3P0
+# Library Instrumentation for C3P0 version 0.9 and higher
 
 Provides OpenTelemetry instrumentation for [C3P0](https://www.mchange.com/projects/c3p0/).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [C3P0](https://www.mchange.com/projec
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.15.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-c3p0-0.9).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>

instrumentation/graphql-java-12.0/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for GraphQL Java
+# Library Instrumentation for GraphQL Java version 12.0 and higher
 
 Provides OpenTelemetry instrumentation for [GraphQL Java](https://www.graphql-java.com/).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [GraphQL Java](https://www.graphql-ja
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.13.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-graphql-java-12.0).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>

instrumentation/hikaricp-3.0/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for HikariCP
+# Library Instrumentation for HikariCP version 3.0 and higher
 
 Provides OpenTelemetry instrumentation for [HikariCP](https://github.com/brettwooldridge/HikariCP).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [HikariCP](https://github.com/brettwo
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.14.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-hikaricp-3.0).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>

instrumentation/jdbc/library/README.md

@@ -1,16 +1,16 @@
-# Manual Instrumentation for JDBC
+# Library Instrumentation for JDBC
 
 Provides OpenTelemetry instrumentation for
 [Java JDBC API](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/).
 
 ## Quickstart
 
-### Add these dependencies to your project.
+### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.4.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-jdbc).
 
-For Maven add to your `pom.xml`:
+For Maven, add to your `pom.xml` dependencies:
 
 ```xml
 <dependencies>
@@ -22,19 +22,19 @@ For Maven add to your `pom.xml`:
 </dependencies>
 ```
 
-For Gradle add to your dependencies:
+For Gradle, add to your dependencies:
 
 ```groovy
 implementation("io.opentelemetry.instrumentation:opentelemetry-jdbc:OPENTELEMETRY_VERSION")
 ```
 
-##### Usage
+### Usage
 
-There are three possible ways to activate the OpenTelemetry JDBC instrumentation. The first way is more preferable for
+There are two possible ways to activate the OpenTelemetry JDBC instrumentation. The first way is more preferable for
 DI frameworks which uses connection pools, as it wraps a `DataSource` with a special OpenTelemetry wrapper. The second
 one requires to change the connection URL and switch to use a special OpenTelemetry driver.
 
-### Datasource way
+#### Datasource way
 
 If your application uses a DataSource, simply wrap your current DataSource object with `OpenTelemetryDataSource`.
 `OpenTelemetryDataSource` has a constructor method that accepts the `DataSource` to wrap. This is by far the simplest
@@ -63,7 +63,7 @@ public class DataSourceConfig {
 }
 ```
 
-### Driver way
+#### Driver way
 
 1. Activate tracing for JDBC connections by setting `jdbc:otel:` prefix to the JDBC URL:
 

instrumentation/kafka/kafka-clients/README.md

@@ -1,72 +0,0 @@
-# Instrumenting Kafka clients with OpenTelemetry
-
-In order to get tracing information out of your application using Kafka clients, there are two ways to do so:
-
-* instrumenting your application by enabling the tracing on the Kafka clients;
-* using an external agent running alongside your application to add tracing;
-
-For both of them, pick the latest `OPENTELEMETRY_RELEASE` from [here](https://mvnrepository.com/artifact/io.opentelemetry.instrumentation/opentelemetry-instrumentation-api).
-
-## Instrumenting the Kafka clients based application
-
-Instrumenting the application means enabling the tracing in the Kafka clients.
-First, you need to add the dependency to the instrumented Kafka clients.
-
-```xml
-<dependency>
-    <groupId>io.opentelemetry.instrumentation</groupId>
-    <artifactId>opentelemetry-kafka-clients-2.6</artifactId>
-    <version>OPENTELEMETRY_RELEASE</version>
-</dependency>
-```
-
-It is also need that you set up an `OpenTelemetry` instance in your application.
-To do so, programmatically or by using the SDK auto-configuration extension, please follow the official documentation [here](https://opentelemetry.io/docs/instrumentation/java/manual/).
-
-### Using interceptors
-
-The Kafka clients API provides a way to "intercept" messages before they are sent to the brokers as well as messages received from the broker before being passed to the application.
-The OpenTelemetry instrumented Kafka library provides two interceptors to be configured to add tracing information automatically.
-The interceptor class has to be set in the properties bag used to create the Kafka client.
-
-Use the `TracingProducerInterceptor` for the producer in order to create a "send" span automatically, each time a message is sent.
-
-```java
-props.setProperty(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, TracingProducerInterceptor.class.getName());
-```
-
-Use the `TracingConsumerInterceptor` for the consumer in order to create a "receive" span automatically, each time a message is received.
-
-```java
-props.setProperty(ConsumerConfig.INTERCEPTOR_CLASSES_CONFIG, TracingConsumerInterceptor.class.getName());
-```
-
-### Wrapping clients
-
-The other way is by wrapping the Kafka client with a tracing enabled Kafka client.
-
-Assuming you have a `Producer<K, V> producer` instance, you can wrap it in the following way.
-
-```java
-KafkaTelemetry telemetry = KafkaTelemetry.create(GlobalOpenTelemetry.get());
-Producer<String, String> tracingProducer = telemetry.wrap(producer);
-```
-
-Then use the `tracingProducer` as usual for sending messages to the Kafka cluster.
-
-Assuming you have a `Consumer<K, V> consumer` instance, you can wrap it in the following way.
-
-```java
-KafkaTelemetry telemetry = KafkaTelemetry.create(GlobalOpenTelemetry.get());
-Consumer<String, String> tracingConsumer = telemetry.wrap(this.consumer);
-```
-
-Then use the `tracingConsumer` as usual for receiving messages from the Kafka cluster.
-
-## Using agent
-
-Another way is by adding tracing to your application with no changes or additions into your application code.
-You also don't need to add any dependencies to the Kafka clients instrumentation library.
-This is about running an agent alongside your application in order to inject the logic for tracing messages sent and received to/from a Kafka cluster.
-
-For more details, please follow the official documentation [here](https://opentelemetry.io/docs/instrumentation/java/automatic/).

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/README.md

@@ -1,4 +1,75 @@
-# Kafka Metrics
+# Library instrumentation for Kafka Clients version 2.6 and higher
+
+## Quickstart
+
+### Add these dependencies to your project:
+
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-kafka-clients-2.6).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-kafka-clients-2.6</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```groovy
+implementation("io.opentelemetry.instrumentation:opentelemetry-kafka-clients-2.6:OPENTELEMETRY_VERSION")
+```
+
+### Usage (Tracing)
+
+There are two options for capturing traces, either using interceptors or wrapping clients, both described below.
+
+#### Using interceptors
+
+The Kafka clients API provides a way to "intercept" messages before they are sent to the brokers as well as messages received from the broker before being passed to the application.
+The OpenTelemetry instrumented Kafka library provides two interceptors to be configured to add tracing information automatically.
+The interceptor class has to be set in the properties bag used to create the Kafka client.
+
+Use the `TracingProducerInterceptor` for the producer in order to create a "send" span automatically, each time a message is sent.
+
+```java
+props.setProperty(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, TracingProducerInterceptor.class.getName());
+```
+
+Use the `TracingConsumerInterceptor` for the consumer in order to create a "receive" span automatically, each time a message is received.
+
+```java
+props.setProperty(ConsumerConfig.INTERCEPTOR_CLASSES_CONFIG, TracingConsumerInterceptor.class.getName());
+```
+
+#### Wrapping clients
+
+The other way is by wrapping the Kafka client with a tracing enabled Kafka client.
+
+Assuming you have a `Producer<K, V> producer` instance, you can wrap it in the following way.
+
+```java
+KafkaTelemetry telemetry = KafkaTelemetry.create(GlobalOpenTelemetry.get());
+Producer<String, String> tracingProducer = telemetry.wrap(producer);
+```
+
+Then use the `tracingProducer` as usual for sending messages to the Kafka cluster.
+
+Assuming you have a `Consumer<K, V> consumer` instance, you can wrap it in the following way.
+
+```java
+KafkaTelemetry telemetry = KafkaTelemetry.create(GlobalOpenTelemetry.get());
+Consumer<String, String> tracingConsumer = telemetry.wrap(this.consumer);
+```
+
+Then use the `tracingConsumer` as usual for receiving messages from the Kafka cluster.
+
+### Usage (Metrics)
 
 The Kafka client exposes metrics via `org.apache.kafka.common.metrics.MetricsReporter` interface.
 OpenTelemetry provides an implementation that bridges the metrics into OpenTelemetry.

instrumentation/ktor/ktor-1.0/library/README.md

@@ -1,8 +1,33 @@
-# Ktor Instrumentation
+# Library Instrumentation for Ktor versions 1.x
 
 This package contains libraries to help instrument Ktor. Currently, only server instrumentation is supported.
 
-## Initializing server instrumentation
+## Quickstart
+
+### Add these dependencies to your project:
+
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-ktor-1.0).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-ktor-1.0</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```groovy
+implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-1.0:OPENTELEMETRY_VERSION")
+```
+
+## Usage
 
 Initialize instrumentation by installing the `KtorServerTracing` feature. You must set the `OpenTelemetry` to use with
 the feature.

instrumentation/ktor/ktor-2.0/library/README.md

@@ -1,7 +1,34 @@
-# Ktor Instrumentation
+# Library Instrumentation for Ktor version 2.0 and higher
 
 This package contains libraries to help instrument Ktor. Currently, only server instrumentation is supported.
 
+## Quickstart
+
+### Add these dependencies to your project:
+
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-ktor-2.0).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-ktor-2.0</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```groovy
+implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-2.0:OPENTELEMETRY_VERSION")
+```
+
+## Usage
+
 ## Initializing server instrumentation
 
 Initialize instrumentation by installing the `KtorServerTracing` feature. You must set the `OpenTelemetry` to use with

instrumentation/log4j/log4j-appender-2.17/library/README.md

@@ -1,35 +1,37 @@
-# Log4j2 Appender
+# Appender Instrumentation for Log4j2 version 2.17 and higher
 
 This module provides a Log4j2 [appender](https://logging.apache.org/log4j/2.x/manual/appenders.html)
 which forwards Log4j2 log events to the
 [OpenTelemetry Log SDK](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk/logs).
 
-To use it, add the following modules to your application's classpath.
+## Quickstart
 
-Replace `OPENTELEMETRY_VERSION` with the latest
-stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation).
+### Add these dependencies to your project:
 
-**Maven**
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-log4j-appender-2.17).
 
-```xml
+For Maven, add to your `pom.xml` dependencies:
 
+```xml
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-log4j-appender-2.17</artifactId>
     <version>OPENTELEMETRY_VERSION</version>
+    <scope>runtime</scope>
   </dependency>
 </dependencies>
 ```
 
-**Gradle**
+For Gradle, add to your dependencies:
 
-```kotlin
-dependencies {
-  runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-appender-2.17:OPENTELEMETRY_VERSION")
-}
+```groovy
+runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-appender-2.17:OPENTELEMETRY_VERSION")
 ```
 
+### Usage
+
 The following demonstrates how you might configure the appender in your `log4j.xml` configuration:
 
 ```xml

instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure/README.md

@@ -1,34 +1,36 @@
-# Log4j2 Autoconfigure Integration
+# ContextData Instrumentation for Log4j2 version 2.17 and higher
 
 This module provides a Log4j2 `ContextDataProvider` that injects trace context from active spans
 into log context.
 
-To use it, add the module to your application's runtime classpath.
+## Quickstart
 
-Replace `OPENTELEMETRY_VERSION` with the latest
-stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation).
+### Add these dependencies to your project:
 
-**Maven**
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-log4j-context-data-2.17-autoconfigure).
 
-```xml
+For Maven, add to your `pom.xml` dependencies:
 
+```xml
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-log4j-context-data-2.17-autoconfigure</artifactId>
     <version>OPENTELEMETRY_VERSION</version>
+    <scope>runtime</scope>
   </dependency>
 </dependencies>
 ```
 
-**Gradle**
+For Gradle, add to your dependencies:
 
-```kotlin
-dependencies {
-  runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-context-data-2.17-autoconfigure:OPENTELEMETRY_VERSION")
-}
+```groovy
+runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-context-data-2.17-autoconfigure:OPENTELEMETRY_VERSION")
 ```
 
+### Usage
+
 `OpenTelemetryContextDataProvider` implements the Log4j2 `ContextDataProvider` SPI, and injects the
 trace ID and span ID from an active span into
 Log4j's [context data](https://logging.apache.org/log4j/2.x/manual/thread-context.html).

instrumentation/logback/logback-appender-1.0/library/README.md

@@ -1,15 +1,17 @@
-# Logback Appender
+# Appender Instrumentation for Logback version 1.0 and higher
 
 This module provides a Logback [appender](https://logback.qos.ch/manual/appenders.html) which
 forwards Logback log events to the
 [OpenTelemetry Log SDK](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk/logs).
 
-To use it, add the following modules to your application's classpath.
+## Quickstart
 
-Replace `OPENTELEMETRY_VERSION` with the latest
-stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation).
+### Add these dependencies to your project:
 
-**Maven**
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-logback-appender-1.0).
+
+For Maven, add to your `pom.xml` dependencies:
 
 ```xml
 <dependencies>
@@ -17,18 +19,19 @@ stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrument
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-logback-appender-1.0</artifactId>
     <version>OPENTELEMETRY_VERSION</version>
+    <scope>runtime</scope>
   </dependency>
 </dependencies>
 ```
 
-**Gradle**
+For Gradle, add to your dependencies:
 
-```kotlin
-dependencies {
-  runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0:OPENTELEMETRY_VERSION")
-}
+```groovy
+runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0:OPENTELEMETRY_VERSION")
 ```
 
+### Usage
+
 The following demonstrates how you might configure the appender in your `logback.xml` configuration:
 
 ```xml

instrumentation/logback/logback-mdc-1.0/library/README.md

@@ -1,18 +1,18 @@
-# Logback Integration
+# MDC Instrumentation for Logback version 1.0 and higher
 
 This module integrates instrumentation with Logback by injecting the trace ID and span ID from a
 mounted span using a custom Logback appender.
 
-To use it, add the module to your application's runtime classpath and add the appender to your
-`logback.xml`.
+## Quickstart
 
-Replace `OPENTELEMETRY_VERSION` with the latest
-stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation).
+### Add these dependencies to your project:
 
-**Maven**
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-logback-mdc-1.0).
 
-```xml
+For Maven, add to your `pom.xml` dependencies:
 
+```xml
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
@@ -22,7 +22,7 @@ stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrument
 </dependencies>
 ```
 
-**Gradle**
+For Gradle, add to your dependencies:
 
 ```kotlin
 dependencies {
@@ -30,6 +30,8 @@ dependencies {
 }
 ```
 
+### Usage
+
 **logback.xml**
 
 ```xml

instrumentation/okhttp/okhttp-3.0/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for OkHttp3 version 3.0.0+
+# Library Instrumentation for OkHttp version 3.0 and higher
 
 Provides OpenTelemetry instrumentation for [okhttp3](https://square.github.io/okhttp/).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [okhttp3](https://square.github.io/ok
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.5.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-okhttp-3.0).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>

instrumentation/oracle-ucp-11.2/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for Oracle UCP
+# Library Instrumentation for Oracle UCP version 11.2 and higher
 
 Provides OpenTelemetry instrumentation for [Oracle UCP](https://docs.oracle.com/database/121/JJUCP/).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [Oracle UCP](https://docs.oracle.com/
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.15.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-oracle-ucp-11.2).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>

instrumentation/spring/README.md

@@ -37,6 +37,7 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 ### Maven
 
 #### OpenTelemetry
+
 ```xml
 <dependency>
    <groupId>io.opentelemetry</groupId>
@@ -51,6 +52,7 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 ```
 
 #### LoggingSpanExporter
+
 ```xml
 <dependency>
    <groupId>io.opentelemetry</groupId>
@@ -60,6 +62,7 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 ```
 
 #### Jaeger Exporter
+
 ```xml
 <dependency>
    <groupId>io.opentelemetry</groupId>
@@ -76,17 +79,20 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 ### Gradle
 
 #### OpenTelemetry
+
 ```gradle
 implementation("io.opentelemetry:opentelemetry-api:OPENTELEMETRY_VERSION")
 implementation("io.opentelemetry:opentelemetry-sdk:OPENTELEMETRY_VERSION")
 ```
 
 #### LoggingExporter
+
 ```gradle
 implementation("io.opentelemetry:opentelemetry-exporter-logging:OPENTELEMETRY_VERSION")
 ```
 
 #### Jaeger Exporter
+
 ```gradle
 implementation("io.opentelemetry:opentelemetry-exporters-jaeger:OPENTELEMETRY_VERSION")
 compile "io.grpc:grpc-netty:1.30.2"
@@ -613,6 +619,7 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
  - Minimum version: `1.1.0`
 
 #### Maven
+
 ```xml
 <dependency>
    <groupId>io.opentelemetry.instrumentation</groupId>
@@ -622,6 +629,7 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 ```
 
 #### Gradle
+
 ```gradle
 implementation("io.opentelemetry.instrumentation:opentelemetry-spring-boot-starter:OPENTELEMETRY_VERSION")
 ```
@@ -826,8 +834,8 @@ status=Status{canonicalCode=OK, description=null}, name=WebMVCTracingFilter.doFi
 To configure OpenTelemetry tracing with the OTLP, Zipkin, or Jaeger span exporters replace the OpenTelemetry Spring Starter dependency with one of the artifacts listed below:
 
 #### Maven
-```xml
 
+```xml
 <!-- opentelemetry starter with zipkin -->
 <dependency>
 	<groupId>io.opentelemetry.instrumentation</groupId>
@@ -844,8 +852,8 @@ To configure OpenTelemetry tracing with the OTLP, Zipkin, or Jaeger span exporte
 ```
 
 #### Gradle
-```gradle
 
+```gradle
 //opentelemetry starter with zipkin configurations
 implementation("io.opentelemetry.instrumentation:opentelemetry-zipkin-spring-boot-starter:OPENTELEMETRY_VERSION")
 

instrumentation/spring/spring-boot-autoconfigure/README.md

@@ -13,8 +13,7 @@ the [opentelemetry-spring-boot-starter](../starters/spring-boot-starter/README.m
 Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.maven.org/search?q=g:io.opentelemetry).
  - Minimum version: `1.17.0`
 
-
-For Maven add to your `pom.xml`:
+For Maven, add to your `pom.xml` dependencies:
 
 ```xml
 <dependencies>
@@ -43,7 +42,7 @@ For Maven add to your `pom.xml`:
 </dependencies>
 ```
 
-For Gradle add to your dependencies:
+For Gradle, add to your dependencies:
 
 ```groovy
 //opentelemetry spring auto-configuration
@@ -66,7 +65,7 @@ Replace `SPRING_VERSION` with the version of spring you're using.
 Replace `SPRING_WEBFLUX_VERSION` with the version of spring-webflux you're using.
  - Minimum version: `5.0`
 
-For Maven add to your `pom.xml`:
+For Maven, add to your `pom.xml` dependencies:
 
 ```xml
 <dependencies>
@@ -122,7 +121,7 @@ For Maven add to your `pom.xml`:
 </dependencies>
 ```
 
-For Gradle add to your dependencies:
+For Gradle, add to your dependencies:
 
 ```groovy
 //opentelemetry exporter

instrumentation/spring/spring-web-3.1/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for Spring-Web
+# Library Instrumentation for Spring Web version 3.1 and higher
 
 Provides OpenTelemetry instrumentation for Spring's RestTemplate.
 
@@ -9,14 +9,12 @@ Provides OpenTelemetry instrumentation for Spring's RestTemplate.
 Replace `SPRING_VERSION` with the version of spring you're using.
 `Minimum version: 3.1`
 
-Replace `OPENTELEMETRY_VERSION` with the latest
-stable [release](https://mvnrepository.com/artifact/io.opentelemetry).
-`Minimum version: 1.4.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-spring-web-3.1).
 
-For Maven add to your `pom.xml`:
+For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <!-- opentelemetry -->
   <dependency>
@@ -43,7 +41,7 @@ For Maven add to your `pom.xml`:
 </dependencies>
 ```
 
-For Gradle add to your dependencies:
+For Gradle, add to your dependencies:
 
 ```groovy
 implementation("io.opentelemetry.instrumentation:opentelemetry-spring-web-3.1:OPENTELEMETRY_VERSION")

instrumentation/spring/spring-webflux-5.0/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for Spring Webflux
+# Library Instrumentation for Spring Webflux version 5.0 and higher
 
 Provides OpenTelemetry instrumentation for Spring's `WebClient`.
 
@@ -9,10 +9,10 @@ Provides OpenTelemetry instrumentation for Spring's `WebClient`.
 Replace `SPRING_VERSION` with the version of spring you're using.
 `Minimum version: 5.0`
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://mvnrepository.com/artifact/io.opentelemetry).
-`Minimum version: 1.8.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-spring-webflux-5.0).
 
-For Maven add to your `pom.xml`:
+For Maven, add to your `pom.xml` dependencies:
 
 ```xml
 <dependencies>
@@ -42,7 +42,7 @@ For Maven add to your `pom.xml`:
 </dependencies>
 ```
 
-For Gradle add to your dependencies:
+For Gradle, add to your dependencies:
 
 ```groovy
 // opentelemetry instrumentation

instrumentation/spring/spring-webmvc-5.3/library/README.md

@@ -1,4 +1,4 @@
-# Library Instrumentation for Spring Web MVC
+# Library Instrumentation for Spring Web MVC version 5.3 and higher
 
 Provides OpenTelemetry instrumentation for Spring WebMVC controllers.
 
@@ -9,8 +9,8 @@ Provides OpenTelemetry instrumentation for Spring WebMVC controllers.
 Replace `SPRING_VERSION` with the version of spring you're using.
  - `Minimum version: 5.3`
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://mvnrepository.com/artifact/io.opentelemetry).
- - `Minimum version: 1.17.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-spring-webmvc-5.3).
 
 For Maven add the following to your `pom.xml`:
 

instrumentation/spring/starters/jaeger-spring-boot-starter/README.md

@@ -14,13 +14,11 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 
 ```xml
 <dependencies>
-
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-jaeger-spring-boot-starter</artifactId>
     <version>OPENTELEMETRY_VERSION</version>
   </dependency>
-
 </dependencies>
 ```
 

instrumentation/spring/starters/spring-boot-starter/README.md

@@ -11,23 +11,22 @@ This version is compatible with Spring Boot 2.0.
 Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.maven.org/search?q=g:io.opentelemetry).
  - Minimum version: `1.1.0`
 
-
 ### Maven
+
 Add the following dependencies to your `pom.xml` file:
 
 ```xml
 <dependencies>
-
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-spring-boot-starter</artifactId>
     <version>OPENTELEMETRY_VERSION</version>
   </dependency>
-
 </dependencies>
 ```
 
 ### Gradle
+
 Add the following dependencies to your gradle.build file:
 
 ```groovy

instrumentation/spring/starters/zipkin-spring-boot-starter/README.md

@@ -16,13 +16,11 @@ Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://search.
 
 ```xml
 <dependencies>
-
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-zipkin-spring-boot-starter</artifactId>
     <version>OPENTELEMETRY_VERSION</version>
   </dependency>
-
 </dependencies>
 ```
 

instrumentation/vibur-dbcp-11.0/library/README.md

@@ -1,4 +1,4 @@
-# Manual Instrumentation for Vibur DBCP
+# Library Instrumentation for Vibur DBCP version 11.0 and higher
 
 Provides OpenTelemetry instrumentation for [Vibur DBCP](https://www.vibur.org/).
 
@@ -6,13 +6,12 @@ Provides OpenTelemetry instrumentation for [Vibur DBCP](https://www.vibur.org/).
 
 ### Add these dependencies to your project:
 
-Replace `OPENTELEMETRY_VERSION` with the latest stable
-[release](https://mvnrepository.com/artifact/io.opentelemetry). `Minimum version: 1.15.0`
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-vibur-dbcp-11.0).
 
 For Maven, add to your `pom.xml` dependencies:
 
 ```xml
-
 <dependencies>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>