Skip to content

Commit

Permalink
Exporter/OcAgent: Update all since tags. (census-instrumentation#1778)
Browse files Browse the repository at this point in the history
  • Loading branch information
songy23 authored and malike committed Mar 1, 2019
1 parent e24dd5e commit 263d8fd
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 46 deletions.
12 changes: 6 additions & 6 deletions exporters/metrics/ocagent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ For Maven add to your `pom.xml`:
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-api</artifactId>
<version>0.19.0</version>
<version>0.20.0</version>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-exporter-metrics-ocagent</artifactId>
<version>0.19.0</version>
<version>0.20.0</version>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>0.19.0</version>
<version>0.20.0</version>
<scope>runtime</scope>
</dependency>
</dependencies>
```

For Gradle add to your dependencies:
```groovy
compile 'io.opencensus:opencensus-api:0.19.0'
compile 'io.opencensus:opencensus-exporter-metrics-ocagent:0.19.0'
runtime 'io.opencensus:opencensus-impl:0.19.0'
compile 'io.opencensus:opencensus-api:0.20.0'
compile 'io.opencensus:opencensus-exporter-metrics-ocagent:0.20.0'
runtime 'io.opencensus:opencensus-impl:0.20.0'
```

### Register the exporter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
* }
* }</pre>
*
* @since 0.19
* @since 0.20
*/
@ThreadSafe
public final class OcAgentMetricsExporter {
Expand All @@ -65,7 +65,7 @@ public final class OcAgentMetricsExporter {
* to the OpenCensus library.
*
* @param configuration the {@code OcAgentMetricsExporterConfiguration}.
* @since 0.19
* @since 0.20
*/
public static void createAndRegister(OcAgentMetricsExporterConfiguration configuration) {
checkNotNull(configuration, "configuration");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* Configurations for {@code OcAgentMetricsExporter}.
*
* @since 0.19
* @since 0.20
*/
@AutoValue
@Immutable
Expand All @@ -37,7 +37,7 @@ public abstract class OcAgentMetricsExporterConfiguration {
* Returns the end point of OC-Agent. The end point can be dns, ip:port, etc.
*
* @return the end point of OC-Agent.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract String getEndPoint();
Expand All @@ -46,7 +46,7 @@ public abstract class OcAgentMetricsExporterConfiguration {
* Returns whether to disable client transport security for the exporter's gRPC connection or not.
*
* @return whether to disable client transport security for the exporter's gRPC connection or not.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract Boolean getUseInsecure();
Expand All @@ -64,7 +64,7 @@ public abstract class OcAgentMetricsExporterConfiguration {
* Returns the service name to be used for the {@code OcAgentMetricsExporter}.
*
* @return the service name.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract String getServiceName();
Expand All @@ -73,7 +73,7 @@ public abstract class OcAgentMetricsExporterConfiguration {
* Returns the retry time interval when trying to connect to Agent.
*
* @return the retry time interval.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract Duration getRetryInterval();
Expand All @@ -82,7 +82,7 @@ public abstract class OcAgentMetricsExporterConfiguration {
* Returns the export interval between pushes to Agent.
*
* @return the export interval.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract Duration getExportInterval();
Expand All @@ -91,7 +91,7 @@ public abstract class OcAgentMetricsExporterConfiguration {
* Returns a new {@link Builder}.
*
* @return a {@code Builder}.
* @since 0.19
* @since 0.20
*/
public static Builder builder() {
return new AutoValue_OcAgentMetricsExporterConfiguration.Builder().setUseInsecure(true);
Expand All @@ -100,7 +100,7 @@ public static Builder builder() {
/**
* Builder for {@link OcAgentMetricsExporterConfiguration}.
*
* @since 0.19
* @since 0.20
*/
@AutoValue.Builder
public abstract static class Builder {
Expand All @@ -112,7 +112,7 @@ public abstract static class Builder {
*
* @param endPoint the end point of OC-Agent.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setEndPoint(String endPoint);

Expand All @@ -122,7 +122,7 @@ public abstract static class Builder {
* @param useInsecure whether disable client transport security for the exporter's gRPC
* connection.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setUseInsecure(Boolean useInsecure);

Expand All @@ -140,7 +140,7 @@ public abstract static class Builder {
*
* @param serviceName the service name.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setServiceName(String serviceName);

Expand All @@ -149,7 +149,7 @@ public abstract static class Builder {
*
* @param retryInterval the retry time interval.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setRetryInterval(Duration retryInterval);

Expand All @@ -158,7 +158,7 @@ public abstract static class Builder {
*
* @param exportInterval the export time interval.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setExportInterval(Duration exportInterval);

Expand All @@ -168,7 +168,7 @@ public abstract static class Builder {
* Builds a {@link OcAgentMetricsExporterConfiguration}.
*
* @return a {@code OcAgentMetricsExporterConfiguration}.
* @since 0.19
* @since 0.20
*/
public abstract OcAgentMetricsExporterConfiguration build();
}
Expand Down
12 changes: 6 additions & 6 deletions exporters/trace/ocagent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ For Maven add to your `pom.xml`:
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-api</artifactId>
<version>0.19.2</version>
<version>0.20.0</version>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-exporter-trace-ocagent</artifactId>
<version>0.19.2</version>
<version>0.20.0</version>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>0.19.2</version>
<version>0.20.0</version>
<scope>runtime</scope>
</dependency>
</dependencies>
```

For Gradle add to your dependencies:
```groovy
compile 'io.opencensus:opencensus-api:0.19.2'
compile 'io.opencensus:opencensus-exporter-trace-ocagent:0.19.2'
runtime 'io.opencensus:opencensus-impl:0.19.2'
compile 'io.opencensus:opencensus-api:0.20.0'
compile 'io.opencensus:opencensus-exporter-trace-ocagent:0.20.0'
runtime 'io.opencensus:opencensus-impl:0.20.0'
```

### Register the exporter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* }
* }</pre>
*
* @since 0.19
* @since 0.20
*/
@ThreadSafe
public final class OcAgentTraceExporter {
Expand All @@ -56,7 +56,7 @@ private OcAgentTraceExporter() {}
* Creates a {@code OcAgentTraceExporterHandler} with default configurations and registers it to
* the OpenCensus library.
*
* @since 0.19
* @since 0.20
*/
public static void createAndRegister() {
synchronized (monitor) {
Expand All @@ -71,7 +71,7 @@ public static void createAndRegister() {
* the OpenCensus library.
*
* @param configuration the {@code OcAgentTraceExporterConfiguration}.
* @since 0.19
* @since 0.20
*/
public static void createAndRegister(OcAgentTraceExporterConfiguration configuration) {
synchronized (monitor) {
Expand Down Expand Up @@ -108,7 +108,7 @@ private static void registerInternal(Handler newHandler) {
/**
* Unregisters the OC-Agent exporter from the OpenCensus library.
*
* @since 0.19
* @since 0.20
*/
public static void unregister() {
unregister(Tracing.getExportComponent().getSpanExporter());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* Configurations for {@link OcAgentTraceExporter}.
*
* @since 0.19
* @since 0.20
*/
@AutoValue
@Immutable
Expand All @@ -37,7 +37,7 @@ public abstract class OcAgentTraceExporterConfiguration {
* Returns the end point of OC-Agent. The end point can be dns, ip:port, etc.
*
* @return the end point of OC-Agent.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract String getEndPoint();
Expand All @@ -46,7 +46,7 @@ public abstract class OcAgentTraceExporterConfiguration {
* Returns whether to disable client transport security for the exporter's gRPC connection or not.
*
* @return whether to disable client transport security for the exporter's gRPC connection or not.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract Boolean getUseInsecure();
Expand All @@ -64,7 +64,7 @@ public abstract class OcAgentTraceExporterConfiguration {
* Returns the service name to be used for this {@link OcAgentTraceExporter}.
*
* @return the service name.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract String getServiceName();
Expand All @@ -73,7 +73,7 @@ public abstract class OcAgentTraceExporterConfiguration {
* Returns the retry time interval when trying to connect to Agent.
*
* @return the retry time interval.
* @since 0.19
* @since 0.20
*/
@Nullable
public abstract Duration getRetryInterval();
Expand All @@ -82,15 +82,15 @@ public abstract class OcAgentTraceExporterConfiguration {
* Returns whether the {@link OcAgentTraceExporter} should handle the config streams.
*
* @return whether the {@code OcAgentTraceExporter} should handle the config streams.
* @since 0.19
* @since 0.20
*/
public abstract boolean getEnableConfig();

/**
* Returns a new {@link Builder}.
*
* @return a {@code Builder}.
* @since 0.19
* @since 0.20
*/
public static Builder builder() {
return new AutoValue_OcAgentTraceExporterConfiguration.Builder()
Expand All @@ -101,7 +101,7 @@ public static Builder builder() {
/**
* Builder for {@link OcAgentTraceExporterConfiguration}.
*
* @since 0.19
* @since 0.20
*/
@AutoValue.Builder
public abstract static class Builder {
Expand All @@ -113,7 +113,7 @@ public abstract static class Builder {
*
* @param endPoint the end point of OC-Agent.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setEndPoint(String endPoint);

Expand All @@ -123,7 +123,7 @@ public abstract static class Builder {
* @param useInsecure whether disable client transport security for the exporter's gRPC
* connection.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setUseInsecure(Boolean useInsecure);

Expand All @@ -141,7 +141,7 @@ public abstract static class Builder {
*
* @param serviceName the service name.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setServiceName(String serviceName);

Expand All @@ -150,7 +150,7 @@ public abstract static class Builder {
*
* @param retryInterval the retry time interval.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setRetryInterval(Duration retryInterval);

Expand All @@ -159,7 +159,7 @@ public abstract static class Builder {
*
* @param enableConfig whether {@code OcAgentTraceExporter} should handle the config streams.
* @return this.
* @since 0.19
* @since 0.20
*/
public abstract Builder setEnableConfig(boolean enableConfig);

Expand All @@ -169,7 +169,7 @@ public abstract static class Builder {
* Builds a {@link OcAgentTraceExporterConfiguration}.
*
* @return a {@code OcAgentTraceExporterConfiguration}.
* @since 0.19
* @since 0.20
*/
public abstract OcAgentTraceExporterConfiguration build();
}
Expand Down

0 comments on commit 263d8fd

Please sign in to comment.