Add toString to SDK trace components and print autoconfigured SDK (open-telemetry#4047)

anuraaga · web-flow · commit 429afa1c991f · 2022-01-07T10:55:46.000+09:00
* Add toString to SDK trace components and print autoconfigured SDK

* Clean

* Tweak logging message
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk-trace.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk-trace.txt
@@ -1,4 +1,13 @@
 Comparing source compatibility of  against 
+***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.export.BatchSpanProcessor  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) java.lang.String toString()
 ***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder  (not serializable)
 	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
 	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder setMeterProvider(io.opentelemetry.api.metrics.MeterProvider)
+***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.export.SimpleSpanProcessor  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) java.lang.String toString()
+***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.SdkTracerProvider  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) java.lang.String toString()
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt
@@ -4,6 +4,7 @@ Comparing source compatibility of  against
 	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.api.metrics.MeterProvider getMeterProvider()
 	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.logs.SdkLogEmitterProvider getSdkLogEmitterProvider()
 	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.metrics.SdkMeterProvider getSdkMeterProvider()
+	+++  NEW METHOD: PUBLIC(+) java.lang.String toString()
 ***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.OpenTelemetrySdkBuilder  (not serializable)
 	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
 	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.OpenTelemetrySdkBuilder setLogEmitterProvider(io.opentelemetry.sdk.logs.SdkLogEmitterProvider)
diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java
@@ -28,6 +28,8 @@
 import java.util.ServiceLoader;
 import java.util.function.BiFunction;
 import java.util.function.Supplier;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import javax.annotation.Nullable;
 
 /**
@@ -37,6 +39,9 @@
  */
 public final class AutoConfiguredOpenTelemetrySdkBuilder implements AutoConfigurationCustomizer {
 
+  private static final Logger logger =
+      Logger.getLogger(AutoConfiguredOpenTelemetrySdkBuilder.class.getName());
+
   @Nullable private ConfigProperties config;
 
   private BiFunction<? super TextMapPropagator, ConfigProperties, ? extends TextMapPropagator>
@@ -213,6 +218,8 @@ public AutoConfiguredOpenTelemetrySdk build() {
 
     if (setResultAsGlobal) {
       GlobalOpenTelemetry.set(openTelemetrySdk);
+      logger.log(
+          Level.FINE, "Global OpenTelemetrySdk set to {0} by autoconfiguration", openTelemetrySdk);
     }
 
     return AutoConfiguredOpenTelemetrySdk.create(openTelemetrySdk, resource, config);
diff --git a/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java b/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java
@@ -74,6 +74,12 @@ public ContextPropagators getPropagators() {
     return propagators;
   }
 
+  @Override
+  public String toString() {
+    // TODO(anuraaga): Add metrics / logs / propagators
+    return "OpenTelemetrySdk{" + "tracerProvider=" + tracerProvider.unobfuscate() + '}';
+  }
+
   /**
    * This class allows the SDK to unobfuscate an obfuscated static global provider.
    *
diff --git a/sdk/all/src/test/java/io/opentelemetry/sdk/OpenTelemetrySdkTest.java b/sdk/all/src/test/java/io/opentelemetry/sdk/OpenTelemetrySdkTest.java
@@ -9,6 +9,7 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.assertj.core.api.InstanceOfAssertFactories.type;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
@@ -278,4 +279,29 @@ void minimalOpenTelemetrySdkConfigurationDemo() {
         .setPropagators(ContextPropagators.create(mock(TextMapPropagator.class)))
         .build();
   }
+
+  @Test
+  void stringRepresentation() {
+    SpanExporter exporter = mock(SpanExporter.class);
+    when(exporter.toString()).thenReturn("MockSpanExporter{}");
+    OpenTelemetrySdk sdk =
+        OpenTelemetrySdk.builder()
+            .setTracerProvider(
+                SdkTracerProvider.builder()
+                    .addSpanProcessor(
+                        SimpleSpanProcessor.create(SpanExporter.composite(exporter, exporter)))
+                    .build())
+            .build();
+
+    assertThat(sdk.toString())
+        .isEqualTo(
+            "OpenTelemetrySdk{"
+                + "tracerProvider=SdkTracerProvider{"
+                + "clock=SystemClock{}, "
+                + "idGenerator=RandomIdGenerator{}, "
+                + "resource=Resource{schemaUrl=null, attributes={service.name=\"unknown_service:java\", telemetry.sdk.language=\"java\", telemetry.sdk.name=\"opentelemetry\", telemetry.sdk.version=\"1.10.0-SNAPSHOT\"}}, "
+                + "spanLimitsSupplier=SpanLimitsValue{maxNumberOfAttributes=128, maxNumberOfEvents=128, maxNumberOfLinks=128, maxNumberOfAttributesPerEvent=128, maxNumberOfAttributesPerLink=128, maxAttributeValueLength=2147483647}, "
+                + "sampler=ParentBased{root:AlwaysOnSampler,remoteParentSampled:AlwaysOnSampler,remoteParentNotSampled:AlwaysOffSampler,localParentSampled:AlwaysOnSampler,localParentNotSampled:AlwaysOffSampler}, "
+                + "spanProcessor=SimpleSpanProcessor{spanExporter=MultiSpanExporter{spanExporters=[MockSpanExporter{}, MockSpanExporter{}]}}}}");
+  }
 }
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/common/SystemClock.java b/sdk/common/src/main/java/io/opentelemetry/sdk/common/SystemClock.java
@@ -34,4 +34,9 @@ public long now() {
   public long nanoTime() {
     return System.nanoTime();
   }
+
+  @Override
+  public String toString() {
+    return "SystemClock{}";
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/MultiSpanProcessor.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/MultiSpanProcessor.java
@@ -92,4 +92,16 @@ private MultiSpanProcessor(List<SpanProcessor> spanProcessors) {
       }
     }
   }
+
+  @Override
+  public String toString() {
+    return "MultiSpanProcessor{"
+        + "spanProcessorsStart="
+        + spanProcessorsStart
+        + ", spanProcessorsEnd="
+        + spanProcessorsEnd
+        + ", spanProcessorsAll="
+        + spanProcessorsAll
+        + '}';
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/NoopSpanProcessor.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/NoopSpanProcessor.java
@@ -31,4 +31,9 @@ public boolean isEndRequired() {
   }
 
   private NoopSpanProcessor() {}
+
+  @Override
+  public String toString() {
+    return "NoopSpanProcessor{}";
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/RandomIdGenerator.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/RandomIdGenerator.java
@@ -37,4 +37,9 @@ public String generateTraceId() {
     } while (idLo == INVALID_ID);
     return TraceId.fromLongs(idHi, idLo);
   }
+
+  @Override
+  public String toString() {
+    return "RandomIdGenerator{}";
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerProvider.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerProvider.java
@@ -133,4 +133,22 @@ public CompletableResultCode forceFlush() {
   public void close() {
     shutdown().join(10, TimeUnit.SECONDS);
   }
+
+  @Override
+  public String toString() {
+    return "SdkTracerProvider{"
+        + "clock="
+        + sharedState.getClock()
+        + ", idGenerator="
+        + sharedState.getIdGenerator()
+        + ", resource="
+        + sharedState.getResource()
+        + ", spanLimitsSupplier="
+        + sharedState.getSpanLimits()
+        + ", sampler="
+        + sharedState.getSampler()
+        + ", spanProcessor="
+        + sharedState.getActiveSpanProcessor()
+        + '}';
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/BatchSpanProcessor.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/BatchSpanProcessor.java
@@ -121,6 +121,20 @@ ArrayList<SpanData> getBatch() {
     return worker.batch;
   }
 
+  @Override
+  public String toString() {
+    return "BatchSpanProcessor{"
+        + "spanExporter="
+        + worker.spanExporter
+        + ", scheduleDelayNanos="
+        + worker.scheduleDelayNanos
+        + ", maxExportBatchSize="
+        + worker.maxExportBatchSize
+        + ", exporterTimeoutNanos="
+        + worker.exporterTimeoutNanos
+        + '}';
+  }
+
   // Worker is a thread that batches multiple spans and calls the registered SpanExporter to export
   // the data.
   private static final class Worker implements Runnable {
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/MultiSpanExporter.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/MultiSpanExporter.java
@@ -9,6 +9,7 @@
 import io.opentelemetry.sdk.trace.SpanProcessor;
 import io.opentelemetry.sdk.trace.data.SpanData;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
 import java.util.logging.Level;
@@ -97,4 +98,9 @@ public CompletableResultCode shutdown() {
   private MultiSpanExporter(SpanExporter[] spanExporters) {
     this.spanExporters = spanExporters;
   }
+
+  @Override
+  public String toString() {
+    return "MultiSpanExporter{" + "spanExporters=" + Arrays.toString(spanExporters) + '}';
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/NoopSpanExporter.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/NoopSpanExporter.java
@@ -31,4 +31,9 @@ public CompletableResultCode flush() {
   public CompletableResultCode shutdown() {
     return CompletableResultCode.ofSuccess();
   }
+
+  @Override
+  public String toString() {
+    return "NoopSpanExporter{}";
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/SimpleSpanProcessor.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/SimpleSpanProcessor.java
@@ -125,4 +125,9 @@ public CompletableResultCode shutdown() {
   public CompletableResultCode forceFlush() {
     return CompletableResultCode.ofAll(pendingExports);
   }
+
+  @Override
+  public String toString() {
+    return "SimpleSpanProcessor{" + "spanExporter=" + spanExporter + '}';
+  }
 }
diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/MultiSpanProcessorTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/MultiSpanProcessorTest.java
@@ -106,4 +106,18 @@ void twoSpanProcessor_DifferentRequirements() {
     verify(spanProcessor1).shutdown();
     verify(spanProcessor2).shutdown();
   }
+
+  @Test
+  void stringRepresentation() {
+    when(spanProcessor1.toString()).thenReturn("spanProcessor1");
+    when(spanProcessor2.toString()).thenReturn("spanProcessor1");
+    SpanProcessor multiSpanProcessor =
+        SpanProcessor.composite(Arrays.asList(spanProcessor1, spanProcessor2));
+    assertThat(multiSpanProcessor)
+        .hasToString(
+            "MultiSpanProcessor{"
+                + "spanProcessorsStart=[spanProcessor1, spanProcessor1], "
+                + "spanProcessorsEnd=[spanProcessor1, spanProcessor1], "
+                + "spanProcessorsAll=[spanProcessor1, spanProcessor1]}");
+  }
 }
diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/NoopSpanProcessorTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/NoopSpanProcessorTest.java
@@ -28,4 +28,9 @@ void noCrash() {
     noopSpanProcessor.forceFlush();
     noopSpanProcessor.shutdown();
   }
+
+  @Test
+  void stringRepresentation() {
+    assertThat(NoopSpanProcessor.getInstance()).hasToString("NoopSpanProcessor{}");
+  }
 }
diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/export/BatchSpanProcessorTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/export/BatchSpanProcessorTest.java
@@ -488,6 +488,20 @@ void shutdownPropagatesFailure() {
     assertThat(result.isSuccess()).isFalse();
   }
 
+  @Test
+  void stringRepresentation() {
+    BatchSpanProcessor processor = BatchSpanProcessor.builder(mockSpanExporter).build();
+    String processorStr = processor.toString();
+    processor.close();
+    assertThat(processorStr)
+        .hasToString(
+            "BatchSpanProcessor{"
+                + "spanExporter=mockSpanExporter, "
+                + "scheduleDelayNanos=5000000000, "
+                + "maxExportBatchSize=512, "
+                + "exporterTimeoutNanos=30000000000}");
+  }
+
   private static final class BlockingSpanExporter implements SpanExporter {
 
     final Object monitor = new Object();
diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/export/NoopSpanExporterTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/export/NoopSpanExporterTest.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.trace.export;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+
+class NoopSpanExporterTest {
+
+  @Test
+  void stringRepresentation() {
+    assertThat(NoopSpanExporter.getInstance()).hasToString("NoopSpanExporter{}");
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,12 @@ public ContextPropagators getPropagators() {`
`74`	`74`	`return propagators;`
`75`	`75`	`}`
`76`	`76`
	`77`	`+ @Override`
	`78`	`+ public String toString() {`
	`79`	`+ // TODO(anuraaga): Add metrics / logs / propagators`
	`80`	`+ return "OpenTelemetrySdk{" + "tracerProvider=" + tracerProvider.unobfuscate() + '}';`
	`81`	`+ }`
	`82`	`+`
`77`	`83`	`/**`
`78`	`84`	`* This class allows the SDK to unobfuscate an obfuscated static global provider.`
`79`	`85`	`*`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,9 @@ public long now() {`
`34`	`34`	`public long nanoTime() {`
`35`	`35`	`return System.nanoTime();`
`36`	`36`	`}`
	`37`	`+`
	`38`	`+ @Override`
	`39`	`+ public String toString() {`
	`40`	`+ return "SystemClock{}";`
	`41`	`+ }`
`37`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,4 +92,16 @@ private MultiSpanProcessor(List<SpanProcessor> spanProcessors) {`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`	`}`
	`95`	`+`
	`96`	`+ @Override`
	`97`	`+ public String toString() {`
	`98`	`+ return "MultiSpanProcessor{"`
	`99`	`+ + "spanProcessorsStart="`
	`100`	`+ + spanProcessorsStart`
	`101`	`+ + ", spanProcessorsEnd="`
	`102`	`+ + spanProcessorsEnd`
	`103`	`+ + ", spanProcessorsAll="`
	`104`	`+ + spanProcessorsAll`
	`105`	`+ + '}';`
	`106`	`+ }`
`95`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,9 @@ public boolean isEndRequired() {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`private NoopSpanProcessor() {}`
	`34`	`+`
	`35`	`+ @Override`
	`36`	`+ public String toString() {`
	`37`	`+ return "NoopSpanProcessor{}";`
	`38`	`+ }`
`34`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,9 @@ public String generateTraceId() {`
`37`	`37`	`} while (idLo == INVALID_ID);`
`38`	`38`	`return TraceId.fromLongs(idHi, idLo);`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ @Override`
	`42`	`+ public String toString() {`
	`43`	`+ return "RandomIdGenerator{}";`
	`44`	`+ }`
`40`	`45`	`}`