opentelemetry-java-instrumentation/instrumentation/spring/starters/spring-starter/README.md

OpenTelemetry Spring Starter

OpenTelemetry Spring Starter is a starter package that includes the opentelemetry-api, opentelemetry-sdk, opentelemetry-extension-annotations, opentelmetry-logging-exporter, opentelemetry-spring-boot-autoconfigurations and spring framework starters required to setup distributed tracing. Check out opentelemetry-spring-boot-autoconfigure for the full list of supported libraries and features.

This version is compatible with Spring Boot 2.0.

Quickstart

Add these dependencies to your project.

Replace OPENTELEMETRY_VERSION with the latest stable release.

• Minimum version: 1.1.0
• Note: You may need to include our bintray maven repository to your build file: https://dl.bintray.com/open-telemetry/maven/. As of August 2020 the latest opentelemetry-java-instrumentation artifacts are not published to maven-central. Please check the releasing doc for updates to this process.

Maven

Add the following dependencies to your pom.xml file:

<dependencies>

  <dependency>
    <groupId>io.opentelemetry.instrumentation</groupId>
    <artifactId>opentelemetry-spring-starter</artifactId>
    <version>OPENTELEMETRY_VERSION</version>
  </dependency>

</dependencies>

Gradle

Add the following dependencies to your gradle.build file:

implementation 'io.opentelemetry.instrumentation:opentelemetry-spring-starter:OPENTELEMETRY_VERSION'

Starter Guide

Check out the opentelemetry-api quick start to learn more about OpenTelemetry instrumentation.