Add meaningful .toString to NoopLogRecordProcessor and `DefaultOp…

…enTelemetry` (#5493)
open-telemetry · Jun 1, 2023 · 0ab6915 · 0ab6915
1 parent b14bed8
commit 0ab6915
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/api/all/src/main/java/io/opentelemetry/api/DefaultOpenTelemetry.java b/api/all/src/main/java/io/opentelemetry/api/DefaultOpenTelemetry.java
@@ -46,4 +46,9 @@ public MeterProvider getMeterProvider() {
   public ContextPropagators getPropagators() {
     return propagators;
   }
+
+  @Override
+  public String toString() {
+    return "DefaultOpenTelemetry{" + "propagators=" + propagators + "}";
+  }
 }
diff --git a/api/all/src/test/java/io/opentelemetry/api/OpenTelemetryTest.java b/api/all/src/test/java/io/opentelemetry/api/OpenTelemetryTest.java
@@ -85,6 +85,15 @@ void getThenSet() {
         .hasStackTraceContaining("getOpenTelemetry");
   }
 
+  @Test
+  void toString_noop_Valid() {
+    assertThat(OpenTelemetry.noop().toString())
+        .isEqualTo(
+            "DefaultOpenTelemetry{"
+                + "propagators=DefaultContextPropagators{textMapPropagator=NoopTextMapPropagator}"
+                + "}");
+  }
+
   private static void setOpenTelemetry() {
     GlobalOpenTelemetry.set(OpenTelemetry.noop());
   }

diff --git a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/NoopLogRecordProcessor.java b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/NoopLogRecordProcessor.java
@@ -18,4 +18,9 @@ private NoopLogRecordProcessor() {}
 
   @Override
   public void onEmit(Context context, ReadWriteLogRecord logRecord) {}
+
+  @Override
+  public String toString() {
+    return "NoopLogRecordProcessor";
+  }
 }
diff --git a/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/NoopLogRecordProcessorTest.java b/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/NoopLogRecordProcessorTest.java
@@ -25,4 +25,9 @@ void noCrash() {
     assertThat(logRecordProcessor.forceFlush().isSuccess()).isEqualTo(true);
     assertThat(logRecordProcessor.shutdown().isSuccess()).isEqualTo(true);
   }
+
+  @Test
+  void toString_Valid() {
+    assertThat(NoopLogRecordProcessor.getInstance().toString()).isEqualTo("NoopLogRecordProcessor");
+  }
 }