Skip to content

Commit

Permalink
Update the CHANGELOG.md for the upcoming 1.7.0 release (#3707)
Browse files Browse the repository at this point in the history
* Update the CHANGELOG.md for the upcoming 1.7.0 release

* formatting

* updates for metric name changes and deprecation of the proto module
  • Loading branch information
jkwatson authored Oct 8, 2021
1 parent c7c352b commit 33094f4
Showing 1 changed file with 38 additions and 5 deletions.
43 changes: 38 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,36 @@

## Version 1.7.0 (unreleased):

### General

- IMPORTANT: The `io.opentelemetry:opentelemetry-proto` module should now be considered
*deprecated*. It will be removed from publications in a future release. If you need Java bindings
for the OTLP protobufs, they are now being published via the
new [opentelemetry-proto-java](https://github.com/open-telemetry/opentelemetry-proto-java)
repository. They are at new maven coordinates: `io.opentelemetry.proto:opentelemetry-proto` and
versioning is aligned with the released version of the protobuf definitions themselves.

### SDK

#### Exporters

- BREAKING CHANGE: The Jaeger gRPC exporter does not directly use the `protobuf-java` library for
marshaling trace data. Along with this, the `opentelemetry-exporter-jaeger` artifact does not
contain generated protobuf classes for the Jaeger API. If you were using these in your application,
you must update your build configuration to also include the new `jaeger-proto` artifact. This
artifact will not be included in a future 2.0 release of the SDK so it is recommended to instead
generated the protobuf classes in your own build.
marshaling trace data. Along with this, the `opentelemetry-exporter-jaeger` artifact does not
contain generated protobuf classes for the Jaeger API. If you were using these in your
application, you must update your build configuration to also include the new `jaeger-proto`
artifact. This artifact will not be included in a future 2.0 release of the SDK so it is
recommended to instead generated the protobuf classes in your own build.
- BREAKING CHANGE: The `opentelemetry-exporter-otlp-http-*` exporter default endpoint ports have
changed from `4317` to `4318`, in line
with [recent changes](https://github.com/open-telemetry/opentelemetry-specification/pull/1970) to
the spec.
- The OTLP gRPC exporters will now function without the `grpc-java` dependency, if `okhttp` is
present on the classpath.
- The (alpha) metrics that are generated by the gRPC exporters have changed slightly. They now have
a slightly different instrumentation library name, `"io.opentelemetry.exporters.otlp-grpc"` and
the names of the metrics have also changed. Now emitted are metrics with
names `otlp.exporter.seen` and `otlp.exported.exported`. Note that it is likely this will change
in the future as the metrics semantic conventions are more defined.

### Auto-configuration (alpha)

Expand All @@ -26,6 +42,23 @@ generated the protobuf classes in your own build.
appended to the configured endpoint. Values for signal specific endpoint configuration (
e.g. `otel.exporter.otlp.traces.endpoint` and `otel.exporter.otlp.metrics.endpoint`) override the
generic endpoint configuration and are used as-is without modification.
- The `compression` option for exporters now explicitly supports the `none` value, in addition to the existing `gzip` value.

### Metrics (alpha)

- BREAKING CHANGE: The `IntervalMetricReader` has been removed, and replaced with
a `PeriodicMetricReader` that provides an implementation of the new `MetricReader` interface.
- This release includes initial support for multiple exporters to be configured for a single SDK
instance. See the `SdkMeterProviderBuilder.registerMetricReader` method for more details.
- This release includes initial support for the SDK recording of Metric Exemplars for sampled Spans.
See `SdkMeterProviderBuilder.setExemplarFilter` and the `ExemplarFilter` interface for
more details.

### Logging (alpha)

- This release includes SDK extension interfaces for `LogProcessor`s and `LogExporter`s, and has
implementations for batch log processing and export via OTLP. These classes are intended for usage
in implementations of log appenders that emit OTLP log entries.

## Version 1.6.0 (2021-09-13):

Expand Down

0 comments on commit 33094f4

Please sign in to comment.