aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFabian Lange <lange.fabian@gmail.com>2018-02-09 14:33:30 -0500
committerBogdan Drutu <bdrutu@google.com>2018-02-09 11:33:30 -0800
commit17a1a1a0d19739a19b449c6d28817687ccd5b9d4 (patch)
treeb5ee100816bc7f762d19a21359538f93118af596 /README.md
parentad1a3fb10f5d8a1d958a3d82be264e22ca9e5c5c (diff)
downloadplatform_external_opencensus-java-17a1a1a0d19739a19b449c6d28817687ccd5b9d4.tar.gz
platform_external_opencensus-java-17a1a1a0d19739a19b449c6d28817687ccd5b9d4.tar.bz2
platform_external_opencensus-java-17a1a1a0d19739a19b449c6d28817687ccd5b9d4.zip
First proof of concept for Instana integration (#972)
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index ccc254e4..93b681ca 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
[![Coverage Status][codecov-image]][codecov-url]
-OpenCensus is a toolkit for collecting application performance and behavior data. It currently
+OpenCensus is a toolkit for collecting application performance and behavior data. It currently
includes 3 apis: stats, tracing and tags.
The library is in alpha stage and the API is subject to change.
@@ -53,13 +53,13 @@ public final class MyClassWithTracing {
doFinalWork();
}
}
-
+
private static void doInitialWork() {
// ...
tracer.getCurrentSpan().addAnnotation("Important.");
// ...
}
-
+
private static void doFinalWork() {
// ...
tracer.getCurrentSpan().addAnnotation("More important.");
@@ -74,7 +74,7 @@ TODO
## Quickstart for Applications
-Besides recording tracing/stats events the application also need to link the implementation,
+Besides recording tracing/stats events the application also need to link the implementation,
setup exporters, and debugging [Z-Pages](https://github.com/census-instrumentation/opencensus-java/tree/master/contrib/zpages).
### Add the dependencies to your project
@@ -105,6 +105,7 @@ runtime 'io.opencensus:opencensus-impl:0.11.1'
### How to setup exporters?
#### Trace exporters
+* [Instana][TraceExporterInstana]
* [Logging][TraceExporterLogging]
* [Stackdriver][TraceExporterStackdriver]
* [Zipkin][TraceExporterZipkin]
@@ -115,7 +116,7 @@ runtime 'io.opencensus:opencensus-impl:0.11.1'
### How to setup debugging Z-Pages?
-If the application owner wants to export in-process tracing and stats data via HTML debugging pages
+If the application owner wants to export in-process tracing and stats data via HTML debugging pages
see this [link](https://github.com/census-instrumentation/opencensus-java/tree/master/contrib/zpages#quickstart).
[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
@@ -130,6 +131,7 @@ see this [link](https://github.com/census-instrumentation/opencensus-java/tree/m
[gitter-url]: https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[codecov-image]: https://codecov.io/gh/census-instrumentation/opencensus-java/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/census-instrumentation/opencensus-java/branch/master/
+[TraceExporterInstana]: https://github.com/census-instrumentation/opencensus-java/tree/master/exporters/trace/instana#quickstart
[TraceExporterLogging]: https://github.com/census-instrumentation/opencensus-java/tree/master/exporters/trace/logging#quickstart
[TraceExporterStackdriver]: https://github.com/census-instrumentation/opencensus-java/tree/master/exporters/trace/stackdriver#quickstart
[TraceExporterZipkin]: https://github.com/census-instrumentation/opencensus-java/tree/master/exporters/trace/zipkin#quickstart