Skip to content

Commit 9b10152

Browse files
jack-bergjack-berg
authored
Prepare for 1.23.0 release (#5189)
* Prepare changelog for 1.23.0 release * Add missing since annotations * Adjust releasing docs * Add new changelog entries, add event API artifact to readme * PR feedback * PR feedback
1 parent 7bbd5af commit 9b10152

File tree

5 files changed

+117
-9
lines changed

5 files changed

+117
-9
lines changed

‎CHANGELOG.md

+100
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,106 @@
22

33
## Unreleased
44

5+
This release is a notable release for metrics:
6+
7+
* The base2 exponential histogram aggregation has been marked as stable. To use, configure
8+
your `MetricExporter` with a default aggregation
9+
of `Aggregation.base2ExponentialBucketHistogram()` for histogram instruments. If using OTLP
10+
exporter with autoconfigure,
11+
set `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION=BASE2_EXPONENTIAL_BUCKET_HISTOGRAM`.
12+
If using configuring OTLP programatically,
13+
use `Otlp*MetricExporterBuilder#setDefaultAggregationSelector(DefaultAggregationSelector)`.
14+
* The metrics SDK undergone significant internal refactoring which results in reduced complexity and
15+
significantly reduced memory allocation during metric collection / export.
16+
17+
### API
18+
19+
#### Logs
20+
21+
* WARNING: Split out Event API from Log API. Event API is now published in `opentelemetry-api-events`.
22+
API / SDK usage has also changed - see PR for details.
23+
([#5049](https://github.com/open-telemetry/opentelemetry-java/pull/5049))
24+
25+
### SDK
26+
27+
* Add shutdown / close to `OpenTelemetrySdk`
28+
([#5100](https://github.com/open-telemetry/opentelemetry-java/pull/5100))
29+
30+
#### Metrics
31+
32+
* Base2 exponential histogram aggregations are now stable. Add `base2ExponentialBucketHistogram()`
33+
to `Aggregation`.
34+
([#5143](https://github.com/open-telemetry/opentelemetry-java/pull/5143))
35+
* Promote exponential histogram data interfaces to stable package
36+
([#5120](https://github.com/open-telemetry/opentelemetry-java/pull/5120))
37+
* Add Base2 prefix to internal exponential histogram classes
38+
([#5179](https://github.com/open-telemetry/opentelemetry-java/pull/5179))
39+
* Add MaxScale config parameter to `Base2ExponentialBucketHistogram`
40+
([#5044](https://github.com/open-telemetry/opentelemetry-java/pull/5044))
41+
* Add close method to `MetricReader`
42+
([#5109](https://github.com/open-telemetry/opentelemetry-java/pull/5109))
43+
* Reuse `AggregatorHandle` with cumulative temporality to reduce allocations
44+
([#5142](https://github.com/open-telemetry/opentelemetry-java/pull/5142))
45+
* Delete notion of accumulation to reduce allocations
46+
([#5154](https://github.com/open-telemetry/opentelemetry-java/pull/5154))
47+
* Delete bound instruments
48+
([#5157](https://github.com/open-telemetry/opentelemetry-java/pull/5157))
49+
* Reuse aggregation handles for delta temporality to reduce allocations
50+
([#5176](https://github.com/open-telemetry/opentelemetry-java/pull/5176))
51+
52+
#### Exporter
53+
54+
* Add proper shutdown implementations for all exporters
55+
([#5113](https://github.com/open-telemetry/opentelemetry-java/pull/5113))
56+
57+
#### SDK Extensions
58+
59+
* WARNING: Remove deprecated autoconfigure exemplar filter names. Previous names `none`, `all`
60+
, `with_sampled_trace` have been removed. Use `always_off`, `always_on`, `trace_based` instead.
61+
([#5098](https://github.com/open-telemetry/opentelemetry-java/pull/5098))
62+
* Add autoconfigure support for "none" option for propagator value
63+
([#5121](https://github.com/open-telemetry/opentelemetry-java/pull/5121))
64+
* Add autoconfigure support for `parentbased_jaeger_remote` sampler
65+
([#5123](https://github.com/open-telemetry/opentelemetry-java/pull/5123))
66+
* Autoconfigure closes up autoconfigured resources in case of exception
67+
([#5117](https://github.com/open-telemetry/opentelemetry-java/pull/5117))
68+
* View file based config has switched from snakeyaml to snakeyaml-engine for YAML parsing.
69+
([#5138](https://github.com/open-telemetry/opentelemetry-java/pull/5138))
70+
* Fix autoconfigure resource providers property docs
71+
([#5135](https://github.com/open-telemetry/opentelemetry-java/pull/5135))
72+
73+
#### Testing
74+
75+
* WARNING: Merge `opentelemetry-sdk-metrics-testing` into `opentelemetry-sdk-testing`. Stop
76+
publishing `opentelemetry-sdk-metrics-testing`.
77+
([#5144](https://github.com/open-telemetry/opentelemetry-java/pull/5144))
78+
* Sort spans by start time (parents before children as tiebreaker) to avoid common causes for flaky
79+
tests
80+
([#5026](https://github.com/open-telemetry/opentelemetry-java/pull/5026))
81+
* Add resource assertion methods to `SpanDataAssert` and `MetricAssert`
82+
([#5160](https://github.com/open-telemetry/opentelemetry-java/pull/5160))
83+
84+
85+
### Semantic Conventions
86+
87+
* Update semconv to 1.18.0
88+
([#5188](https://github.com/open-telemetry/opentelemetry-java/pull/5188))
89+
([#5134](https://github.com/open-telemetry/opentelemetry-java/pull/5134))
90+
91+
### OpenTracing Shim
92+
93+
* Refactor to remove internal objects `BaseShimObject` and `TelemetryInfo`
94+
([#5087](https://github.com/open-telemetry/opentelemetry-java/pull/5087))
95+
* WARNING: Minimize public surface area of OpenTracingShim. Remove `createTracerShim()`
96+
, `createTracerShim(Tracer)`, `createTracerShim(Tracer, OpenTracingPropagators)`.
97+
Add `createTracerShim(TracerProvder,TextMapPropagator,TextMapPropagator)`.
98+
([#5110](https://github.com/open-telemetry/opentelemetry-java/pull/5110))
99+
100+
### Project tooling
101+
102+
* Add OWASP dependency check
103+
([#5177](https://github.com/open-telemetry/opentelemetry-java/pull/5177))
104+
5105
## Version 1.22.0 (2023-01-06)
6106

7107
### API

‎README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -221,12 +221,13 @@ dependency as follows, replacing `{{artifact-id}}` with the value from the "Arti
221221

222222
### API
223223

224-
| Component | Description | Artifact ID | Version |
225-
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|-------------------------------------------------------------|
226-
| [API](./api/all) | OpenTelemetry API, including metrics, traces, baggage, context | `opentelemetry-api` | <!--VERSION_STABLE-->1.22.0<!--/VERSION_STABLE--> |
227-
| [Logs API](./api/logs) | OpenTelemetry Log API for emitting events and bridging log frameworks (NOT a replacement for application logging frameworks like SLF4J, JUL, etc.) | `opentelemetry-api-logs` | <!--VERSION_UNSTABLE-->1.22.0-alpha<!--/VERSION_UNSTABLE--> |
228-
| [Context API](./context) | OpenTelemetry context API | `opentelemetry-context` | <!--VERSION_STABLE-->1.22.0<!--/VERSION_STABLE--> |
229-
| [Semantic Conventions](./semconv) | Generated code for OpenTelemetry semantic conventions | `opentelemetry-semconv` | <!--VERSION_UNSTABLE-->1.22.0-alpha<!--/VERSION_UNSTABLE--> |
224+
| Component | Description | Artifact ID | Version |
225+
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------|----------------------------|-------------------------------------------------------------|
226+
| [API](./api/all) | OpenTelemetry API, including metrics, traces, baggage, context | `opentelemetry-api` | <!--VERSION_STABLE-->1.22.0<!--/VERSION_STABLE--> |
227+
| [Events API](./api/logs) | OpenTelemetry Event API for emitting events. | `opentelemetry-api-events` | <!--VERSION_UNSTABLE-->TODO<!--/VERSION_UNSTABLE--> |
228+
| [Logs API](./api/logs) | OpenTelemetry Log API for bridging log frameworks (NOT a replacement for application logging frameworks like SLF4J, JUL, etc.) | `opentelemetry-api-logs` | <!--VERSION_UNSTABLE-->1.22.0-alpha<!--/VERSION_UNSTABLE--> |
229+
| [Context API](./context) | OpenTelemetry context API | `opentelemetry-context` | <!--VERSION_STABLE-->1.22.0<!--/VERSION_STABLE--> |
230+
| [Semantic Conventions](./semconv) | Generated code for OpenTelemetry semantic conventions | `opentelemetry-semconv` | <!--VERSION_UNSTABLE-->1.22.0-alpha<!--/VERSION_UNSTABLE--> |
230231

231232
### API Extensions
232233

‎RELEASING.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ directory. Additionally, ensure that appropriate `@since` annotations are added
66
the public APIs.
77

88
When preparing the change log, you can use
9-
`git log upstream/v$MAJOR.$((MINOR-1)).x..upstream/v$MAJOR.$MINOR.x --graph --first-parent`
10-
or the Github [compare tool](https://github.com/open-telemetry/opentelemetry-java/compare/)
11-
to view a summary of all commits since last release as a reference.
9+
the [draft-change-log-entries.sh](./.github/scripts/draft-change-log-entries.sh) script to assist
10+
with drafting. Alternatively,
11+
use `git log upstream/v$MAJOR.$((MINOR-1)).x..upstream/v$MAJOR.$MINOR.x --graph --first-parent` or
12+
the Github [compare tool](https://github.com/open-telemetry/opentelemetry-java/compare/) to view a
13+
summary of all commits since last release as a reference.
1214

1315
## Release cadence
1416

‎sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/Aggregation.java

+3
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ static Aggregation explicitBucketHistogram(List<Double> bucketBoundaries) {
7272
/**
7373
* Aggregates measurements into a base-2 {@link MetricDataType#EXPONENTIAL_HISTOGRAM} using the
7474
* default {@code maxBuckets} and {@code maxScale}.
75+
*
76+
* @since 1.23.0
7577
*/
7678
static Aggregation base2ExponentialBucketHistogram() {
7779
return Base2ExponentialHistogramAggregation.getDefault();
@@ -86,6 +88,7 @@ static Aggregation base2ExponentialBucketHistogram() {
8688
* given the {@code maxBuckets}, the scale is reduced until the measurements can be
8789
* accommodated. Setting maxScale may reduce the number of downscales. Additionally, the
8890
* performance of computing bucket index is improved when scale is {@code <= 0}.
91+
* @since 1.23.0
8992
*/
9093
static Aggregation base2ExponentialBucketHistogram(int maxBuckets, int maxScale) {
9194
return Base2ExponentialHistogramAggregation.create(maxBuckets, maxScale);

‎sdk/testing/src/main/java/io/opentelemetry/sdk/testing/assertj/TracesAssert.java

+2
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ public final class TracesAssert
4545
/**
4646
* Returns an assertion for a list of traces. The provided spans will be grouped into traces by
4747
* their trace ID.
48+
*
49+
* @since 1.23.0
4850
*/
4951
public static TracesAssert assertThat(List<SpanData> spanData) {
5052
Map<String, List<SpanData>> traces =

0 commit comments

Comments
 (0)