diff options
author | Yang Song <songy23@users.noreply.github.com> | 2018-09-24 15:27:45 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-09-24 15:27:45 -0700 |
commit | a36f795d87e02b9f5e0a4e6c7b26de0059e88e78 (patch) | |
tree | dee3c62414368d5356223ccc614eaaa356eef59b /exporters/trace/ocagent/README.md | |
parent | 648d7728e6b573d700da87b25236104edebc8c75 (diff) | |
download | opencensus-java-a36f795d87e02b9f5e0a4e6c7b26de0059e88e78.tar.gz |
Exporter: Start adding OC-Agent Trace Exporter. (#1455)
Diffstat (limited to 'exporters/trace/ocagent/README.md')
-rw-r--r-- | exporters/trace/ocagent/README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/exporters/trace/ocagent/README.md b/exporters/trace/ocagent/README.md new file mode 100644 index 00000000..4f25bd6e --- /dev/null +++ b/exporters/trace/ocagent/README.md @@ -0,0 +1,48 @@ +# OpenCensus Java OC-Agent Trace Exporter + +The *OpenCensus Java OC-Agent Trace Exporter* is the Java implementation of the OpenCensus Agent +(OC-Agent) Trace 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.17.0</version> + </dependency> + <dependency> + <groupId>io.opencensus</groupId> + <artifactId>opencensus-exporter-trace-ocagent</artifactId> + <version>0.17.0</version> + </dependency> + <dependency> + <groupId>io.opencensus</groupId> + <artifactId>opencensus-impl</artifactId> + <version>0.17.0</version> + <scope>runtime</scope> + </dependency> +</dependencies> +``` + +For Gradle add to your dependencies: +```gradle +compile 'io.opencensus:opencensus-api:0.17.0' +compile 'io.opencensus:opencensus-exporter-trace-ocagent:0.17.0' +runtime 'io.opencensus:opencensus-impl:0.17.0' +``` + +### Register the exporter + +```java +public class MyMainClass { + public static void main(String[] args) throws Exception { + OcAgentTraceExporter.createAndRegister(); + // ... + } +} +``` |