From 19b0fec81353c624d04b2ee848ee7e52fa4ddd39 Mon Sep 17 00:00:00 2001 From: jack-berg <34418638+jack-berg@users.noreply.github.com> Date: Thu, 10 Feb 2022 21:15:48 -0600 Subject: [PATCH] Deprecate log name field (#4160) * Deprecate log name field * Add deprecation description to javadoc --- .../logging/otlp/OtlpJsonLoggingLogExporterTest.java | 2 ++ .../exporter/otlp/http/logs/OtlpHttpLogExporterTest.java | 1 + .../exporter/internal/otlp/logs/LogMarshaler.java | 1 + .../internal/otlp/logs/LogsRequestMarshalerTest.java | 2 ++ .../exporter/otlp/logs/OtlpGrpcLogExporterTest.java | 1 + .../exporter/otlp/logs/OtlpGrpcNettyLogExporterTest.java | 1 + .../otlp/logs/OtlpGrpcNettyShadedLogExporterTest.java | 1 + .../otlp/logs/OtlpGrpcNettyOkHttpLogExporterTest.java | 1 + .../integrationtest/OtlpExporterIntegrationTest.java | 1 + .../opentelemetry/sdk/testing/assertj/LogDataAssert.java | 2 +- .../sdk/testing/assertj/LogAssertionsTest.java | 3 +++ .../main/java/io/opentelemetry/sdk/logs/SdkLogBuilder.java | 1 + .../main/java/io/opentelemetry/sdk/logs/data/LogData.java | 7 ++++++- .../io/opentelemetry/sdk/logs/data/LogDataBuilder.java | 7 ++++++- .../java/io/opentelemetry/sdk/logs/data/LogDataImpl.java | 2 ++ .../java/io/opentelemetry/sdk/logs/SdkLogBuilderTest.java | 1 + .../test/java/io/opentelemetry/sdk/logs/util/TestUtil.java | 1 - 17 files changed, 31 insertions(+), 4 deletions(-) diff --git a/exporters/logging-otlp/src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java b/exporters/logging-otlp/src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java index 75b42f709d..2c1ae66fe0 100644 --- a/exporters/logging-otlp/src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java +++ b/exporters/logging-otlp/src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java @@ -36,6 +36,7 @@ class OtlpJsonLoggingLogExporterTest { private static final Resource RESOURCE = Resource.create(Attributes.builder().put("key", "value").build()); + @SuppressWarnings("deprecation") // test deprecated setName method private static final LogData LOG1 = LogDataBuilder.create(RESOURCE, InstrumentationLibraryInfo.create("instrumentation", "1")) .setName("testLog1") @@ -52,6 +53,7 @@ class OtlpJsonLoggingLogExporterTest { TraceState.getDefault())) .build(); + @SuppressWarnings("deprecation") // test deprecated setName method private static final LogData LOG2 = LogDataBuilder.create(RESOURCE, InstrumentationLibraryInfo.create("instrumentation2", "2")) .setName("testLog2") diff --git a/exporters/otlp-http/logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java b/exporters/otlp-http/logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java index 5cc65841f9..ce0e00d280 100644 --- a/exporters/otlp-http/logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java +++ b/exporters/otlp-http/logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java @@ -330,6 +330,7 @@ class OtlpHttpLogExporterTest { return HttpResponse.of(httpStatus, APPLICATION_PROTOBUF, message.toByteArray()); } + @SuppressWarnings("deprecation") // test deprecated setName method private static LogData generateFakeLog() { return LogDataBuilder.create( Resource.getDefault(), diff --git a/exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogMarshaler.java b/exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogMarshaler.java index 9feaf6d10a..32c297763c 100644 --- a/exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogMarshaler.java +++ b/exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogMarshaler.java @@ -36,6 +36,7 @@ final class LogMarshaler extends MarshalerWithSize { @Nullable private final String traceId; @Nullable private final String spanId; + @SuppressWarnings("deprecation") // name field to be removed static LogMarshaler create(io.opentelemetry.sdk.logs.data.LogData logData) { KeyValueMarshaler[] attributeMarshalers = KeyValueMarshaler.createRepeated(logData.getAttributes()); diff --git a/exporters/otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/logs/LogsRequestMarshalerTest.java b/exporters/otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/logs/LogsRequestMarshalerTest.java index d8a1cca826..f850978442 100644 --- a/exporters/otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/logs/LogsRequestMarshalerTest.java +++ b/exporters/otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/logs/LogsRequestMarshalerTest.java @@ -50,6 +50,7 @@ class LogsRequestMarshalerTest { private static final String BODY = "Hello world from this log..."; @Test + @SuppressWarnings("deprecation") // test deprecated setName method void toProtoResourceLogs() { ResourceLogsMarshaler[] resourceLogsMarshalers = ResourceLogsMarshaler.create( @@ -83,6 +84,7 @@ class LogsRequestMarshalerTest { } @Test + @SuppressWarnings("deprecation") // test deprecated setName method void toProtoLogRecord() { LogRecord logRecord = parse( diff --git a/exporters/otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogExporterTest.java b/exporters/otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogExporterTest.java index 0434f1f92f..6b6e3de271 100644 --- a/exporters/otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogExporterTest.java +++ b/exporters/otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogExporterTest.java @@ -104,6 +104,7 @@ class OtlpGrpcLogExporterTest extends AbstractGrpcTelemetryExporterTest { } /** Asserts the log has the given name. */ + @Deprecated public LogDataAssert hasName(String name) { isNotNull(); if (!name.equals(actual.getName())) { @@ -149,7 +150,6 @@ public class LogDataAssert extends AbstractAssert { actual.getAttributes(), attributes, "Expected log to have attributes <%s> but was <%s>", - actual.getName(), attributes, actual.getAttributes()); } diff --git a/sdk/logs-testing/src/test/java/io/opentelemetry/sdk/testing/assertj/LogAssertionsTest.java b/sdk/logs-testing/src/test/java/io/opentelemetry/sdk/testing/assertj/LogAssertionsTest.java index 48c91d777e..1af2e7d1b4 100644 --- a/sdk/logs-testing/src/test/java/io/opentelemetry/sdk/testing/assertj/LogAssertionsTest.java +++ b/sdk/logs-testing/src/test/java/io/opentelemetry/sdk/testing/assertj/LogAssertionsTest.java @@ -43,6 +43,7 @@ public class LogAssertionsTest { .put("coins", 0.01, 0.05, 0.1) .build(); + @SuppressWarnings("deprecation") // test deprecated setName method private static final LogData LOG_DATA = LogDataBuilder.create(RESOURCE, INSTRUMENTATION_LIBRARY_INFO) .setEpoch(100, TimeUnit.NANOSECONDS) @@ -57,6 +58,7 @@ public class LogAssertionsTest { .build(); @Test + @SuppressWarnings("deprecation") // test deprecated hasName method void passing() { assertThat(LOG_DATA) .hasResource(RESOURCE) @@ -113,6 +115,7 @@ public class LogAssertionsTest { } @Test + @SuppressWarnings("deprecation") // test deprecated hasName method void failure() { assertThatThrownBy(() -> assertThat(LOG_DATA).hasResource(Resource.empty())); assertThatThrownBy( diff --git a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLogBuilder.java b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLogBuilder.java index 361fba6e7a..244c5c98de 100644 --- a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLogBuilder.java +++ b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLogBuilder.java @@ -57,6 +57,7 @@ final class SdkLogBuilder implements LogBuilder { } @Override + @Deprecated public LogBuilder setName(String name) { logDataBuilder.setName(name); return this; diff --git a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogData.java b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogData.java index 4a0ea54193..848d96a9f1 100644 --- a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogData.java +++ b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogData.java @@ -39,7 +39,12 @@ public interface LogData { @Nullable String getSeverityText(); - /** Returns the name for this log, or null if unset. */ + /** + * Returns the name for this log, or null if unset. + * + * @deprecated will be removed without replacement. + */ + @Deprecated @Nullable String getName(); diff --git a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataBuilder.java b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataBuilder.java index 8993fb9eea..f5cf9fc0ad 100644 --- a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataBuilder.java +++ b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataBuilder.java @@ -85,7 +85,12 @@ public final class LogDataBuilder { return this; } - /** Set the name. */ + /** + * Set the name. + * + * @deprecated will be removed without replacement. + */ + @Deprecated public LogDataBuilder setName(String name) { this.name = name; return this; diff --git a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataImpl.java b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataImpl.java index 187bff26cd..d52eb551b1 100644 --- a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataImpl.java +++ b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataImpl.java @@ -14,7 +14,9 @@ import javax.annotation.Nullable; import javax.annotation.concurrent.Immutable; @AutoValue +@AutoValue.CopyAnnotations @Immutable +@SuppressWarnings("deprecation") // name field to be removed abstract class LogDataImpl implements LogData { LogDataImpl() {} diff --git a/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/SdkLogBuilderTest.java b/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/SdkLogBuilderTest.java index d46651e269..092f54fee6 100644 --- a/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/SdkLogBuilderTest.java +++ b/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/SdkLogBuilderTest.java @@ -25,6 +25,7 @@ import org.junit.jupiter.api.Test; class SdkLogBuilderTest { @Test + @SuppressWarnings("deprecation") // test deprecated setName method void buildAndEmit() { Instant now = Instant.now(); String name = "skippy"; diff --git a/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/util/TestUtil.java b/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/util/TestUtil.java index acc8859885..7099d32d05 100644 --- a/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/util/TestUtil.java +++ b/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/util/TestUtil.java @@ -22,7 +22,6 @@ public final class TestUtil { .setEpoch(System.currentTimeMillis(), TimeUnit.MILLISECONDS) .setSeverity(severity) .setSeverityText("really severe") - .setName("log1") .setBody(message) .setAttributes(Attributes.builder().put("animal", "cat").build()) .build();