From 95949e0713df019b1742fd0df83c1079ccd19930 Mon Sep 17 00:00:00 2001 From: jack-berg <34418638+jack-berg@users.noreply.github.com> Date: Sun, 10 Oct 2021 22:05:52 -0500 Subject: [PATCH] Remove autoconfigure otlp protocol experimental properties (#3718) * Remove autoconfigure otel.experimental.exporter.otlp.protocol and otel.experimental.exporter.otlp.{signal}.protocol properties * Add entry to changelog --- CHANGELOG.md | 6 +++++ sdk-extensions/autoconfigure/README.md | 3 --- .../sdk/autoconfigure/OtlpConfigUtil.java | 6 ----- .../sdk/autoconfigure/OtlpConfigUtilTest.java | 27 +++---------------- 4 files changed, 9 insertions(+), 33 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ab4d48565..406ff1e8ee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## Version 1.8.0 (unreleased): +### Auto-configuration (alpha) + +- BREAKING CHANGE: Remove deprecated `otel.experimental.exporter.otlp.protocol`, + `otel.experimental.exporter.otlp.{signal}.protocol` properties. Please use + `otel.exporter.otlp.protocol`, `otel.exporter.otlp.{signal}.protocol` instead. + --- ## Version 1.7.0 (2021-10-08): diff --git a/sdk-extensions/autoconfigure/README.md b/sdk-extensions/autoconfigure/README.md index 265b590794..7e756fe6b1 100644 --- a/sdk-extensions/autoconfigure/README.md +++ b/sdk-extensions/autoconfigure/README.md @@ -68,9 +68,6 @@ The [OpenTelemetry Protocol (OTLP)](https://github.com/open-telemetry/openteleme | otel.exporter.otlp.protocol | OTEL_EXPORTER_OTLP_PROTOCOL | The transport protocol to use on OTLP trace and metrics requests. Options include `grpc` and `http/protobuf`. Default is `grpc`. | | otel.exporter.otlp.traces.protocol | OTEL_EXPORTER_OTLP_TRACES_PROTOCOL | The transport protocol to use on OTLP trace requests. Options include `grpc` and `http/protobuf`. Default is `grpc`. | | otel.exporter.otlp.metrics.protocol | OTEL_EXPORTER_OTLP_METRICS_PROTOCOL | The transport protocol to use on OTLP metrics requests. Options include `grpc` and `http/protobuf`. Default is `grpc`. | -| otel.experimental.exporter.otlp.protocol | OTEL_EXPERIMENTAL_EXPORTER_OTLP_PROTOCOL | **DEPRECATED for removal in 1.8.0.** The transport protocol to use on OTLP trace and metrics requests. Options include `grpc` and `http/protobuf`. Default is `grpc`. | -| otel.experimental.exporter.otlp.traces.protocol | OTEL_EXPERIMENTAL_EXPORTER_OTLP_TRACES_PROTOCOL | **DEPRECATED for removal in 1.8.0.** The transport protocol to use on OTLP trace requests. Options include `grpc` and `http/protobuf`. Default is `grpc`. | -| otel.experimental.exporter.otlp.metrics.protocol | OTEL_EXPERIMENTAL_EXPORTER_OTLP_METRICS_PROTOCOL | **DEPRECATED for removal in 1.8.0.** The transport protocol to use on OTLP metrics requests. Options include `grpc` and `http/protobuf`. Default is `grpc`. | To configure the service name for the OTLP exporter, add the `service.name` key to the OpenTelemetry Resource ([see below](#opentelemetry-resource)), e.g. `OTEL_RESOURCE_ATTRIBUTES=service.name=myservice`. diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtil.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtil.java index 250178d283..e30b2a7e9a 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtil.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtil.java @@ -31,12 +31,6 @@ final class OtlpConfigUtil { if (protocol == null) { protocol = config.getString("otel.exporter.otlp.protocol"); } - if (protocol == null) { - protocol = config.getString("otel.experimental.exporter.otlp." + dataType + ".protocol"); - } - if (protocol == null) { - protocol = config.getString("otel.experimental.exporter.otlp.protocol"); - } return (protocol == null) ? PROTOCOL_GRPC : protocol; } diff --git a/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtilTest.java b/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtilTest.java index 4b8d88b601..0879abede0 100644 --- a/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtilTest.java +++ b/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/OtlpConfigUtilTest.java @@ -38,7 +38,7 @@ class OtlpConfigUtilTest { OtlpConfigUtil.getOtlpProtocol( DATA_TYPE_TRACES, DefaultConfigProperties.createForTest( - ImmutableMap.of("otel.experimental.exporter.otlp.protocol", "foo")))) + ImmutableMap.of("otel.exporter.otlp.protocol", "foo")))) .isEqualTo("foo"); assertThat( @@ -46,30 +46,9 @@ class OtlpConfigUtilTest { DATA_TYPE_TRACES, DefaultConfigProperties.createForTest( ImmutableMap.of( - "otel.experimental.exporter.otlp.protocol", "foo", - "otel.experimental.exporter.otlp.traces.protocol", "bar")))) + "otel.exporter.otlp.protocol", "foo", + "otel.exporter.otlp.traces.protocol", "bar")))) .isEqualTo("bar"); - - assertThat( - OtlpConfigUtil.getOtlpProtocol( - DATA_TYPE_TRACES, - DefaultConfigProperties.createForTest( - ImmutableMap.of( - "otel.experimental.exporter.otlp.protocol", "foo", - "otel.experimental.exporter.otlp.traces.protocol", "bar", - "otel.exporter.otlp.protocol", "baz")))) - .isEqualTo("baz"); - - assertThat( - OtlpConfigUtil.getOtlpProtocol( - DATA_TYPE_TRACES, - DefaultConfigProperties.createForTest( - ImmutableMap.of( - "otel.experimental.exporter.otlp.protocol", "foo", - "otel.experimental.exporter.otlp.traces.protocol", "bar", - "otel.exporter.otlp.protocol", "baz", - "otel.exporter.otlp.traces.protocol", "qux")))) - .isEqualTo("qux"); } @Test