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

Library Instrumentation for Apache HttpClient version 4.3 and higher

Provides OpenTelemetry instrumentation for the Apache HttpClient, enabling HTTP client spans and metrics.

Quickstart

Add these dependencies to your project

Replace OPENTELEMETRY_VERSION with the latest release.

For Maven, add to your pom.xml dependencies:

<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:

implementation("io.opentelemetry.instrumentation:opentelemetry-apache-httpclient-4.3:OPENTELEMETRY_VERSION")

Usage

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