Release the vercel-runtime trace propagator and span processor (#155)

* Release `vercel-runtime` trace propagator and span processor; remove experimental options from types and update SDK to include new propagator and processor.

* fix tests

* remove comment

Author: agadzik

.changeset/tall-kids-warn.md

@@ -0,0 +1,5 @@
+---
+"@vercel/otel": minor
+---
+
+Releases the `vercel-runtime` trace propagator and span processor

packages/bridge-emulator/src/server/index.ts

@@ -1,6 +1,7 @@
 import type { Configuration } from "@vercel/otel";
 import type {
   Context,
+  SpanContext,
   TextMapGetter,
   TextMapPropagator,
   TextMapSetter,
@@ -12,6 +13,10 @@ export interface VercelRequestContext {
   ) => void;
   headers: Record<string, string | undefined>;
   url: string;
+  telemetry?: {
+    reportSpans: (data: unknown) => void;
+    rootSpanContext?: SpanContext;
+  };
   [key: symbol]: unknown;
 }
 
@@ -100,6 +105,12 @@ export class BridgeEmulatorContextReader implements TextMapPropagator {
               }
             });
         },
+        telemetry: {
+          reportSpans: (data): void => {
+            // eslint-disable-next-line no-console
+            console.log("[BridgeEmulatorServer] reportSpans", data);
+          },
+        },
       };
     }
 

packages/otel/src/sdk.ts

@@ -15,7 +15,12 @@ import {
   BatchSpanProcessor,
   RandomIdGenerator,
 } from "@opentelemetry/sdk-trace-base";
-import { metrics, diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
+import {
+  metrics,
+  diag,
+  DiagConsoleLogger,
+  DiagLogLevel,
+} from "@opentelemetry/api";
 import { logs } from "@opentelemetry/api-logs";
 import { registerInstrumentations } from "@opentelemetry/instrumentation/build/src/autoLoader";
 import {
@@ -72,7 +77,7 @@ export class Sdk {
   private meterProvider: MeterProvider | undefined;
   private disableInstrumentations: (() => void) | undefined;
 
-  public constructor(private configuration: Configuration = {}) { }
+  public constructor(private configuration: Configuration = {}) {}
 
   public start(): void {
     const env = getEnv();
@@ -278,7 +283,8 @@ function parsePropagators(
 ): TextMapPropagator[] {
   const envPropagators =
     process.env.OTEL_PROPAGATORS &&
-      env.OTEL_PROPAGATORS && env.OTEL_PROPAGATORS.length > 0
+    env.OTEL_PROPAGATORS &&
+    env.OTEL_PROPAGATORS.length > 0
       ? env.OTEL_PROPAGATORS
       : undefined;
   return (arg ?? envPropagators ?? ["auto"])
@@ -296,6 +302,10 @@ function parsePropagators(
           name: "baggage",
           propagator: new W3CBaggagePropagator(),
         });
+        autoList.push({
+          name: "vercel-runtime",
+          propagator: new VercelRuntimePropagator(),
+        });
 
         diag.debug(
           `@vercel/otel: Configure propagators: ${autoList
@@ -304,10 +314,6 @@ function parsePropagators(
         );
         return autoList.map((i) => i.propagator);
       }
-      if (propagatorOrName === "experimental-vercel-trace") {
-        diag.debug("@vercel/otel: Configure propagator: vercel-runtime");
-        return new VercelRuntimePropagator();
-      }
       if (propagatorOrName === "tracecontext") {
         diag.debug("@vercel/otel: Configure propagator: tracecontext");
         return new W3CTraceContextPropagator();
@@ -411,8 +417,12 @@ function parseSpanProcessor(
 ): SpanProcessor[] {
   return [
     ...(arg ?? ["auto"])
-      .map((spanProcessorOrName) => {
+      .flatMap((spanProcessorOrName) => {
         if (spanProcessorOrName === "auto") {
+          const processors: SpanProcessor[] = [
+            new BatchSpanProcessor(new VercelRuntimeSpanExporter()),
+          ];
+
           if (process.env.VERCEL_OTEL_ENDPOINTS) {
             // OTEL collector is configured on 4318 port.
             const port = process.env.VERCEL_OTEL_ENDPOINTS_PORT || "4318";
@@ -433,11 +443,12 @@ function parseSpanProcessor(
               protocol === "http/protobuf"
                 ? new OTLPHttpProtoTraceExporter(config)
                 : new OTLPHttpJsonTraceExporter(config);
-            return new BatchSpanProcessor(exporter);
+
+            processors.push(new BatchSpanProcessor(exporter));
           }
 
           // Consider going throw `VERCEL_OTEL_ENDPOINTS` (otel collector) for OTLP.
-          if (
+          else if (
             !configuration.traceExporter ||
             configuration.traceExporter === "auto" ||
             env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT ||
@@ -446,10 +457,7 @@ function parseSpanProcessor(
             return new BatchSpanProcessor(parseTraceExporter(env));
           }
 
-          return undefined;
-        } else if (spanProcessorOrName === 'experimental-vercel-trace') {
-          diag.debug("@vercel/otel: Configure vercel-runtime exporter");
-          return new BatchSpanProcessor(new VercelRuntimeSpanExporter());
+          return processors;
         }
         return spanProcessorOrName;
       })

packages/otel/src/types.ts

@@ -23,7 +23,6 @@ import type { FetchInstrumentationConfig } from "./instrumentations/fetch";
 export type PropagatorOrName =
   | TextMapPropagator
   | "auto"
-  | "experimental-vercel-trace"
   | "none"
   | "tracecontext"
   | "baggage";
@@ -38,7 +37,7 @@ export type SampleOrName =
   | "parentbased_traceidratio"
   | "traceidratio";
 
-export type SpanProcessorOrName = SpanProcessor | "auto" | "experimental-vercel-trace";
+export type SpanProcessorOrName = SpanProcessor | "auto";
 
 export type SpanExporterOrName = SpanExporter | "auto";