Deprecate log name field (#4160)

* Deprecate log name field * Add deprecation description to javadoc
open-telemetry · Feb 11, 2022 · 19b0fec · 19b0fec
1 parent 34273f4
commit 19b0fec
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 4 deletions.
diff --git a/.../src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java b/.../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/.../logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java b/.../logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java
@@ -330,6 +330,7 @@ private static <T extends Message> HttpResponse buildResponse(HttpStatus httpSta
     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/.../otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogMarshaler.java b/.../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/.../src/test/java/io/opentelemetry/exporter/internal/otlp/logs/LogsRequestMarshalerTest.java b/.../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 @@ void toProtoResourceLogs() {
   }
 
   @Test
+  @SuppressWarnings("deprecation") // test deprecated setName method
   void toProtoLogRecord() {
     LogRecord logRecord =
         parse(

diff --git a/.../otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogExporterTest.java b/.../otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogExporterTest.java
@@ -104,6 +104,7 @@ public TelemetryExporter<LogData> build() {
   }
 
   @Override
+  @SuppressWarnings("deprecation") // test deprecated setName method
   protected LogData generateFakeTelemetry() {
     return LogDataBuilder.create(
             Resource.create(Attributes.builder().put("testKey", "testValue").build()),

diff --git a/.../testGrpcNetty/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcNettyLogExporterTest.java b/.../testGrpcNetty/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcNettyLogExporterTest.java
@@ -105,6 +105,7 @@ public TelemetryExporter<LogData> build() {
   }
 
   @Override
+  @SuppressWarnings("deprecation") // test deprecated setName method
   protected LogData generateFakeTelemetry() {
     return LogDataBuilder.create(
             Resource.create(Attributes.builder().put("testKey", "testValue").build()),

diff --git a/...tyShaded/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcNettyShadedLogExporterTest.java b/...tyShaded/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcNettyShadedLogExporterTest.java
@@ -94,6 +94,7 @@ public TelemetryExporter<LogData> build() {
   }
 
   @Override
+  @SuppressWarnings("deprecation") // test deprecated setName method
   protected LogData generateFakeTelemetry() {
     return LogDataBuilder.create(
             Resource.create(Attributes.builder().put("testKey", "testValue").build()),

diff --git a/...pcOkhttp/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcNettyOkHttpLogExporterTest.java b/...pcOkhttp/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcNettyOkHttpLogExporterTest.java
@@ -94,6 +94,7 @@ public TelemetryExporter<LogData> build() {
   }
 
   @Override
+  @SuppressWarnings("deprecation") // test deprecated setName method
   protected LogData generateFakeTelemetry() {
     return LogDataBuilder.create(
             Resource.create(Attributes.builder().put("testKey", "testValue").build()),

diff --git a/...ests/otlp/src/main/java/io/opentelemetry/integrationtest/OtlpExporterIntegrationTest.java b/...ests/otlp/src/main/java/io/opentelemetry/integrationtest/OtlpExporterIntegrationTest.java
@@ -373,6 +373,7 @@ void testOtlpHttpLogExport(String compression) {
     testLogExporter(otlpHttpLogExporter);
   }
 
+  @SuppressWarnings("deprecation") // test deprecated setName method
   private static void testLogExporter(LogExporter logExporter) {
     LogData logData =
         LogDataBuilder.create(

diff --git a/sdk/logs-testing/src/main/java/io/opentelemetry/sdk/testing/assertj/LogDataAssert.java b/sdk/logs-testing/src/main/java/io/opentelemetry/sdk/testing/assertj/LogDataAssert.java
@@ -114,6 +114,7 @@ public LogDataAssert hasSeverityText(String severityText) {
   }
 
   /** Asserts the log has the given name. */
+  @Deprecated
   public LogDataAssert hasName(String name) {
     isNotNull();
     if (!name.equals(actual.getName())) {
@@ -149,7 +150,6 @@ public LogDataAssert hasAttributes(Attributes attributes) {
           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
@@ -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 @@ void passing() {
   }
 
   @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
@@ -57,6 +57,7 @@ public LogBuilder setSeverityText(String severityText) {
   }
 
   @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
@@ -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
@@ -85,7 +85,12 @@ public LogDataBuilder setSeverityText(String severityText) {
     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
@@ -14,7 +14,9 @@
 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
@@ -25,6 +25,7 @@
 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
@@ -22,7 +22,6 @@ public static LogData createLogData(Severity severity, String message) {
         .setEpoch(System.currentTimeMillis(), TimeUnit.MILLISECONDS)
         .setSeverity(severity)
         .setSeverityText("really severe")
-        .setName("log1")
         .setBody(message)
         .setAttributes(Attributes.builder().put("animal", "cat").build())
         .build();