xref: /aosp_15_r20/external/opencensus-java/contrib/grpc_util/README.md (revision a24ffb47c3166327784aa05b149974e82e8f71b8)
1*a24ffb47SSadaf Ebrahimi# OpenCensus gRPC Util
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 gRPC Util for Java* is a collection of utilities for trace instrumentation when
7*a24ffb47SSadaf Ebrahimiworking with [gRPC][grpc-url].
8*a24ffb47SSadaf Ebrahimi
9*a24ffb47SSadaf Ebrahimi## Quickstart
10*a24ffb47SSadaf Ebrahimi
11*a24ffb47SSadaf Ebrahimi### Add the dependencies to your project
12*a24ffb47SSadaf Ebrahimi
13*a24ffb47SSadaf EbrahimiFor Maven add to your `pom.xml`:
14*a24ffb47SSadaf Ebrahimi```xml
15*a24ffb47SSadaf Ebrahimi<dependencies>
16*a24ffb47SSadaf Ebrahimi  <dependency>
17*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
18*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-contrib-grpc-util</artifactId>
19*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
20*a24ffb47SSadaf Ebrahimi  </dependency>
21*a24ffb47SSadaf Ebrahimi</dependencies>
22*a24ffb47SSadaf Ebrahimi```
23*a24ffb47SSadaf Ebrahimi
24*a24ffb47SSadaf EbrahimiFor Gradle add to your dependencies:
25*a24ffb47SSadaf Ebrahimi```groovy
26*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-contrib-grpc-util:0.28.3'
27*a24ffb47SSadaf Ebrahimi```
28*a24ffb47SSadaf Ebrahimi
29*a24ffb47SSadaf Ebrahimi[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
30*a24ffb47SSadaf Ebrahimi[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
31*a24ffb47SSadaf Ebrahimi[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
32*a24ffb47SSadaf Ebrahimi[appveyor-url]: https://ci.appveyor.com/project/opencensusjavateam/opencensus-java/branch/master
33*a24ffb47SSadaf Ebrahimi[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-grpc-util/badge.svg
34*a24ffb47SSadaf Ebrahimi[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-grpc-util
35*a24ffb47SSadaf Ebrahimi[grpc-url]: https://github.com/grpc/grpc-java
36