feat!: add spanProcessors property (#460)

* feat!: add `spanProcessors` property

* chore: update test

* feat: export more types

* refactor: remove `extraSpanProcessors`

Author: eduardoboucas

packages/otel/package.json

@@ -65,6 +65,20 @@
         "types": "./dist/instrumentations/fetch.d.ts",
         "default": "./dist/instrumentations/fetch.js"
       }
+    },
+    "./opentelemetry": {
+      "require": {
+        "types": "./dist/opentelemetry.d.cts",
+        "default": "./dist/opentelemetry.cjs"
+      },
+      "import": {
+        "types": "./dist/opentelemetry.d.ts",
+        "default": "./dist/opentelemetry.js"
+      },
+      "default": {
+        "types": "./dist/opentelemetry.d.ts",
+        "default": "./dist/opentelemetry.js"
+      }
     }
   },
   "files": [

packages/otel/src/bootstrap/main.ts

@@ -3,35 +3,26 @@ import type { Instrumentation } from '@opentelemetry/instrumentation'
 import { GET_TRACER, SHUTDOWN_TRACERS } from '../constants.js'
 
 export interface TracerProviderOptions {
-  /**
-   * The request headers (checked for presence of the `x-nf-enable-tracing` header)
-   */
-  headers: Headers
   serviceName: string
   serviceVersion: string
   deploymentEnvironment: string
   siteUrl: string
   siteId: string
   siteName: string
   instrumentations?: (Instrumentation | Promise<Instrumentation>)[]
-  extraSpanProcessors?: (SpanProcessor | Promise<SpanProcessor>)[]
+  spanProcessors?: (SpanProcessor | Promise<SpanProcessor>)[]
 }
 
 export const createTracerProvider = async (options: TracerProviderOptions) => {
-  if (!options.headers.has('x-nf-enable-tracing')) {
-    return
-  }
   const { version: nodeVersion } = await import('node:process')
+
   // remove the v prefix from the version to match the spec
   const runtimeVersion = nodeVersion.slice(1)
 
   const { Resource } = await import('@opentelemetry/resources')
-  const { NodeTracerProvider, SimpleSpanProcessor } = await import('@opentelemetry/sdk-trace-node')
-
+  const { NodeTracerProvider } = await import('@opentelemetry/sdk-trace-node')
   const { registerInstrumentations } = await import('@opentelemetry/instrumentation')
 
-  const { NetlifySpanExporter } = await import('../exporters/netlify.js')
-
   const resource = new Resource({
     'service.name': options.serviceName,
     'service.version': options.serviceVersion,
@@ -43,12 +34,11 @@ export const createTracerProvider = async (options: TracerProviderOptions) => {
     'netlify.site.name': options.siteName,
   })
 
+  const spanProcessors = await Promise.all(options.spanProcessors ?? [await getBaseSpanProcessor()])
+
   const nodeTracerProvider = new NodeTracerProvider({
     resource,
-    spanProcessors: [
-      new SimpleSpanProcessor(new NetlifySpanExporter()),
-      ...(await Promise.all(options.extraSpanProcessors ?? [])),
-    ],
+    spanProcessors,
   })
 
   nodeTracerProvider.register()
@@ -86,3 +76,10 @@ export const createTracerProvider = async (options: TracerProviderOptions) => {
     },
   })
 }
+
+export const getBaseSpanProcessor = async (): Promise<SpanProcessor> => {
+  const { SimpleSpanProcessor } = await import('@opentelemetry/sdk-trace-node')
+  const { NetlifySpanExporter } = await import('../exporters/netlify.js')
+
+  return new SimpleSpanProcessor(new NetlifySpanExporter())
+}

packages/otel/src/main.test.ts

@@ -9,7 +9,6 @@ describe('`getTracer` export', () => {
   })
   test('Returns tracer if tracing has been previously activated', async () => {
     await createTracerProvider({
-      headers: new Headers({ 'x-nf-enable-tracing': 'true' }),
       serviceName: 'test-service',
       serviceVersion: '1.0.0',
       deploymentEnvironment: 'test',
@@ -27,7 +26,6 @@ describe('`shutdownTracers` export', () => {
   })
   test('Returns undefined if tracing has been previously activated', async () => {
     await createTracerProvider({
-      headers: new Headers({ 'x-nf-enable-tracing': 'true' }),
       serviceName: 'test-service',
       serviceVersion: '1.0.0',
       deploymentEnvironment: 'test',

packages/otel/src/opentelemetry.test.ts

@@ -0,0 +1,14 @@
+import { describe, test, expect } from 'vitest'
+import { SimpleSpanProcessor, BatchSpanProcessor } from './opentelemetry.js'
+
+describe('OpenTelemetry exports', () => {
+  test('exports SimpleSpanProcessor', () => {
+    expect(SimpleSpanProcessor).toBeDefined()
+    expect(typeof SimpleSpanProcessor).toBe('function')
+  })
+
+  test('exports BatchSpanProcessor', () => {
+    expect(BatchSpanProcessor).toBeDefined()
+    expect(typeof BatchSpanProcessor).toBe('function')
+  })
+})

packages/otel/src/opentelemetry.ts

@@ -0,0 +1,17 @@
+/**
+ * Re-exports of commonly used OpenTelemetry primitives
+ * This ensures version compatibility when building custom exporters and processors
+ */
+export type {
+  Span,
+  Context,
+  Attributes,
+  SpanContext,
+  SpanKind,
+  SpanStatus,
+  SpanStatusCode,
+  TimeInput,
+} from '@opentelemetry/api'
+export type { ExportResult, ExportResultCode } from '@opentelemetry/core'
+export { SimpleSpanProcessor, BatchSpanProcessor } from '@opentelemetry/sdk-trace-node'
+export type { SpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-node'

packages/otel/tsup.config.ts

@@ -6,7 +6,13 @@ export default defineConfig([
   {
     clean: true,
     format: ['cjs', 'esm'],
-    entry: ['src/bootstrap/main.ts', 'src/main.ts', 'src/exporters/netlify.ts', 'src/instrumentations/fetch.ts'],
+    entry: [
+      'src/bootstrap/main.ts',
+      'src/main.ts',
+      'src/exporters/netlify.ts',
+      'src/instrumentations/fetch.ts',
+      'src/opentelemetry.ts',
+    ],
     tsconfig: 'tsconfig.json',
     splitting: false,
     bundle: true,