Batch of library readmes

Author: jaydeluca

instrumentation/alibaba-druid-1.0/library/README.md

@@ -0,0 +1,55 @@
+# Library Instrumentation for Alibaba Druid version 1.0 and higher
+
+Provides OpenTelemetry instrumentation for [Alibaba Druid](https://github.com/alibaba/druid).
+
+This instrumentation generates database connection pool metrics for druid data sources.
+
+## 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-alibaba-druid-1.0).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-alibaba-druid-1.0</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-alibaba-druid-1.0:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+```java
+import com.alibaba.druid.pool.DruidDataSource;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.alibabadruid.v1_0.DruidTelemetry;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create a DruidTelemetry instance
+DruidTelemetry druidTelemetry = DruidTelemetry.create(openTelemetry);
+
+// Create a DruidDataSource
+DruidDataSource dataSource = new DruidDataSource();
+// ... configure the dataSource
+
+// Register the dataSource for metrics
+druidTelemetry.registerMetrics(dataSource, "my-druid-pool");
+
+// Unregister the dataSource when it's no longer needed
+druidTelemetry.unregisterMetrics(dataSource);
+```

instrumentation/apache-httpclient/apache-httpclient-4.3/library/README.md

@@ -0,0 +1,50 @@
+# Library Instrumentation for Apache HttpClient version 4.3 and higher
+
+Provides OpenTelemetry instrumentation for [Apache HttpClient](https://hc.apache.org/httpcomponents-client-ga/).
+
+This instrumentation generates CLIENT spans for each HTTP request.
+
+## 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-apache-httpclient-4.3).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-apache-httpclient-4.3</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-apache-httpclient-4.3:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+```java
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.apachehttpclient.v4_3.ApacheHttpClientTelemetry;
+import org.apache.http.impl.client.CloseableHttpClient;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create an ApacheHttpClientTelemetry instance
+ApacheHttpClientTelemetry telemetry = ApacheHttpClientTelemetry.create(openTelemetry);
+
+// Get a traced HttpClient
+CloseableHttpClient httpClient = telemetry.newHttpClient();
+
+// ... use the httpClient to make requests
+```

instrumentation/armeria/armeria-1.3/library/README.md

@@ -0,0 +1,77 @@
+# Library Instrumentation for Armeria version 1.3 and higher
+
+Provides OpenTelemetry instrumentation for [Armeria](https://armeria.dev/).
+
+This instrumentation generates both CLIENT and SERVER spans for each HTTP request.
+
+## 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-armeria-1.3).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-armeria-1.3</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-armeria-1.3:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+#### Server
+
+```java
+import com.linecorp.armeria.server.Server;
+import com.linecorp.armeria.server.ServerBuilder;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.armeria.v1_3.ArmeriaServerTelemetry;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create an ArmeriaServerTelemetry instance
+ArmeriaServerTelemetry telemetry = ArmeriaServerTelemetry.create(openTelemetry);
+
+// Add the decorator to your server builder
+Server server = Server.builder()
+    .decorator(telemetry.newDecorator())
+    // ... other server configuration
+    .build();
+```
+
+#### Client
+
+```java
+import com.linecorp.armeria.client.ClientBuilder;
+import com.linecorp.armeria.client.WebClient;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.armeria.v1_3.ArmeriaClientTelemetry;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create an ArmeriaClientTelemetry instance
+ArmeriaClientTelemetry telemetry = ArmeriaClientTelemetry.create(openTelemetry);
+
+// Add the decorator to your client builder
+WebClient client = new ClientBuilder("http://my-service.com")
+    .decorator(telemetry.newDecorator())
+    // ... other client configuration
+    .build(WebClient.class);
+```

instrumentation/cassandra/cassandra-4.4/library/README.md

@@ -0,0 +1,53 @@
+# Library Instrumentation for Cassandra version 4.4 and higher
+
+Provides OpenTelemetry instrumentation for the [DataStax Java Driver for Apache Cassandra](https://docs.datastax.com/en/developer/java-driver/latest/).
+
+This instrumentation generates CLIENT spans for each CQL query.
+
+## 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-cassandra-4.4).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-cassandra-4.4</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-cassandra-4.4:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+```java
+import com.datastax.oss.driver.api.core.CqlSession;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.cassandra.v4_4.CassandraTelemetry;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create a CassandraTelemetry instance
+CassandraTelemetry telemetry = CassandraTelemetry.create(openTelemetry);
+
+// Create a CqlSession
+CqlSession session = CqlSession.builder().build();
+
+// Wrap the session
+CqlSession tracedSession = telemetry.wrap(session);
+
+// ... use the tracedSession to make requests
+```

instrumentation/elasticsearch/elasticsearch-rest-7.0/library/README.md

@@ -0,0 +1,54 @@
+# Library Instrumentation for Elasticsearch REST Client version 7.0 and higher
+
+Provides OpenTelemetry instrumentation for the [Elasticsearch REST Client](https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-high.html).
+
+This instrumentation generates CLIENT spans and metrics for each Elasticsearch request.
+
+## 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-elasticsearch-rest-7.0).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-elasticsearch-rest-7.0</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-elasticsearch-rest-7.0:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+```java
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.elasticsearch.rest.v7_0.ElasticsearchRest7Telemetry;
+import org.apache.http.HttpHost;
+import org.elasticsearch.client.RestClient;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create an ElasticsearchRest7Telemetry instance
+ElasticsearchRest7Telemetry telemetry = ElasticsearchRest7Telemetry.create(openTelemetry);
+
+// Create a RestClient
+RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200, "http")).build();
+
+// Wrap the client
+RestClient tracedClient = telemetry.wrap(restClient);
+
+// ... use the tracedClient to make requests
+```

instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/README.md

@@ -0,0 +1,50 @@
+# Library Instrumentation for Jetty HttpClient version 12.0 and higher
+
+Provides OpenTelemetry instrumentation for the [Jetty HttpClient](https://www.eclipse.org/jetty/documentation/jetty-12/programming-guide/index.html#pg-client-http).
+
+This instrumentation generates CLIENT spans and metrics for each HTTP request.
+
+## 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-jetty-httpclient-12.0).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-jetty-httpclient-12.0</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-jetty-httpclient-12.0:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+```java
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.jetty.httpclient.v12_0.JettyClientTelemetry;
+import org.eclipse.jetty.client.HttpClient;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create a JettyClientTelemetry instance
+JettyClientTelemetry telemetry = JettyClientTelemetry.create(openTelemetry);
+
+// Get a traced HttpClient
+HttpClient httpClient = telemetry.getHttpClient();
+
+// ... use the httpClient to make requests
+```

instrumentation/jetty-httpclient/jetty-httpclient-9.2/library/README.md

@@ -0,0 +1,50 @@
+# Library Instrumentation for Jetty HttpClient version 9.2 and higher
+
+Provides OpenTelemetry instrumentation for the [Jetty HttpClient](https://github.com/jetty/jetty.project/tree/jetty-9.4.x).
+
+This instrumentation generates CLIENT spans and metrics for each HTTP request.
+
+## 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-jetty-httpclient-9.2).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-jetty-httpclient-9.2</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```kotlin
+implementation("io.opentelemetry.instrumentation:opentelemetry-jetty-httpclient-9.2:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+```java
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.jetty.httpclient.v9_2.JettyClientTelemetry;
+import org.eclipse.jetty.client.HttpClient;
+
+// ...
+
+// Get an OpenTelemetry instance
+OpenTelemetry openTelemetry = ...;
+
+// Create a JettyClientTelemetry instance
+JettyClientTelemetry telemetry = JettyClientTelemetry.create(openTelemetry);
+
+// Get a traced HttpClient
+HttpClient httpClient = telemetry.getHttpClient();
+
+// ... use the httpClient to make requests
+```