xref: /aosp_15_r20/external/opencensus-java/contrib/resource_util/README.md (revision a24ffb47c3166327784aa05b149974e82e8f71b8)
1*a24ffb47SSadaf Ebrahimi# OpenCensus Resources 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 Resource Util for Java* is a collection of utilities that defines a set of
7*a24ffb47SSadaf Ebrahimicommon resources (aws_ec2_instance, gcp_gce_instance, k8s_container, etc.) and offers auto detection
8*a24ffb47SSadaf Ebrahimifor some of the resources, based on the environment where the application is running.
9*a24ffb47SSadaf Ebrahimi
10*a24ffb47SSadaf Ebrahimi## Quickstart
11*a24ffb47SSadaf Ebrahimi
12*a24ffb47SSadaf Ebrahimi### Add the dependencies to your project
13*a24ffb47SSadaf Ebrahimi
14*a24ffb47SSadaf EbrahimiFor Maven add to your `pom.xml`:
15*a24ffb47SSadaf Ebrahimi```xml
16*a24ffb47SSadaf Ebrahimi<dependencies>
17*a24ffb47SSadaf Ebrahimi  <dependency>
18*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
19*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-contrib-resource-util</artifactId>
20*a24ffb47SSadaf Ebrahimi    <version>0.20.0</version>
21*a24ffb47SSadaf Ebrahimi  </dependency>
22*a24ffb47SSadaf Ebrahimi</dependencies>
23*a24ffb47SSadaf Ebrahimi```
24*a24ffb47SSadaf Ebrahimi
25*a24ffb47SSadaf EbrahimiFor Gradle add to your dependencies:
26*a24ffb47SSadaf Ebrahimi```groovy
27*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-contrib-resource-util:0.20.0'
28*a24ffb47SSadaf Ebrahimi```
29*a24ffb47SSadaf Ebrahimi
30*a24ffb47SSadaf Ebrahimi[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
31*a24ffb47SSadaf Ebrahimi[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
32*a24ffb47SSadaf Ebrahimi[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
33*a24ffb47SSadaf Ebrahimi[appveyor-url]: https://ci.appveyor.com/project/opencensusjavateam/opencensus-java/branch/master
34*a24ffb47SSadaf Ebrahimi[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-resource-util/badge.svg
35*a24ffb47SSadaf Ebrahimi[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-resource-util
36