Update docs for 1.5.0 (#3482)

* Update docs for 1.5.0

* CHANGELOG too
This commit is contained in:
Anuraag Agrawal 2021-08-14 00:10:46 +09:00 committed by GitHub
parent 154915f051
commit c5730e77b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
31 changed files with 130 additions and 84 deletions

View File

@ -1,6 +1,8 @@
# Changelog
## Version 1.5.0 (Unreleased):
## Version 1.6.0 (Unreleased):
## Version 1.5.0 2021-08-13:
### API
- The `io.opentelemetry.context.ContextStorage` interface now allows providing a root `Context`.

View File

@ -83,7 +83,7 @@ dependency versions in sync.
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.4.1</version>
<version>1.5.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@ -102,7 +102,7 @@ dependency versions in sync.
```groovy
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.4.1")
implementation platform("io.opentelemetry:opentelemetry-bom:1.5.0")
implementation('io.opentelemetry:opentelemetry-api')
}
```
@ -127,7 +127,7 @@ We strongly recommend using our published BOM to keep all dependency versions in
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.4.1-SNAPSHOT</version>
<version>1.5.0-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@ -150,7 +150,7 @@ repositories {
}
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.4.1-SNAPSHOT")
implementation platform("io.opentelemetry:opentelemetry-bom:1.5.0-SNAPSHOT")
implementation('io.opentelemetry:opentelemetry-api')
}
```
@ -170,19 +170,19 @@ This is a **current** feature status list:
| Component | Version |
| --------------------------- | ------- |
| Trace API | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| Trace SDK | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| Context | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| Baggage | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| Jaeger Trace Exporter | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| Zipkin Trace Exporter | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| OTLP Exporter (Spans) | v<!--VERSION_STABLE-->1.4.1<!--/VERSION_STABLE--> |
| OTLP Exporter (Metrics) | v<!--VERSION_UNSTABLE-->1.4.1-alpha<!--/VERSION_UNSTABLE--> |
| Metrics API | v<!--VERSION_UNSTABLE-->1.4.1-alpha<!--/VERSION_UNSTABLE--> |
| Metrics SDK | v<!--VERSION_UNSTABLE-->1.4.1-alpha<!--/VERSION_UNSTABLE--> |
| Prometheus Metrics Exporter | v<!--VERSION_UNSTABLE-->1.4.1-alpha<!--/VERSION_UNSTABLE--> |
| OpenTracing Bridge | v<!--VERSION_UNSTABLE-->1.4.1-alpha<!--/VERSION_UNSTABLE--> |
| OpenCensus Bridge | v<!--VERSION_UNSTABLE-->1.4.1-alpha<!--/VERSION_UNSTABLE--> |
| Trace API | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| Trace SDK | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| Context | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| Baggage | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| Jaeger Trace Exporter | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| Zipkin Trace Exporter | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Spans) | v<!--VERSION_STABLE-->1.5.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Metrics) | v<!--VERSION_UNSTABLE-->1.5.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics API | v<!--VERSION_UNSTABLE-->1.5.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics SDK | v<!--VERSION_UNSTABLE-->1.5.0-alpha<!--/VERSION_UNSTABLE--> |
| Prometheus Metrics Exporter | v<!--VERSION_UNSTABLE-->1.5.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenTracing Bridge | v<!--VERSION_UNSTABLE-->1.5.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenCensus Bridge | v<!--VERSION_UNSTABLE-->1.5.0-alpha<!--/VERSION_UNSTABLE--> |
See the project [milestones](https://github.com/open-telemetry/opentelemetry-java/milestones)
for details on upcoming releases. The dates and features described in issues

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,4 @@
Comparing source compatibility of against
***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.context.ContextStorage (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.context.Context root()

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,17 @@
Comparing source compatibility of against
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder builder()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.common.CompletableResultCode export(java.util.Collection)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.common.CompletableResultCode flush()
+++ NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter getDefault()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.common.CompletableResultCode shutdown()
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder addHeader(java.lang.String, java.lang.String)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter build()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setCompression(java.lang.String)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setEndpoint(java.lang.String)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setTimeout(long, java.util.concurrent.TimeUnit)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setTimeout(java.time.Duration)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setTrustedCertificates(byte[])

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,5 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC ABSTRACT io.opentelemetry.sdk.resources.Resource (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) java.lang.Object getAttribute(io.opentelemetry.api.common.AttributeKey)
+++ NEW ANNOTATION: javax.annotation.Nullable

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -0,0 +1,10 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSampler (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) void close()
+++ NEW CLASS: PUBLIC(+) io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerProvider (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW CONSTRUCTOR: PUBLIC(+) JaegerRemoteSamplerProvider()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.samplers.Sampler createSampler(io.opentelemetry.sdk.autoconfigure.ConfigProperties)
+++ NEW METHOD: PUBLIC(+) java.lang.String getName()

View File

@ -0,0 +1,10 @@
Comparing source compatibility of against
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.extension.resources.ContainerResource (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.resources.Resource get()
+++ NEW CLASS: PUBLIC(+) io.opentelemetry.sdk.extension.resources.ContainerResourceProvider (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW CONSTRUCTOR: PUBLIC(+) ContainerResourceProvider()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.Resource createResource(io.opentelemetry.sdk.autoconfigure.ConfigProperties)

View File

@ -0,0 +1,18 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.AttributesAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.AttributesAssert containsEntry(io.opentelemetry.api.common.AttributeKey, int)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.AttributesAssert containsKey(io.opentelemetry.api.common.AttributeKey)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.AttributesAssert containsKey(java.lang.String)
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.SpanDataAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.SpanDataAssert hasException(java.lang.Throwable)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.SpanDataAssert hasNoParent()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.SpanDataAssert hasParent(io.opentelemetry.sdk.trace.data.SpanData)
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.TraceAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.data.SpanData getSpan(int)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.TraceAssert hasSpansSatisfyingExactly(java.lang.Iterable)
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.TracesAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.TracesAssert hasTracesSatisfyingExactly(java.lang.Iterable)

View File

@ -0,0 +1,9 @@
Comparing source compatibility of against
**** MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.trace.ReadableSpan (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++* NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.api.trace.SpanContext getParentSpanContext()
***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.trace.samplers.SamplingResult (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult drop()
+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult recordAndSample()
+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult recordOnly()

View File

@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.

View File

@ -1,4 +1,2 @@
Comparing source compatibility of against
***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.context.ContextStorage (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.context.Context root()
No changes.

View File

@ -1,17 +1,2 @@
Comparing source compatibility of against
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder builder()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.common.CompletableResultCode export(java.util.Collection)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.common.CompletableResultCode flush()
+++ NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter getDefault()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.common.CompletableResultCode shutdown()
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder addHeader(java.lang.String, java.lang.String)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter build()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setCompression(java.lang.String)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setEndpoint(java.lang.String)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setTimeout(long, java.util.concurrent.TimeUnit)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setTimeout(java.time.Duration)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder setTrustedCertificates(byte[])
No changes.

View File

@ -1,5 +1,2 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC ABSTRACT io.opentelemetry.sdk.resources.Resource (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) java.lang.Object getAttribute(io.opentelemetry.api.common.AttributeKey)
+++ NEW ANNOTATION: javax.annotation.Nullable
No changes.

View File

@ -1,10 +1,2 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSampler (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) void close()
+++ NEW CLASS: PUBLIC(+) io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerProvider (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW CONSTRUCTOR: PUBLIC(+) JaegerRemoteSamplerProvider()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.samplers.Sampler createSampler(io.opentelemetry.sdk.autoconfigure.ConfigProperties)
+++ NEW METHOD: PUBLIC(+) java.lang.String getName()
No changes.

View File

@ -1,10 +1,2 @@
Comparing source compatibility of against
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.extension.resources.ContainerResource (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.resources.Resource get()
+++ NEW CLASS: PUBLIC(+) io.opentelemetry.sdk.extension.resources.ContainerResourceProvider (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW CONSTRUCTOR: PUBLIC(+) ContainerResourceProvider()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.Resource createResource(io.opentelemetry.sdk.autoconfigure.ConfigProperties)
No changes.

View File

@ -1,18 +1,2 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.AttributesAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.AttributesAssert containsEntry(io.opentelemetry.api.common.AttributeKey, int)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.AttributesAssert containsKey(io.opentelemetry.api.common.AttributeKey)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.AttributesAssert containsKey(java.lang.String)
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.SpanDataAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.SpanDataAssert hasException(java.lang.Throwable)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.SpanDataAssert hasNoParent()
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.SpanDataAssert hasParent(io.opentelemetry.sdk.trace.data.SpanData)
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.TraceAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.data.SpanData getSpan(int)
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.TraceAssert hasSpansSatisfyingExactly(java.lang.Iterable)
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.testing.assertj.TracesAssert (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.testing.assertj.TracesAssert hasTracesSatisfyingExactly(java.lang.Iterable)
No changes.

View File

@ -1,9 +1,2 @@
Comparing source compatibility of against
**** MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.trace.ReadableSpan (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++* NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.api.trace.SpanContext getParentSpanContext()
***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.trace.samplers.SamplingResult (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult drop()
+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult recordAndSample()
+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult recordOnly()
No changes.