xref: /aosp_15_r20/external/opencensus-java/exporters/trace/instana/README.md (revision a24ffb47c3166327784aa05b149974e82e8f71b8)
1*a24ffb47SSadaf Ebrahimi# OpenCensus Instana Trace Exporter
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 Instana Trace Exporter* is a trace exporter that exports
7*a24ffb47SSadaf Ebrahimidata to Instana. [Instana](http://www.instana.com/) is a distributed
8*a24ffb47SSadaf Ebrahimitracing system.
9*a24ffb47SSadaf Ebrahimi
10*a24ffb47SSadaf Ebrahimi## Quickstart
11*a24ffb47SSadaf Ebrahimi
12*a24ffb47SSadaf Ebrahimi### Prerequisites
13*a24ffb47SSadaf Ebrahimi
14*a24ffb47SSadaf Ebrahimi[Instana](http://www.instana.com/) forwards traces exported by applications
15*a24ffb47SSadaf Ebrahimiinstrumented with Census to its backend using the Instana agent processes as proxy.
16*a24ffb47SSadaf EbrahimiIf the agent is used on the same host as Census, please take care to deactivate
17*a24ffb47SSadaf Ebrahimiautomatic tracing.
18*a24ffb47SSadaf Ebrahimi
19*a24ffb47SSadaf Ebrahimi
20*a24ffb47SSadaf Ebrahimi### Hello Stan
21*a24ffb47SSadaf Ebrahimi
22*a24ffb47SSadaf Ebrahimi#### Add the dependencies to your project
23*a24ffb47SSadaf Ebrahimi
24*a24ffb47SSadaf EbrahimiFor Maven add to your `pom.xml`:
25*a24ffb47SSadaf Ebrahimi```xml
26*a24ffb47SSadaf Ebrahimi<dependencies>
27*a24ffb47SSadaf Ebrahimi  <dependency>
28*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
29*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-api</artifactId>
30*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
31*a24ffb47SSadaf Ebrahimi  </dependency>
32*a24ffb47SSadaf Ebrahimi  <dependency>
33*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
34*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-exporter-trace-instana</artifactId>
35*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
36*a24ffb47SSadaf Ebrahimi  </dependency>
37*a24ffb47SSadaf Ebrahimi  <dependency>
38*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
39*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-impl</artifactId>
40*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
41*a24ffb47SSadaf Ebrahimi    <scope>runtime</scope>
42*a24ffb47SSadaf Ebrahimi  </dependency>
43*a24ffb47SSadaf Ebrahimi</dependencies>
44*a24ffb47SSadaf Ebrahimi```
45*a24ffb47SSadaf Ebrahimi
46*a24ffb47SSadaf EbrahimiFor Gradle add to your dependencies:
47*a24ffb47SSadaf Ebrahimi```groovy
48*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-api:0.28.3'
49*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-exporter-trace-instana:0.28.3'
50*a24ffb47SSadaf Ebrahimiruntime 'io.opencensus:opencensus-impl:0.28.3'
51*a24ffb47SSadaf Ebrahimi```
52*a24ffb47SSadaf Ebrahimi
53*a24ffb47SSadaf Ebrahimi#### Register the exporter
54*a24ffb47SSadaf Ebrahimi
55*a24ffb47SSadaf Ebrahimi```java
56*a24ffb47SSadaf Ebrahimipublic class MyMainClass {
57*a24ffb47SSadaf Ebrahimi  public static void main(String[] args) throws Exception {
58*a24ffb47SSadaf Ebrahimi    InstanaTraceExporter.createAndRegister("http://localhost:42699/com.instana.plugin.generic.trace");
59*a24ffb47SSadaf Ebrahimi    // ...
60*a24ffb47SSadaf Ebrahimi  }
61*a24ffb47SSadaf Ebrahimi}
62*a24ffb47SSadaf Ebrahimi```
63*a24ffb47SSadaf Ebrahimi
64*a24ffb47SSadaf Ebrahimi#### Java Versions
65*a24ffb47SSadaf Ebrahimi
66*a24ffb47SSadaf EbrahimiJava 6 or above is required for using this exporter.
67*a24ffb47SSadaf Ebrahimi
68*a24ffb47SSadaf Ebrahimi[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
69*a24ffb47SSadaf Ebrahimi[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
70*a24ffb47SSadaf Ebrahimi[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
71*a24ffb47SSadaf Ebrahimi[appveyor-url]: https://ci.appveyor.com/project/opencensusjavateam/opencensus-java/branch/master
72*a24ffb47SSadaf Ebrahimi[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-exporter-trace-instana/badge.svg
73*a24ffb47SSadaf Ebrahimi[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-exporter-trace-instana
74