History

Trask Stalnaker 71b3e3e027 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.		2022-10-24 10:26:21 -07:00
..
README.md	Library doc cleanup (#6948 )	2022-10-24 10:26:21 -07:00
build.gradle.kts	Move versions to dependencyManagement (#6648 )	2022-09-19 12:05:06 +03:00

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

Maven

Add the following dependencies to your pom.xml file:

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

implementation("io.opentelemetry.instrumentation:opentelemetry-spring-boot-starter:OPENTELEMETRY_VERSION")

Starter Guide

Check out OpenTelemetry Manual Instrumentation to learn more about using the OpenTelemetry API to instrument your code.