library

Library Instrumentation for Java Servlet version 3.0 to 5.0

Provides OpenTelemetry instrumentation for Java Servlets through a servlet filter.

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-servlet-3.0</artifactId>
    <version>OPENTELEMETRY_VERSION</version>
  </dependency>
</dependencies>

For Gradle, add to your dependencies:

implementation("io.opentelemetry.instrumentation:opentelemetry-servlet-3.0:OPENTELEMETRY_VERSION")

Usage

Create telemetry producing servlet filter as shown below:

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.servlet.v3_0.ServletTelemetry;
import javax.servlet.Filter;

// ...

// Get an OpenTelemetry instance
OpenTelemetry openTelemetry = ...;

// Create a ServletTelemetry instance
ServletTelemetry telemetry = ServletTelemetry.create(openTelemetry);

// Create telemetry producing servlet filter
Filter filter = telemetry.createFilter();