xref: /aosp_15_r20/external/opencensus-java/contrib/spring_sleuth_v1x/README.md (revision a24ffb47c3166327784aa05b149974e82e8f71b8)
1*a24ffb47SSadaf Ebrahimi# OpenCensus Spring Sleuth
2*a24ffb47SSadaf Ebrahimi[![Build Status][travis-image]][travis-url]
3*a24ffb47SSadaf Ebrahimi[![Windows Build Status][appveyor-image]][appveyor-url]
4*a24ffb47SSadaf Ebrahimi[![Maven Central][maven-image]][maven-url]
5*a24ffb47SSadaf Ebrahimi
6*a24ffb47SSadaf EbrahimiThe *OpenCensus Spring Sleuth for Java* is a library for automatically
7*a24ffb47SSadaf Ebrahimipropagating the OpenCensus trace context when working with [Spring Sleuth][spring-sleuth-url].
8*a24ffb47SSadaf Ebrahimi
9*a24ffb47SSadaf EbrahimiThis is an __experimental component__, please bring feedback to
10*a24ffb47SSadaf Ebrahimihttps://gitter.im/census-instrumentation/Lobby not the usual
11*a24ffb47SSadaf Ebrahimisleuth channel https://gitter.im/spring-cloud/spring-cloud-sleuth.
12*a24ffb47SSadaf Ebrahimi
13*a24ffb47SSadaf EbrahimiThis version is compatible with [Spring Boot 1.5.x][spring-boot-1.5-url].
14*a24ffb47SSadaf Ebrahimi
15*a24ffb47SSadaf Ebrahimi## Quickstart
16*a24ffb47SSadaf Ebrahimi
17*a24ffb47SSadaf Ebrahimi### Add the dependencies to your project
18*a24ffb47SSadaf Ebrahimi
19*a24ffb47SSadaf EbrahimiFor Maven add to your `pom.xml`:
20*a24ffb47SSadaf Ebrahimi```xml
21*a24ffb47SSadaf Ebrahimi<dependencies>
22*a24ffb47SSadaf Ebrahimi  <dependency>
23*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
24*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-contrib-spring-sleuth</artifactId>
25*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
26*a24ffb47SSadaf Ebrahimi    <exclusions>
27*a24ffb47SSadaf Ebrahimi      <exclusion>
28*a24ffb47SSadaf Ebrahimi	    <groupId>org.springframework.cloud</groupId>
29*a24ffb47SSadaf Ebrahimi	    <artifactId>spring-cloud-build</artifactId>
30*a24ffb47SSadaf Ebrahimi	  </exclusion>
31*a24ffb47SSadaf Ebrahimi	  <exclusion>
32*a24ffb47SSadaf Ebrahimi	    <groupId>org.springframework.cloud</groupId>
33*a24ffb47SSadaf Ebrahimi	    <artifactId>spring-cloud-starter-sleuth</artifactId>
34*a24ffb47SSadaf Ebrahimi   	  </exclusion>
35*a24ffb47SSadaf Ebrahimi    </exclusions>
36*a24ffb47SSadaf Ebrahimi  </dependency>
37*a24ffb47SSadaf Ebrahimi</dependencies>
38*a24ffb47SSadaf Ebrahimi```
39*a24ffb47SSadaf Ebrahimi
40*a24ffb47SSadaf EbrahimiFor Gradle add to your dependencies:
41*a24ffb47SSadaf Ebrahimi```groovy
42*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-contrib-spring-sleuth:0.28.3'
43*a24ffb47SSadaf Ebrahimi```
44*a24ffb47SSadaf Ebrahimi
45*a24ffb47SSadaf Ebrahimi[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
46*a24ffb47SSadaf Ebrahimi[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
47*a24ffb47SSadaf Ebrahimi[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
48*a24ffb47SSadaf Ebrahimi[appveyor-url]: https://ci.appveyor.com/project/opencensusjavateam/opencensus-java/branch/master
49*a24ffb47SSadaf Ebrahimi[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-spring-sleuth/badge.svg
50*a24ffb47SSadaf Ebrahimi[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-spring-sleuth
51*a24ffb47SSadaf Ebrahimi[spring-boot-1.5-url]: https://github.com/spring-projects/spring-boot/tree/1.5.x
52*a24ffb47SSadaf Ebrahimi[spring-sleuth-url]: https://github.com/spring-cloud/spring-cloud-sleuth
53