Update docs for 1.11.0 release (#4152)

* Update changelog

* Update version in docs

* Add OTLP log exporter component to readme table

* Update japicmp

* Add note to create discussion to release docs
This commit is contained in:
jack-berg 2022-02-04 18:25:56 -06:00 committed by GitHub
parent 5c1bd6cbfe
commit 562153dc7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
31 changed files with 163 additions and 60 deletions

View File

@ -1,14 +1,56 @@
# Changelog
## Version 1.11.0 (unreleased):
## Version 1.12.0 (unreleased):
## Version 1.11.0 2022-02-04:
### General
* Examples moved
to [opentelemetry-java-docs](https://github.com/open-telemetry/opentelemetry-java-docs)
### SDK
#### Exporter
* Switch Jaeger remote sampler to use grpc lite
* Deprecate `.setChannel(ManagedChannel)` methods on OTLP gRPC exporters
* Deprecate `.setChannel(ManagedChannel)` methods on Jaeger gRPC exporter
* Experimental OTLP retry support now retries on connection timeouts
#### Metrics
* BREAKING Change: Deprecated `InMemoryMetricExporter` and `InMemoryMetricReader` have been removed.
Use versions in `opentelemetry-sdk-metrics-testing` instead
* Deprecate `InstrumentType` values `OBSERVABLE_SUM` and `OBSERVABLE_UP_DOWN_SUM` in favor
of `OBSERVABLE_COUNTER` and `OBSERVABLE_UP_DOWN_COUNTER`
#### Logs
* Add ability to configure log attribute limits via `SdkLogEmitterProviderBuilder#setLogLimits(..)`
#### SDK Extensions
* Auto-configuration added options to `AutoConfigurationCustomizer` for
customizing `SdkTracerProviderBuilder`, `SdkMeterProviderBuilder`, `MetricExporter`
, `SdkLogEmitterProviderBuilder`, and `LogExporter`
* Auto-configuration added option to skip shutdown hooks
* Auto-configuration adjusted the execution order of tracer and meter provider customization to
happen after autoconfiguration
* Auto-configuration adjusted SPI factories to evaluate lazily
* Auto-configuration now uses sets configured `SdkMeterProvider` on `BatchLogProcessor`
and `BatchSpanProcessor`
* Auto-configuration deprecated `SdkTracerProviderConfigurer` in favor
of `AutoConfigurationCustomizer#addTracerProviderCustomizer(..)`
---
## Version 1.10.1 2022-01-21:
### Bugfixes
- Fix issue preventing registration of PrometheusCollector with SDK
- Allow retry policy to be set for OkHttpGrpcExporter
* Fix issue preventing registration of PrometheusCollector with SDK
* Allow retry policy to be set for OkHttpGrpcExporter
---
@ -17,15 +59,22 @@
### API
* Performance of `GlobalOpenTelemetry.get` improved
* `buildWithCallback` for asynchronous metrics now return interfaces instead of void. The interfaces are empty but will allow adding functionality in the future
* `buildWithCallback` for asynchronous metrics now return interfaces instead of void. The interfaces
are empty but will allow adding functionality in the future
* BREAKING CHANGE: `Double/LongMeasurement.observe` have been removed
* BREAKING CHANGE: `GlobalMeterProvider` has been removed
* BREAKING CHANGE: `ObservableMeasurement`, an empty interface, has been removed. This type was not previously deprecated but is expected to have no use in apps due to the lack of functionality
* The Metrics API has been merged into the `opentelemetry-api` artifact. `OpenTelemetry.getMeterProvider()` is the new entrypoint
* BREAKING CHANGE: Bound metrics instruments have been removed for now to allow more time to bake while still providing a stable metrics API
* `Double/LongMeasurement.observe` has been renamed to `record`.`observe` is deprecated in this release
* `GlobalMeterProvider` has been deprecated. `GlobalOpenTelemetry.getMeterProvider` should be used instead
* A warning is logged now when registering async instruments with the same name. Previously subsequent invocations were just ignored.
* BREAKING CHANGE: `ObservableMeasurement`, an empty interface, has been removed. This type was not
previously deprecated but is expected to have no use in apps due to the lack of functionality
* The Metrics API has been merged into the `opentelemetry-api`
artifact. `OpenTelemetry.getMeterProvider()` is the new entrypoint
* BREAKING CHANGE: Bound metrics instruments have been removed for now to allow more time to bake
while still providing a stable metrics API
* `Double/LongMeasurement.observe` has been renamed to `record`.`observe` is deprecated in this
release
* `GlobalMeterProvider` has been deprecated. `GlobalOpenTelemetry.getMeterProvider` should be used
instead
* A warning is logged now when registering async instruments with the same name. Previously
subsequent invocations were just ignored.
* `GlobalOpenTelemetry` extended with helpers for meter creation
### SDK
@ -34,6 +83,7 @@
* Deprecated methods have been removed from the `opentelemetry-sdk-autoconfigure` artifact.
#### Exporter
* The OkHttp gRPC exporters now support experimental retry
* OkHttp dispatcher threads are now spawned as daemon threads
* The JPMS module name for the logs exporter has been fixed
@ -44,7 +94,8 @@
#### Metrics
* `InMemoryMetricExporter` has been moved to the `opentelemetry-sdk-metrics-testing` artifact. The current class has been deprecated in this release
* `InMemoryMetricExporter` has been moved to the `opentelemetry-sdk-metrics-testing` artifact. The
current class has been deprecated in this release
* Metric instrument usage violations consistently report issues as debug logs
* Some user callbacks have been wrapped to catch exceptions instead of throwing
* MinMaxSumCount/Count aggregation has been removed
@ -68,7 +119,9 @@
* Exceptions are not thrown when activating a null span
#### SDK Extensions
* BREAKING CHANGE: Deprecated trace incubator types (DelegatingSpanData, SpanDataBuidler) have been removed
* BREAKING CHANGE: Deprecated trace incubator types (DelegatingSpanData, SpanDataBuidler) have been
removed
* BREAKING CHANGE: Deprecated `ExecutorServiceSpanProcessor` has been removed
* `cloud.platform` is now populated in AWS `Resource`
* Auto-configuration correctly uses configured class loader for configuring Resource

View File

@ -81,7 +81,7 @@ dependency versions in sync.
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.10.1</version>
<version>1.11.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@ -100,7 +100,7 @@ dependency versions in sync.
```groovy
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.10.1")
implementation platform("io.opentelemetry:opentelemetry-bom:1.11.0")
implementation('io.opentelemetry:opentelemetry-api')
}
```
@ -109,8 +109,8 @@ Note that if you want to use any artifacts that have not fully stabilized yet (s
```groovy
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.10.1")
implementation platform('io.opentelemetry:opentelemetry-bom-alpha:1.10.1-alpha')
implementation platform("io.opentelemetry:opentelemetry-bom:1.11.0")
implementation platform('io.opentelemetry:opentelemetry-bom-alpha:1.11.0-alpha')
implementation('io.opentelemetry:opentelemetry-api')
implementation('io.opentelemetry:opentelemetry-api-metrics')
@ -137,7 +137,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.11.0-SNAPSHOT</version>
<version>1.12.0-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@ -160,7 +160,7 @@ repositories {
}
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.11.0-SNAPSHOT")
implementation platform("io.opentelemetry:opentelemetry-bom:1.12.0-SNAPSHOT")
implementation('io.opentelemetry:opentelemetry-api')
}
```
@ -184,22 +184,23 @@ Check out information about the [latest release](https://github.com/open-telemet
This is a **current** feature status list:
| Component | Version |
| --------------------------- | ------- |
| Trace API | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| Trace SDK | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| Context | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| Baggage | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| Jaeger Trace Exporter | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| Zipkin Trace Exporter | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| OTLP Exporter (Spans) | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| Metrics API | v<!--VERSION_STABLE-->1.10.1<!--/VERSION_STABLE--> |
| OTLP Exporter (Metrics) | v<!--VERSION_UNSTABLE-->1.10.1-alpha<!--/VERSION_UNSTABLE--> |
| Metrics SDK | v<!--VERSION_UNSTABLE-->1.10.1-alpha<!--/VERSION_UNSTABLE--> |
| Logs SDK | v<!--VERSION_UNSTABLE-->1.10.1-alpha<!--/VERSION_UNSTABLE--> |
| Prometheus Metrics Exporter | v<!--VERSION_UNSTABLE-->1.10.1-alpha<!--/VERSION_UNSTABLE--> |
| OpenTracing Bridge | v<!--VERSION_UNSTABLE-->1.10.1-alpha<!--/VERSION_UNSTABLE--> |
| OpenCensus Bridge | v<!--VERSION_UNSTABLE-->1.10.1-alpha<!--/VERSION_UNSTABLE--> |
| Component | Version |
|-----------------------------|--------------------------------------------------------------|
| Trace API | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| Trace SDK | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| Context | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| Baggage | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| Jaeger Trace Exporter | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| Zipkin Trace Exporter | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Spans) | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| Metrics API | v<!--VERSION_STABLE-->1.11.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Metrics) | v<!--VERSION_UNSTABLE-->1.11.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics SDK | v<!--VERSION_UNSTABLE-->1.11.0-alpha<!--/VERSION_UNSTABLE--> |
| OTLP Exporter (Logs) | v<!--VERSION_UNSTABLE-->1.11.0-alpha<!--/VERSION_UNSTABLE--> |
| Logs SDK | v<!--VERSION_UNSTABLE-->1.11.0-alpha<!--/VERSION_UNSTABLE--> |
| Prometheus Metrics Exporter | v<!--VERSION_UNSTABLE-->1.11.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenTracing Bridge | v<!--VERSION_UNSTABLE-->1.11.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenCensus Bridge | v<!--VERSION_UNSTABLE-->1.11.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

@ -16,10 +16,11 @@ documentation, because the Github Actions cannot push changes to the main branch
## Announcement
Once the GitHub workflow completes, go to Github [release
page](https://github.com/open-telemetry/opentelemetry-java/releases), press
Once the GitHub workflow completes, go to
Github [release page](https://github.com/open-telemetry/opentelemetry-java/releases), press
`Draft a new release` to write release notes about the new release. If there is already a draft
release notes, just point it at the created tag.
release notes, just point it at the created tag. Click "Create a discussion for this release" and
select category "Announcements" to create a corresponding discussion upon publish.
You can use `git log upstream/v$MAJOR.$((MINOR-1)).x..upstream/v$MAJOR.$MINOR.x --graph --first-parent`
or the Github [compare tool](https://github.com/open-telemetry/opentelemetry-java/compare/)

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
=== UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.exporter.jaeger.JaegerGrpcSpanExporterBuilder (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
=== UNCHANGED METHOD: PUBLIC io.opentelemetry.exporter.jaeger.JaegerGrpcSpanExporterBuilder setChannel(io.grpc.ManagedChannel)
+++ NEW ANNOTATION: java.lang.Deprecated

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
=== UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
=== UNCHANGED METHOD: PUBLIC io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder setChannel(io.grpc.ManagedChannel)
+++ NEW ANNOTATION: java.lang.Deprecated

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,11 @@
Comparing source compatibility of against
***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addLogEmitterProviderCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addLogExporterCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addMeterProviderCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addMetricExporterCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addTracerProviderCustomizer(java.util.function.BiFunction)
=== UNCHANGED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.autoconfigure.spi.traces.SdkTracerProviderConfigurer (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW ANNOTATION: java.lang.Deprecated

View File

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

View File

@ -0,0 +1,6 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerBuilder (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
=== UNCHANGED METHOD: PUBLIC io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerBuilder setChannel(io.grpc.ManagedChannel)
+++ NEW ANNOTATION: java.lang.Deprecated
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerBuilder 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

@ -1,5 +1,2 @@
Comparing source compatibility of against
=== UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.exporter.jaeger.JaegerGrpcSpanExporterBuilder (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
=== UNCHANGED METHOD: PUBLIC io.opentelemetry.exporter.jaeger.JaegerGrpcSpanExporterBuilder setChannel(io.grpc.ManagedChannel)
+++ NEW ANNOTATION: java.lang.Deprecated
No changes.

View File

@ -1,5 +1,2 @@
Comparing source compatibility of against
=== UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
=== UNCHANGED METHOD: PUBLIC io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder setChannel(io.grpc.ManagedChannel)
+++ NEW ANNOTATION: java.lang.Deprecated
No changes.

View File

@ -1,11 +1,2 @@
Comparing source compatibility of against
***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addLogEmitterProviderCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addLogExporterCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addMeterProviderCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addMetricExporterCustomizer(java.util.function.BiFunction)
+++! NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer addTracerProviderCustomizer(java.util.function.BiFunction)
=== UNCHANGED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.autoconfigure.spi.traces.SdkTracerProviderConfigurer (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW ANNOTATION: java.lang.Deprecated
No changes.

View File

@ -1,6 +1,2 @@
Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerBuilder (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
=== UNCHANGED METHOD: PUBLIC io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerBuilder setChannel(io.grpc.ManagedChannel)
+++ NEW ANNOTATION: java.lang.Deprecated
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSamplerBuilder setTrustedCertificates(byte[])
No changes.