Move standard component types to enum

Author: JonasKunz

exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporter.java

@@ -10,7 +10,6 @@
 
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.MeterProvider;
-import io.opentelemetry.exporter.internal.metrics.ExporterMetrics;
 import io.opentelemetry.exporter.internal.metrics.ExporterInstrumentation;
 import io.opentelemetry.exporter.internal.FailedExportException;
 import io.opentelemetry.exporter.internal.marshal.Marshaler;
@@ -46,24 +45,22 @@ public final class GrpcExporter<T extends Marshaler> {
   private final ExporterInstrumentation exporterMetrics;
 
   public GrpcExporter(
-      String legacyExporterName,
-      ExporterMetrics.Signal type,
       GrpcSender<T> grpcSender,
       InternalTelemetrySchemaVersion internalTelemetrySchemaVersion,
       ComponentId componentId,
+      ComponentId.StandardExporterType exporterType,
       Supplier<MeterProvider> meterProviderSupplier,
       Attributes healthMetricAttributes) {
-    this.type = type.toString();
+    this.type = exporterType.signal().toString();
     this.grpcSender = grpcSender;
     this.exporterMetrics =
         new ExporterInstrumentation(
             internalTelemetrySchemaVersion,
             meterProviderSupplier,
-            type,
             componentId,
-            healthMetricAttributes,
-            legacyExporterName,
-            "grpc");
+            exporterType,
+            healthMetricAttributes
+        );
   }
 
   public CompletableResultCode export(T exportRequest, int numItems) {

exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterBuilder.java

@@ -11,7 +11,6 @@
 import io.opentelemetry.api.internal.ConfigUtil;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterBuilderUtil;
-import io.opentelemetry.exporter.internal.metrics.ExporterMetrics;
 import io.opentelemetry.exporter.internal.ServerAttributesUtil;
 import io.opentelemetry.exporter.internal.TlsConfigHelper;
 import io.opentelemetry.exporter.internal.compression.Compressor;
@@ -52,9 +51,7 @@ public class GrpcExporterBuilder<T extends Marshaler> {
 
   private static final Logger LOGGER = Logger.getLogger(GrpcExporterBuilder.class.getName());
 
-  private final String legacyExporterName;
-  private final ExporterMetrics.Signal signal;
-  private final String componentType;
+  private final ComponentId.StandardExporterType exporterType;
   private final String grpcEndpointPath;
   private final Supplier<BiFunction<Channel, String, MarshalerServiceStub<T, ?, ?>>>
       grpcStubFactory;
@@ -77,16 +74,12 @@ public class GrpcExporterBuilder<T extends Marshaler> {
   @Nullable private Object grpcChannel;
 
   public GrpcExporterBuilder(
-      String legacyExporterName,
-      ExporterMetrics.Signal signal,
-      String componentType,
+      ComponentId.StandardExporterType exporterType,
       long defaultTimeoutSecs,
       URI defaultEndpoint,
       Supplier<BiFunction<Channel, String, MarshalerServiceStub<T, ?, ?>>> grpcStubFactory,
       String grpcEndpointPath) {
-    this.legacyExporterName = legacyExporterName;
-    this.signal = signal;
-    this.componentType = componentType;
+    this.exporterType = exporterType;
     this.grpcEndpointPath = grpcEndpointPath;
     timeoutNanos = TimeUnit.SECONDS.toNanos(defaultTimeoutSecs);
     endpoint = defaultEndpoint;
@@ -179,9 +172,7 @@ public GrpcExporterBuilder<T> setExecutorService(ExecutorService executorService
   public GrpcExporterBuilder<T> copy() {
     GrpcExporterBuilder<T> copy =
         new GrpcExporterBuilder<>(
-            legacyExporterName,
-            signal,
-            componentType,
+            exporterType,
             TimeUnit.NANOSECONDS.toSeconds(timeoutNanos),
             endpoint,
             grpcStubFactory,
@@ -245,11 +236,10 @@ public GrpcExporter<T> build() {
     LOGGER.log(Level.FINE, "Using GrpcSender: " + grpcSender.getClass().getName());
 
     return new GrpcExporter<>(
-        legacyExporterName,
-        signal,
         grpcSender,
         internalTelemetrySchemaVersion,
-        ComponentId.generateLazy(componentType),
+        ComponentId.generateLazy(exporterType),
+        exporterType,
         meterProviderSupplier,
         ServerAttributesUtil.extractServerAttributes(endpoint));
   }
@@ -259,8 +249,7 @@ public String toString(boolean includePrefixAndSuffix) {
         includePrefixAndSuffix
             ? new StringJoiner(", ", "GrpcExporterBuilder{", "}")
             : new StringJoiner(", ");
-    joiner.add("exporterName=" + legacyExporterName);
-    joiner.add("type=" + signal);
+    joiner.add("exporterType=" + exporterType.toString());
     joiner.add("endpoint=" + endpoint.toString());
     joiner.add("endpointPath=" + grpcEndpointPath);
     joiner.add("timeoutNanos=" + timeoutNanos);

exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporter.java

@@ -7,7 +7,6 @@
 
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.MeterProvider;
-import io.opentelemetry.exporter.internal.metrics.ExporterMetrics;
 import io.opentelemetry.exporter.internal.metrics.ExporterInstrumentation;
 import io.opentelemetry.exporter.internal.FailedExportException;
 import io.opentelemetry.exporter.internal.grpc.GrpcExporterUtil;
@@ -43,26 +42,22 @@ public final class HttpExporter<T extends Marshaler> {
   private final ExporterInstrumentation exporterMetrics;
 
   public HttpExporter(
-      String legacyExporterName,
-      ExporterMetrics.Signal type,
       ComponentId componentId,
       HttpSender httpSender,
       Supplier<MeterProvider> meterProviderSupplier,
       InternalTelemetrySchemaVersion internalTelemetrySchemaVersion,
-      boolean exportAsJson,
+      ComponentId.StandardExporterType exporterType,
       Attributes healthMetricAttributes) {
-    this.type = type.toString();
+    this.type = exporterType.signal().toString();
     this.httpSender = httpSender;
-    // TODO: extract server.address and server.port here
     this.exporterMetrics =
         new ExporterInstrumentation(
             internalTelemetrySchemaVersion,
             meterProviderSupplier,
-            type,
             componentId,
-            healthMetricAttributes,
-            legacyExporterName,
-            exportAsJson ? "http-json" : "http");
+            exporterType,
+            healthMetricAttributes
+        );
   }
 
   public CompletableResultCode export(T exportRequest, int numItems) {

exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporterBuilder.java

@@ -9,7 +9,6 @@
 import io.opentelemetry.api.internal.ConfigUtil;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterBuilderUtil;
-import io.opentelemetry.exporter.internal.metrics.ExporterMetrics;
 import io.opentelemetry.exporter.internal.ServerAttributesUtil;
 import io.opentelemetry.exporter.internal.TlsConfigHelper;
 import io.opentelemetry.exporter.internal.compression.Compressor;
@@ -49,9 +48,7 @@ public final class HttpExporterBuilder<T extends Marshaler> {
 
   private static final Logger LOGGER = Logger.getLogger(HttpExporterBuilder.class.getName());
 
-  private final String exporterName;
-  private final ExporterMetrics.Signal signal;
-  private String componentType;
+  private ComponentId.StandardExporterType exporterType;
 
   private String endpoint;
 
@@ -71,13 +68,9 @@ public final class HttpExporterBuilder<T extends Marshaler> {
   @Nullable private ExecutorService executorService;
 
   public HttpExporterBuilder(
-      String exporterName,
-      ExporterMetrics.Signal signal,
-      String componentType,
+      ComponentId.StandardExporterType exporterType,
       String defaultEndpoint) {
-    this.exporterName = exporterName;
-    this.signal = signal;
-    this.componentType = componentType;
+    this.exporterType = exporterType;
 
     endpoint = defaultEndpoint;
   }
@@ -141,11 +134,6 @@ public HttpExporterBuilder<T> setInternalTelemetry(
     return this;
   }
 
-  public HttpExporterBuilder<T> setComponentType(String componentType) {
-    this.componentType = componentType;
-    return this;
-  }
-
   public HttpExporterBuilder<T> setRetryPolicy(@Nullable RetryPolicy retryPolicy) {
     this.retryPolicy = retryPolicy;
     return this;
@@ -168,13 +156,28 @@ public HttpExporterBuilder<T> setExecutorService(ExecutorService executorService
 
   public HttpExporterBuilder<T> exportAsJson() {
     this.exportAsJson = true;
+    exporterType = mapToJsonTypeIfPossible(exporterType);
     return this;
   }
 
+  private static ComponentId.StandardExporterType mapToJsonTypeIfPossible(
+      ComponentId.StandardExporterType componentType) {
+    switch (componentType) {
+      case OTLP_HTTP_SPAN_EXPORTER:
+        return ComponentId.StandardExporterType.OTLP_HTTP_JSON_SPAN_EXPORTER;
+      case OTLP_HTTP_LOG_EXPORTER:
+        return ComponentId.StandardExporterType.OTLP_HTTP_JSON_LOG_EXPORTER;
+      case OTLP_HTTP_METRIC_EXPORTER:
+        return ComponentId.StandardExporterType.OTLP_HTTP_JSON_METRIC_EXPORTER;
+      default:
+        return componentType;
+    }
+  }
+
   @SuppressWarnings("BuilderReturnThis")
   public HttpExporterBuilder<T> copy() {
     HttpExporterBuilder<T> copy =
-        new HttpExporterBuilder<>(exporterName, signal, componentType, endpoint);
+        new HttpExporterBuilder<>(exporterType, endpoint);
     copy.endpoint = endpoint;
     copy.timeoutNanos = timeoutNanos;
     copy.connectTimeoutNanos = connectTimeoutNanos;
@@ -234,13 +237,11 @@ public HttpExporter<T> build() {
     LOGGER.log(Level.FINE, "Using HttpSender: " + httpSender.getClass().getName());
 
     return new HttpExporter<>(
-        exporterName,
-        signal,
-        ComponentId.generateLazy(componentType),
+        ComponentId.generateLazy(exporterType),
         httpSender,
         meterProviderSupplier,
         internalTelemetrySchemaVersion,
-        exportAsJson,
+        exporterType,
         ServerAttributesUtil.extractServerAttributes(endpoint));
   }
 
@@ -249,8 +250,7 @@ public String toString(boolean includePrefixAndSuffix) {
         includePrefixAndSuffix
             ? new StringJoiner(", ", "HttpExporterBuilder{", "}")
             : new StringJoiner(", ");
-    joiner.add("exporterName=" + exporterName);
-    joiner.add("type=" + signal);
+    joiner.add("exporterType=" + exporterType);
     joiner.add("endpoint=" + endpoint);
     joiner.add("timeoutNanos=" + timeoutNanos);
     joiner.add("proxyOptions=" + proxyOptions);

exporters/common/src/main/java/io/opentelemetry/exporter/internal/metrics/ExporterInstrumentation.java

@@ -23,27 +23,20 @@ public class ExporterInstrumentation implements ExporterMetrics {
   public ExporterInstrumentation(
       InternalTelemetrySchemaVersion schema,
       Supplier<MeterProvider> meterProviderSupplier,
-      ExporterMetrics.Signal signal,
       ComponentId componentId,
-      @Nullable Attributes additionalAttributes,
-      String legacyExporterName,
-      String legacyTransportName) {
+      ComponentId.StandardExporterType exporterType,
+      @Nullable Attributes additionalAttributes) {
 
     switch (schema) {
       case DISABLED:
         implementation = NoopExporterMetrics.INSTANCE;
         break;
       case LEGACY:
-        implementation =
-            new LegacyExporterMetrics(
-                meterProviderSupplier,
-                legacyExporterName,
-                signal,
-                legacyTransportName);
+        implementation = LegacyExporterMetrics.isSupportedType(exporterType) ? new LegacyExporterMetrics(meterProviderSupplier,exporterType) : NoopExporterMetrics.INSTANCE;
         break;
       case V1_33:
       case LATEST:
-        implementation = new SemConvExporterMetrics(meterProviderSupplier, signal, componentId, additionalAttributes == null ? Attributes.empty() : additionalAttributes);
+        implementation = new SemConvExporterMetrics(meterProviderSupplier, exporterType.signal(), componentId, additionalAttributes == null ? Attributes.empty() : additionalAttributes);
         break;
       default:
         throw new IllegalStateException("Unhandled case: " + schema);

exporters/common/src/main/java/io/opentelemetry/exporter/internal/metrics/ExporterMetrics.java

@@ -9,14 +9,6 @@
  */
 public interface ExporterMetrics {
 
-  /**
-   * This class is internal and is hence not for public use. Its APIs are unstable and can change at
-   * any time.
-   */
-  enum Signal {
-    SPAN, METRIC, LOG
-  }
-
   Recording startRecordingExport(int itemCount);
 
   /**

exporters/common/src/main/java/io/opentelemetry/exporter/internal/metrics/LegacyExporterMetrics.java

@@ -13,6 +13,7 @@
 import io.opentelemetry.api.metrics.LongCounter;
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.metrics.MeterProvider;
+import io.opentelemetry.sdk.internal.ComponentId;
 import java.util.function.Supplier;
 import javax.annotation.Nullable;
 
@@ -42,18 +43,35 @@ public class LegacyExporterMetrics implements ExporterMetrics {
 
   LegacyExporterMetrics(
       Supplier<MeterProvider> meterProviderSupplier,
-      String exporterName,
-      Signal signal,
-      String transportName) {
+      ComponentId.StandardExporterType exporterType
+    ) {
     this.meterProviderSupplier = meterProviderSupplier;
-    this.exporterName = exporterName;
-    this.transportName = transportName;
-    this.seenAttrs = Attributes.builder().put(ATTRIBUTE_KEY_TYPE, getTypeString(signal)).build();
+    this.exporterName = getExporterName(exporterType);
+    this.transportName = getTransportName(exporterType);
+    this.seenAttrs = Attributes.builder().put(ATTRIBUTE_KEY_TYPE, getTypeString(exporterType.signal())).build();
     this.successAttrs = this.seenAttrs.toBuilder().put(ATTRIBUTE_KEY_SUCCESS, true).build();
     this.failedAttrs = this.seenAttrs.toBuilder().put(ATTRIBUTE_KEY_SUCCESS, false).build();
   }
 
-  private static String getTypeString(Signal signal) {
+  public static boolean isSupportedType(ComponentId.StandardExporterType exporterType) {
+    switch (exporterType) {
+      case OTLP_GRPC_SPAN_EXPORTER:
+      case OTLP_HTTP_SPAN_EXPORTER:
+      case OTLP_HTTP_JSON_SPAN_EXPORTER:
+      case ZIPKIN_HTTP_SPAN_EXPORTER:
+      case ZIPKIN_HTTP_JSON_SPAN_EXPORTER:
+      case OTLP_GRPC_LOG_EXPORTER:
+      case OTLP_HTTP_LOG_EXPORTER:
+      case OTLP_HTTP_JSON_LOG_EXPORTER:
+      case OTLP_GRPC_METRIC_EXPORTER:
+      case OTLP_HTTP_METRIC_EXPORTER:
+      case OTLP_HTTP_JSON_METRIC_EXPORTER:
+        return true;
+    }
+    return false;
+  }
+
+  private static String getTypeString(ComponentId.StandardExporterType.Signal signal) {
     switch (signal) {
       case SPAN:
         return "span";
@@ -62,7 +80,46 @@ private static String getTypeString(Signal signal) {
       case METRIC:
         return "metric";
     }
-    throw new IllegalArgumentException("Unhandled case: " + signal);
+    throw new IllegalArgumentException("Unhandled signal type: " + signal);
+  }
+
+  private static String getExporterName(ComponentId.StandardExporterType exporterType) {
+    switch (exporterType) {
+      case OTLP_GRPC_SPAN_EXPORTER:
+      case OTLP_HTTP_SPAN_EXPORTER:
+      case OTLP_HTTP_JSON_SPAN_EXPORTER:
+      case OTLP_GRPC_LOG_EXPORTER:
+      case OTLP_HTTP_LOG_EXPORTER:
+      case OTLP_HTTP_JSON_LOG_EXPORTER:
+      case OTLP_GRPC_METRIC_EXPORTER:
+      case OTLP_HTTP_METRIC_EXPORTER:
+      case OTLP_HTTP_JSON_METRIC_EXPORTER:
+        return "otlp";
+      case ZIPKIN_HTTP_SPAN_EXPORTER:
+      case ZIPKIN_HTTP_JSON_SPAN_EXPORTER:
+        return "zipkin";
+    }
+    throw new IllegalArgumentException("Not a supported exporter type: " + exporterType);
+  }
+
+  private static String getTransportName(ComponentId.StandardExporterType exporterType) {
+    switch (exporterType) {
+      case OTLP_GRPC_SPAN_EXPORTER:
+      case OTLP_GRPC_LOG_EXPORTER:
+      case OTLP_GRPC_METRIC_EXPORTER:
+        return "grpc";
+      case OTLP_HTTP_SPAN_EXPORTER:
+      case OTLP_HTTP_LOG_EXPORTER:
+      case OTLP_HTTP_METRIC_EXPORTER:
+      case ZIPKIN_HTTP_SPAN_EXPORTER:
+        return "http";
+      case OTLP_HTTP_JSON_SPAN_EXPORTER:
+      case OTLP_HTTP_JSON_LOG_EXPORTER:
+      case OTLP_HTTP_JSON_METRIC_EXPORTER:
+      case ZIPKIN_HTTP_JSON_SPAN_EXPORTER:
+        return "http-json";
+    }
+    throw new IllegalArgumentException("Not a supported exporter type: " + exporterType);
   }
 
   /** Record number of records seen. */