Make classes that can be shutdown Closeable (#2285)

* Make classes that can be shutdown Closeable

* Glad not my password

* Drift

Author: Anuraag Agrawal

exporters/logging/src/test/java/io/opentelemetry/exporter/logging/LoggingSpanExporterTest.java

@@ -82,7 +82,7 @@ void setUp() {
 
   @AfterEach
   void tearDown() {
-    exporter.shutdown();
+    exporter.close();
   }
 
   @Test

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerManagement.java

@@ -10,13 +10,15 @@
 import io.opentelemetry.sdk.trace.config.TraceConfig;
 import io.opentelemetry.sdk.trace.config.TraceConfigBuilder;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
+import java.io.Closeable;
+import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
 
 /**
  * "Management" interface for the Tracing SDK. This interface exposes methods for configuring the
  * Tracing SDK, as well as several lifecycle methods.
  */
-public interface SdkTracerManagement {
+public interface SdkTracerManagement extends Closeable {
 
   /**
    * Returns the active {@code TraceConfig}.
@@ -80,4 +82,22 @@ public interface SdkTracerManagement {
    * @see SpanProcessor#forceFlush()
    */
   CompletableResultCode forceFlush();
+
+  /**
+   * Attempts to stop all the activity for this {@link Tracer}. Calls {@link
+   * SpanProcessor#shutdown()} for all registered {@link SpanProcessor}s.
+   *
+   * <p>This operation may block until all the Spans are processed. Must be called before turning
+   * off the main application to ensure all data are processed and exported.
+   *
+   * <p>After this is called, newly created {@code Span}s will be no-ops.
+   *
+   * <p>After this is called, further attempts at re-using or reconfiguring this instance will
+   * result in undefined behavior. It should be considered a terminal operation for the SDK
+   * implementation.
+   */
+  @Override
+  default void close() {
+    shutdown().join(10, TimeUnit.SECONDS);
+  }
 }

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SpanProcessor.java

@@ -8,15 +8,17 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.sdk.common.CompletableResultCode;
+import java.io.Closeable;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 /**
  * SpanProcessor is the interface {@code TracerSdk} uses to allow synchronous hooks for when a
  * {@code Span} is started or when a {@code Span} is ended.
  */
-public interface SpanProcessor {
+public interface SpanProcessor extends Closeable {
 
   /**
    * Returns a {@link SpanProcessor} which simply delegates all processing to the {@code processors}
@@ -99,4 +101,13 @@ default CompletableResultCode shutdown() {
   default CompletableResultCode forceFlush() {
     return CompletableResultCode.ofSuccess();
   }
+
+  /**
+   * Closes this {@link SpanProcessor} after processing any remaining spans, releasing any
+   * resources.
+   */
+  @Override
+  default void close() {
+    shutdown().join(10, TimeUnit.SECONDS);
+  }
 }

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/SpanExporter.java

@@ -8,10 +8,12 @@
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.trace.SdkTracerManagement;
 import io.opentelemetry.sdk.trace.data.SpanData;
+import java.io.Closeable;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 /**
  * An interface that allows different tracing services to export recorded data for sampled spans in
@@ -20,7 +22,7 @@
  * <p>To export data this MUST be register to the {@code TracerSdk} using a {@link
  * SimpleSpanProcessor} or a {@code BatchSampledSpansProcessor}.
  */
-public interface SpanExporter {
+public interface SpanExporter extends Closeable {
 
   /**
    * Returns a {@link SpanExporter} which simply delegates all exports to the {@code exporters} in
@@ -81,4 +83,10 @@ static SpanExporter composite(Iterable<SpanExporter> exporters) {
    * @return a {@link CompletableResultCode} which is completed when shutdown completes.
    */
   CompletableResultCode shutdown();
+
+  /** Closes this {@link SpanExporter}, releasing any resources. */
+  @Override
+  default void close() {
+    shutdown().join(10, TimeUnit.SECONDS);
+  }
 }

sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkTracerProviderTest.java

@@ -138,6 +138,12 @@ void shutdown() {
     Mockito.verify(spanProcessor, Mockito.times(1)).shutdown();
   }
 
+  @Test
+  void close() {
+    tracerFactory.close();
+    Mockito.verify(spanProcessor, Mockito.times(1)).shutdown();
+  }
+
   @Test
   void forceFlush() {
     tracerFactory.forceFlush();

sdk/trace/src/test/java/io/opentelemetry/sdk/trace/export/SimpleSpanProcessorTest.java

@@ -66,6 +66,7 @@ class SimpleSpanProcessorTest {
   @BeforeEach
   void setUp() {
     simpleSampledSpansProcessor = SimpleSpanProcessor.create(spanExporter);
+    when(spanExporter.shutdown()).thenReturn(CompletableResultCode.ofSuccess());
   }
 
   @Test
@@ -212,6 +213,12 @@ void shutdown() {
     verify(spanExporter).shutdown();
   }
 
+  @Test
+  void close() {
+    simpleSampledSpansProcessor.close();
+    verify(spanExporter).shutdown();
+  }
+
   @Test
   void buildFromProperties_defaultSampledFlag() {
     Properties properties = new Properties();