Change pattern to SpanInstrumentation

Author: JonasKunz

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

@@ -10,23 +10,23 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.api.trace.StatusCode;
-import io.opentelemetry.sdk.trace.internal.metrics.SpanMetrics;
+import io.opentelemetry.sdk.trace.internal.metrics.SpanInstrumentation;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
 /**
  * Span implementation used from {@link io.opentelemetry.sdk.trace.SdkTracer} when starting a span
- * which is not recording. This span implementation behaves exactly like one returned from {@link Span#wrap(SpanContext)}
- * with the addition that {@link #end()} collects health metrics.
+ * which is not recording. This span implementation behaves exactly like one returned from {@link
+ * Span#wrap(SpanContext)} with the addition that {@link #end()} collects health metrics.
  */
 @Immutable
 final class NonRecordingSpan implements Span {
 
   private final SpanContext spanContext;
-  private final SpanMetrics.Recording metricRecording;
+  private final SpanInstrumentation.Recording metricRecording;
 
-  NonRecordingSpan(SpanContext spanContext, SpanMetrics.Recording metricRecording) {
+  NonRecordingSpan(SpanContext spanContext, SpanInstrumentation.Recording metricRecording) {
     this.spanContext = spanContext;
     this.metricRecording = metricRecording;
   }

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

@@ -26,7 +26,7 @@
 import io.opentelemetry.sdk.trace.data.SpanData;
 import io.opentelemetry.sdk.trace.data.StatusData;
 import io.opentelemetry.sdk.trace.internal.ExtendedSpanProcessor;
-import io.opentelemetry.sdk.trace.internal.metrics.SpanMetrics;
+import io.opentelemetry.sdk.trace.internal.metrics.SpanInstrumentation;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -100,7 +100,7 @@ final class SdkSpan implements ReadWriteSpan {
   @GuardedBy("lock")
   private long endEpochNanos;
 
-  private final SpanMetrics.Recording metricRecording;
+  private final SpanInstrumentation.Recording metricRecording;
 
   private enum EndState {
     NOT_ENDED,
@@ -136,7 +136,7 @@ private SdkSpan(
       @Nullable List<LinkData> links,
       int totalRecordedLinks,
       long startEpochNanos,
-      SpanMetrics.Recording metricRecording) {
+      SpanInstrumentation.Recording metricRecording) {
     this.context = context;
     this.instrumentationScopeInfo = instrumentationScopeInfo;
     this.parentSpanContext = parentSpanContext;
@@ -186,7 +186,7 @@ static SdkSpan startSpan(
       @Nullable List<LinkData> links,
       int totalRecordedLinks,
       long userStartEpochNanos,
-      SpanMetrics.Recording metricsRecording) {
+      SpanInstrumentation.Recording metricsRecording) {
     boolean createdAnchoredClock;
     AnchoredClock clock;
     if (parentSpan instanceof SdkSpan) {

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

@@ -24,7 +24,7 @@
 import io.opentelemetry.sdk.internal.AttributeUtil;
 import io.opentelemetry.sdk.internal.AttributesMap;
 import io.opentelemetry.sdk.trace.data.LinkData;
-import io.opentelemetry.sdk.trace.internal.metrics.SpanMetrics;
+import io.opentelemetry.sdk.trace.internal.metrics.SpanInstrumentation;
 import io.opentelemetry.sdk.trace.samplers.SamplingDecision;
 import io.opentelemetry.sdk.trace.samplers.SamplingResult;
 import java.util.ArrayList;
@@ -205,7 +205,7 @@ public Span startSpan() {
             /* remote= */ false,
             tracerSharedState.isIdGeneratorSafeToSkipIdValidation());
 
-    SpanMetrics.Recording metricsRecording =
+    SpanInstrumentation.Recording metricsRecording =
         tracerSharedState.getSpanMetrics().recordSpanStart(samplingResult);
     if (!isRecording(samplingDecision)) {
       return new NonRecordingSpan(spanContext, metricsRecording);

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

@@ -19,8 +19,7 @@
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.internal.SdkTracerProviderUtil;
 import io.opentelemetry.sdk.trace.internal.TracerConfig;
-import io.opentelemetry.sdk.trace.internal.metrics.SemConvSpanMetrics;
-import io.opentelemetry.sdk.trace.internal.metrics.SpanMetrics;
+import io.opentelemetry.sdk.trace.internal.metrics.SpanInstrumentation;
 import io.opentelemetry.sdk.trace.samplers.Sampler;
 import java.io.Closeable;
 import java.util.List;
@@ -70,7 +69,7 @@ public static SdkTracerProviderBuilder builder() {
             sampler,
             spanProcessors,
             exceptionAttributeResolver,
-            createSpanMetrics(internalTelemetryVersion, meterProviderSupplier));
+            SpanInstrumentation.create(internalTelemetryVersion, meterProviderSupplier));
     this.tracerSdkComponentRegistry =
         new ComponentRegistry<>(
             instrumentationScopeInfo ->
@@ -81,19 +80,6 @@ public static SdkTracerProviderBuilder builder() {
     this.tracerConfigurator = tracerConfigurator;
   }
 
-  private static SpanMetrics createSpanMetrics(
-      InternalTelemetryVersion internalTelemetryVersion,
-      Supplier<MeterProvider> meterProviderSupplier) {
-    switch (internalTelemetryVersion) {
-      case LEGACY:
-        return SpanMetrics.noop();
-      case LATEST:
-        return new SemConvSpanMetrics(meterProviderSupplier);
-    }
-    throw new IllegalStateException(
-        "Unhandled telemetry schema version: " + internalTelemetryVersion);
-  }
-
   private TracerConfig getTracerConfig(InstrumentationScopeInfo instrumentationScopeInfo) {
     TracerConfig tracerConfig = tracerConfigurator.apply(instrumentationScopeInfo);
     return tracerConfig == null ? TracerConfig.defaultConfig() : tracerConfig;

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

@@ -9,7 +9,7 @@
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.internal.ExceptionAttributeResolver;
 import io.opentelemetry.sdk.resources.Resource;
-import io.opentelemetry.sdk.trace.internal.metrics.SpanMetrics;
+import io.opentelemetry.sdk.trace.internal.metrics.SpanInstrumentation;
 import io.opentelemetry.sdk.trace.samplers.Sampler;
 import java.util.List;
 import java.util.function.Supplier;
@@ -29,7 +29,7 @@ final class TracerSharedState {
   private final Sampler sampler;
   private final SpanProcessor activeSpanProcessor;
   private final ExceptionAttributeResolver exceptionAttributeResolver;
-  private final SpanMetrics spanMetrics;
+  private final SpanInstrumentation spanInstrumentation;
 
   @Nullable private volatile CompletableResultCode shutdownResult = null;
 
@@ -41,7 +41,7 @@ final class TracerSharedState {
       Sampler sampler,
       List<SpanProcessor> spanProcessors,
       ExceptionAttributeResolver exceptionAttributeResolver,
-      SpanMetrics spanMetrics) {
+      SpanInstrumentation spanInstrumentation) {
     this.clock = clock;
     this.idGenerator = idGenerator;
     this.idGeneratorSafeToSkipIdValidation = idGenerator instanceof RandomIdGenerator;
@@ -50,7 +50,7 @@ final class TracerSharedState {
     this.sampler = sampler;
     this.activeSpanProcessor = SpanProcessor.composite(spanProcessors);
     this.exceptionAttributeResolver = exceptionAttributeResolver;
-    this.spanMetrics = spanMetrics;
+    this.spanInstrumentation = spanInstrumentation;
   }
 
   Clock getClock() {
@@ -88,8 +88,8 @@ SpanProcessor getActiveSpanProcessor() {
     return activeSpanProcessor;
   }
 
-  SpanMetrics getSpanMetrics() {
-    return spanMetrics;
+  SpanInstrumentation getSpanMetrics() {
+    return spanInstrumentation;
   }
 
   /**

…ce/internal/metrics/NoopSpanMetrics.java …nal/metrics/NoopSpanInstrumentation.javasdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/NoopSpanMetrics.java renamed to sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/NoopSpanInstrumentation.java sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/NoopSpanMetrics.java renamed to sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/NoopSpanInstrumentation.java

@@ -7,16 +7,16 @@
 
 import io.opentelemetry.sdk.trace.samplers.SamplingResult;
 
-class NoopSpanMetrics implements SpanMetrics {
+class NoopSpanInstrumentation implements SpanInstrumentation {
 
-  static final NoopSpanMetrics INSTANCE = new NoopSpanMetrics();
+  static final NoopSpanInstrumentation INSTANCE = new NoopSpanInstrumentation();
 
   @Override
-  public SpanMetrics.Recording recordSpanStart(SamplingResult samplingResult) {
+  public SpanInstrumentation.Recording recordSpanStart(SamplingResult samplingResult) {
     return NoopRecording.INSTANCE;
   }
 
-  private static class NoopRecording implements SpanMetrics.Recording {
+  private static class NoopRecording implements SpanInstrumentation.Recording {
 
     private static final NoopRecording INSTANCE = new NoopRecording();
 

…internal/metrics/SemConvSpanMetrics.java …/metrics/SemConvSpanInstrumentation.javasdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/SemConvSpanMetrics.java renamed to sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/SemConvSpanInstrumentation.java sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/SemConvSpanMetrics.java renamed to sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/SemConvSpanInstrumentation.java

@@ -20,7 +20,7 @@
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
-public class SemConvSpanMetrics implements SpanMetrics {
+public class SemConvSpanInstrumentation implements SpanInstrumentation {
 
   private final Supplier<MeterProvider> meterProviderSupplier;
 
@@ -34,11 +34,7 @@ public class SemConvSpanMetrics implements SpanMetrics {
   @Nullable private volatile LongUpDownCounter live = null;
   @Nullable private volatile LongCounter ended = null;
 
-  /**
-   * This class is internal and is hence not for public use. Its APIs are unstable and can change at
-   * any time.
-   */
-  public SemConvSpanMetrics(Supplier<MeterProvider> meterProviderSupplier) {
+  public SemConvSpanInstrumentation(Supplier<MeterProvider> meterProviderSupplier) {
     this.meterProviderSupplier = meterProviderSupplier;
   }
 
@@ -92,13 +88,13 @@ static Attributes getAttributesForSamplingDecisions(SamplingDecision decision) {
   }
 
   @Override
-  public SpanMetrics.Recording recordSpanStart(SamplingResult samplingResult) {
+  public SpanInstrumentation.Recording recordSpanStart(SamplingResult samplingResult) {
     Attributes attribs = getAttributesForSamplingDecisions(samplingResult.getDecision());
     live().add(1, attribs);
     return new Recording(attribs);
   }
 
-  private class Recording implements SpanMetrics.Recording {
+  private class Recording implements SpanInstrumentation.Recording {
 
     private final Attributes attributes;
     private boolean endAlreadyReported = false;

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/SpanInstrumentation.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.trace.internal.metrics;
+
+import io.opentelemetry.api.metrics.MeterProvider;
+import io.opentelemetry.sdk.common.InternalTelemetryVersion;
+import io.opentelemetry.sdk.trace.samplers.SamplingResult;
+import java.util.function.Supplier;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public interface SpanInstrumentation {
+
+  static SpanInstrumentation noop() {
+    return NoopSpanInstrumentation.INSTANCE;
+  }
+
+  static SpanInstrumentation create(
+      InternalTelemetryVersion internalTelemetryVersion,
+      Supplier<MeterProvider> meterProviderSupplier) {
+    switch (internalTelemetryVersion) {
+      case LEGACY:
+        return SpanInstrumentation.noop();
+      case LATEST:
+        return new SemConvSpanInstrumentation(meterProviderSupplier);
+    }
+    throw new IllegalStateException(
+        "Unhandled telemetry schema version: " + internalTelemetryVersion);
+  }
+
+  Recording recordSpanStart(SamplingResult samplingResult);
+
+  /**
+   * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+   * any time.
+   */
+  interface Recording {
+
+    void recordSpanEnd();
+  }
+}

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/metrics/SpanMetrics.java

@@ -22,7 +22,7 @@
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.api.trace.TraceFlags;
 import io.opentelemetry.api.trace.TraceState;
-import io.opentelemetry.sdk.trace.internal.metrics.SpanMetrics;
+import io.opentelemetry.sdk.trace.internal.metrics.SpanInstrumentation;
 import java.time.Instant;
 import java.util.concurrent.TimeUnit;
 import org.junit.jupiter.api.Test;
@@ -40,7 +40,7 @@ class NonRecordingSpanTest {
           TraceFlags.getDefault(),
           TraceState.getDefault());
 
-  @Mock SpanMetrics.Recording mockRecording;
+  @Mock SpanInstrumentation.Recording mockRecording;
 
   @Test
   void notRecording() {