Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Upgrade Java library, 0.15.0 -> 0.17.0 #427

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions content/exporters/custom-exporter/Java/Trace.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases: [/custom_exporter/java/trace, /guides/custom_exporter/java/trace]

## Introduction

A trace exporter must extend the abstract class [SpanExporter.Handler](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/trace/export/SpanExporter.Handler.html) implementing the `export` method
A trace exporter must extend the abstract class [SpanExporter.Handler](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/trace/export/SpanExporter.Handler.html) implementing the `export` method

which for purposes of brevity is:

Expand All @@ -25,9 +25,9 @@ import io.opencensus.trace.export.SpanData;
public void export(Collection<SpanData> spanDataList);
```

The sole method `export` will be used to process and translate a collection of [SpanData](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/trace/export/SpanData.html) to your desired trace backend's data.
The sole method `export` will be used to process and translate a collection of [SpanData](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/trace/export/SpanData.html) to your desired trace backend's data.

After an exporter is created, it must be registered with [SpanExporter.registerHandler](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/trace/export/SpanExporter.html#registerHandler-java.lang.String-io.opencensus.trace.export.SpanExporter.Handler-)
After an exporter is created, it must be registered with [SpanExporter.registerHandler](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/trace/export/SpanExporter.html#registerHandler-java.lang.String-io.opencensus.trace.export.SpanExporter.Handler-)

```java
SpanExporter.registerHandler(nameOfTheExporter, anInstanceOfTheExporter);
Expand Down Expand Up @@ -156,7 +156,7 @@ public class CustomTraceExporter extends SpanExporter.Handler {

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down Expand Up @@ -268,14 +268,14 @@ Annotations: TimedEvents{events=[TimedEvent{timestamp=Timestamp{seconds=15337689

## Notes

* Please remember to invoke [SpanExporter.registerHandler](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/trace/export/SpanExporter.html#registerHandler-java.lang.String-io.opencensus.trace.export.SpanExporter.Handler-) for your created Trace exporter lest it won't receive exported span data
* Please remember to invoke [SpanExporter.registerHandler](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/trace/export/SpanExporter.html#registerHandler-java.lang.String-io.opencensus.trace.export.SpanExporter.Handler-) for your created Trace exporter lest it won't receive exported span data

* Your exporter's `export` method will receive exported span data only for spans that have been ended

## References

Name|Link
---|---
Trace JavaDoc |[io.opencensus.trace.*](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/trace/package-summary.html)
Trace JavaDoc |[io.opencensus.trace.*](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/trace/package-summary.html)
OpenCensus JavaDoc|[io.opencensus.*](https://www.javadoc.io/doc/io.opencensus/opencensus-api/)
OpenCensus Java exporters|[Some OpenCensus Java exporters](/supported-exporters/java/)
3 changes: 2 additions & 1 deletion content/exporters/supported-exporters/Java/Instana.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To create the trace exporter, you'll need to:
```xml
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -45,6 +45,7 @@ To create the trace exporter, you'll need to:
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>

<dependency>
Expand Down
2 changes: 1 addition & 1 deletion content/exporters/supported-exporters/Java/Jaeger.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If using Maven, add these to your `pom.xml` file
```xml
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
3 changes: 2 additions & 1 deletion content/exporters/supported-exporters/Java/Prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Add this to your `pom.xml` file:
```xml
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -53,6 +53,7 @@ Add this to your `pom.xml` file:
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>

<dependency>
Expand Down
2 changes: 1 addition & 1 deletion content/exporters/supported-exporters/Java/SignalFx.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Insert the following snippet in your `pom.xml`:
```xml
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion content/exporters/supported-exporters/Java/Zipkin.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If using Maven, add these to your `pom.xml` file
```xml
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public final class StackdriverExample {
Insert the following snippet in your `pom.xml`:
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.16.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public class Repl {
Insert the following snippet in your `pom.xml`:
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.16.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
6 changes: 3 additions & 3 deletions content/guides/gRPC/Java.md
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ public class TutorialServer {

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The version of OpenCensus to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The version of OpenCensus to use -->
<grpc.version>1.12.0</grpc.version> <!-- The gRPC version to use with the version of OpenCensus -->
</properties>

Expand Down Expand Up @@ -1037,7 +1037,7 @@ which will give visuals such as:
Notes|Link
---|---
OpenCensus Java gRPC metrics|https://www.javadoc.io/doc/io.opencensus/opencensus-contrib-grpc-metrics
Trace JavaDoc|[io.opencensus.trace.*](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/trace/package-summary.html)
Stats JavaDoc|[io.opencensus.stats.*](https://static.javadoc.io/io.opencensus/opencensus-api/0.15.0/io/opencensus/stats/package-summary.html)
Trace JavaDoc|[io.opencensus.trace.*](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/trace/package-summary.html)
Stats JavaDoc|[io.opencensus.stats.*](https://static.javadoc.io/io.opencensus/opencensus-api/0.17.0/io/opencensus/stats/package-summary.html)
OpenCensus JavaDoc|[io.opencensus.*](https://www.javadoc.io/doc/io.opencensus/opencensus-api/)
OpenCensus Java exporters|[Some OpenCensus Java exporters](/supported-exporters/java/)
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ public class BigtableOpenCensus implements AutoCloseable {

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion content/guides/integrations/redis/Java.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ public class JedisOpenCensus {

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand Down
12 changes: 8 additions & 4 deletions content/quickstart/java/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Put this in your newly generated `pom.xml` file:

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<build>
Expand Down Expand Up @@ -224,6 +224,7 @@ To enable metrics, we’ll declare the dependencies in your `pom.xml` file. Add
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>
</dependencies>
{{</highlight>}}
Expand All @@ -241,7 +242,7 @@ To enable metrics, we’ll declare the dependencies in your `pom.xml` file. Add

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -255,6 +256,7 @@ To enable metrics, we’ll declare the dependencies in your `pom.xml` file. Add
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>
</dependencies>

Expand Down Expand Up @@ -1330,7 +1332,7 @@ Add the following code snippet to your `<dependencies>...</dependencies>` node i

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -1344,6 +1346,7 @@ Add the following code snippet to your `<dependencies>...</dependencies>` node i
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>

<dependency>
Expand Down Expand Up @@ -1787,7 +1790,7 @@ public class Repl {

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -1801,6 +1804,7 @@ public class Repl {
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>

<dependency>
Expand Down
12 changes: 8 additions & 4 deletions content/quickstart/java/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Please add this content to your `pom.xml` file:

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<build>
Expand Down Expand Up @@ -202,6 +202,7 @@ To enable tracing, we’ll declare the dependencies in your `pom.xml` file. Inse
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>
</dependencies>
{{</highlight>}}
Expand All @@ -219,7 +220,7 @@ To enable tracing, we’ll declare the dependencies in your `pom.xml` file. Inse

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -233,6 +234,7 @@ To enable tracing, we’ll declare the dependencies in your `pom.xml` file. Inse
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>
</dependencies>

Expand Down Expand Up @@ -394,7 +396,7 @@ To enable trace exporting to Zipkin, we’ll need to declare the Zipkin exporter

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -408,6 +410,7 @@ To enable trace exporting to Zipkin, we’ll need to declare the Zipkin exporter
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>

<dependency>
Expand Down Expand Up @@ -810,7 +813,7 @@ public class Repl {

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<opencensus.version>0.15.0</opencensus.version> <!-- The OpenCensus version to use -->
<opencensus.version>0.17.0</opencensus.version> <!-- The OpenCensus version to use -->
</properties>

<dependencies>
Expand All @@ -824,6 +827,7 @@ public class Repl {
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>${opencensus.version}</version>
<scope>runtime</scope>
</dependency>

<dependency>
Expand Down