xref: /aosp_15_r20/external/opencensus-java/exporters/metrics/ocagent/README.md (revision a24ffb47c3166327784aa05b149974e82e8f71b8)

# OpenCensus Java OC-Agent Metrics Exporter

The *OpenCensus Java OC-Agent Metrics Exporter* is the Java implementation of the OpenCensus Agent
(OC-Agent) Metrics Exporter.

## Quickstart

### Add the dependencies to your project

For Maven add to your `pom.xml`:
```xml
<dependencies>
  <dependency>
    <groupId>io.opencensus</groupId>
    <artifactId>opencensus-api</artifactId>
    <version>0.22.0</version>
  </dependency>
  <dependency>
    <groupId>io.opencensus</groupId>
    <artifactId>opencensus-exporter-metrics-ocagent</artifactId>
    <version>0.22.0</version>
  </dependency>
  <dependency>
    <groupId>io.opencensus</groupId>
    <artifactId>opencensus-impl</artifactId>
    <version>0.22.0</version>
    <scope>runtime</scope>
  </dependency>
  <dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-tcnative-boringssl-static</artifactId>
    <version>2.0.20.Final</version>
    <scope>runtime</scope>
  </dependency>
</dependencies>
```

For Gradle add to your dependencies:
```groovy
compile 'io.opencensus:opencensus-api:0.22.0'
compile 'io.opencensus:opencensus-exporter-metrics-ocagent:0.22.0'
runtime 'io.opencensus:opencensus-impl:0.22.0'
runtime 'io.netty:netty-tcnative-boringssl-static:2.0.20.Final'
```

### Register the exporter

```java
import io.opencensus.exporter.metrics.ocagent.OcAgentMetricsExporter;

public class MyMainClass {
  public static void main(String[] args) throws Exception {
    OcAgentMetricsExporter.createAndRegister();
    // ...
  }
}
```

## FAQ

### Why is `netty-tcnative-boringssl-static` needed? Which version should I use?

It's because this artifact depends on `grpc-netty` which requires a runtime dependency on `netty-tcnative-boringssl-static`
for it to work. For more details and a table of known working version combinations, see
https://github.com/grpc/grpc-java/blob/master/SECURITY.md#netty.