autotel 4.1.0 → 4.2.0

package/src/env-config.test.ts

@@ -1,323 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import {
-  AlwaysOffSampler,
-  AlwaysOnSampler,
-  ParentBasedSampler,
-  TraceIdRatioBasedSampler,
-} from '@opentelemetry/sdk-trace-base';
-import {
-  resolveOtelEnv,
-  parseResourceAttributes,
-  parseOtlpHeaders,
-  createSamplerFromEnv,
-  envToConfig,
-  resolveConfigFromEnv,
-} from './env-config';
-
-describe('env-config', () => {
-  const originalEnv = process.env;
-
-  beforeEach(() => {
-    // Reset environment before each test
-    process.env = { ...originalEnv };
-  });
-
-  afterEach(() => {
-    // Restore original environment
-    process.env = originalEnv;
-  });
-
-  describe('resolveOtelEnv', () => {
-    it('should resolve standard OTEL env vars', () => {
-      process.env.OTEL_SERVICE_NAME = 'test-service';
-      process.env.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://localhost:4318';
-      process.env.OTEL_EXPORTER_OTLP_PROTOCOL = 'http';
-
-      const env = resolveOtelEnv();
-
-      expect(env.OTEL_SERVICE_NAME).toBe('test-service');
-      expect(env.OTEL_EXPORTER_OTLP_ENDPOINT).toBe('http://localhost:4318');
-      expect(env.OTEL_EXPORTER_OTLP_PROTOCOL).toBe('http');
-    });
-
-    it('should return undefined for unset env vars', () => {
-      const env = resolveOtelEnv();
-
-      expect(env.OTEL_SERVICE_NAME).toBeUndefined();
-      expect(env.OTEL_EXPORTER_OTLP_ENDPOINT).toBeUndefined();
-    });
-
-    it('should validate protocol enum', () => {
-      process.env.OTEL_EXPORTER_OTLP_PROTOCOL = 'grpc';
-      const env = resolveOtelEnv();
-      expect(env.OTEL_EXPORTER_OTLP_PROTOCOL).toBe('grpc');
-    });
-
-    it('should resolve trace sampler env vars', () => {
-      process.env.OTEL_TRACES_SAMPLER = 'traceidratio';
-      process.env.OTEL_TRACES_SAMPLER_ARG = '0.5';
-
-      const env = resolveOtelEnv();
-
-      expect(env.OTEL_TRACES_SAMPLER).toBe('traceidratio');
-      expect(env.OTEL_TRACES_SAMPLER_ARG).toBe('0.5');
-    });
-  });
-
-  describe('parseResourceAttributes', () => {
-    it('should parse comma-separated key=value pairs', () => {
-      const input = 'service.version=1.0.0,deployment.environment=production';
-      const result = parseResourceAttributes(input);
-
-      expect(result).toEqual({
-        'service.version': '1.0.0',
-        'deployment.environment': 'production',
-      });
-    });
-
-    it('should handle single attribute', () => {
-      const result = parseResourceAttributes('team=backend');
-      expect(result).toEqual({ team: 'backend' });
-    });
-
-    it('should handle empty string', () => {
-      expect(parseResourceAttributes('')).toEqual({});
-      expect(parseResourceAttributes('   ')).toEqual({});
-    });
-
-    it('should handle undefined', () => {
-      expect(parseResourceAttributes()).toEqual({});
-    });
-
-    it('should skip invalid pairs without =', () => {
-      const result = parseResourceAttributes('valid=value,invalid,another=ok');
-      expect(result).toEqual({
-        valid: 'value',
-        another: 'ok',
-      });
-    });
-
-    it('should handle whitespace around keys and values', () => {
-      const result = parseResourceAttributes(' key1 = value1 , key2 = value2 ');
-      expect(result).toEqual({
-        key1: 'value1',
-        key2: 'value2',
-      });
-    });
-
-    it('should skip empty pairs', () => {
-      const result = parseResourceAttributes('key1=value1,,key2=value2');
-      expect(result).toEqual({
-        key1: 'value1',
-        key2: 'value2',
-      });
-    });
-
-    it('should handle values with = in them (takes first = as delimiter)', () => {
-      const result = parseResourceAttributes('key=value=with=equals');
-      expect(result).toEqual({
-        key: 'value=with=equals',
-      });
-    });
-  });
-
-  describe('parseOtlpHeaders', () => {
-    it('should parse comma-separated header pairs', () => {
-      const input = 'api-key=secret123,x-custom-header=value';
-      const result = parseOtlpHeaders(input);
-
-      expect(result).toEqual({
-        'api-key': 'secret123',
-        'x-custom-header': 'value',
-      });
-    });
-
-    it('should handle single header', () => {
-      const result = parseOtlpHeaders('authorization=Bearer token');
-      expect(result).toEqual({ authorization: 'Bearer token' });
-    });
-
-    it('should handle empty string', () => {
-      expect(parseOtlpHeaders('')).toEqual({});
-      expect(parseOtlpHeaders('   ')).toEqual({});
-    });
-
-    it('should handle undefined', () => {
-      expect(parseOtlpHeaders()).toEqual({});
-    });
-
-    it('should skip invalid pairs', () => {
-      const result = parseOtlpHeaders('valid=value,invalid,another=ok');
-      expect(result).toEqual({
-        valid: 'value',
-        another: 'ok',
-      });
-    });
-
-    it('should handle whitespace', () => {
-      const result = parseOtlpHeaders(' key1 = value1 , key2 = value2 ');
-      expect(result).toEqual({
-        key1: 'value1',
-        key2: 'value2',
-      });
-    });
-  });
-
-  describe('envToConfig', () => {
-    it('should map OTEL_SERVICE_NAME to service', () => {
-      const config = envToConfig({
-        OTEL_SERVICE_NAME: 'test-service',
-      });
-
-      expect(config.service).toBe('test-service');
-    });
-
-    it('should map OTEL_EXPORTER_OTLP_ENDPOINT to endpoint', () => {
-      const config = envToConfig({
-        OTEL_EXPORTER_OTLP_ENDPOINT: 'http://localhost:4318',
-      });
-
-      expect(config.endpoint).toBe('http://localhost:4318');
-    });
-
-    it('should map OTEL_EXPORTER_OTLP_PROTOCOL to protocol', () => {
-      const config = envToConfig({
-        OTEL_EXPORTER_OTLP_PROTOCOL: 'grpc',
-      });
-
-      expect(config.protocol).toBe('grpc');
-    });
-
-    it('should parse OTEL_EXPORTER_OTLP_HEADERS', () => {
-      const config = envToConfig({
-        OTEL_EXPORTER_OTLP_HEADERS: 'api-key=secret,x-custom=value',
-      });
-
-      expect(config.headers).toEqual({
-        'api-key': 'secret',
-        'x-custom': 'value',
-      });
-    });
-
-    it('should parse OTEL_RESOURCE_ATTRIBUTES', () => {
-      const config = envToConfig({
-        OTEL_RESOURCE_ATTRIBUTES:
-          'service.version=1.0.0,deployment.environment=prod',
-      });
-
-      expect(config.resourceAttributes).toEqual({
-        'service.version': '1.0.0',
-        'deployment.environment': 'prod',
-      });
-    });
-
-    it('should return empty config for no env vars', () => {
-      const config = envToConfig({});
-      expect(config).toEqual({});
-    });
-
-    it('should map OTEL_TRACES_SAMPLER to an SDK sampler', () => {
-      const config = envToConfig({
-        OTEL_TRACES_SAMPLER: 'always_on',
-      });
-
-      expect(config.otelSampler).toBeInstanceOf(AlwaysOnSampler);
-    });
-  });
-
-  describe('createSamplerFromEnv', () => {
-    it('supports always_on', () => {
-      const sampler = createSamplerFromEnv({
-        OTEL_TRACES_SAMPLER: 'always_on',
-      });
-
-      expect(sampler).toBeInstanceOf(AlwaysOnSampler);
-    });
-
-    it('supports always_off', () => {
-      const sampler = createSamplerFromEnv({
-        OTEL_TRACES_SAMPLER: 'always_off',
-      });
-
-      expect(sampler).toBeInstanceOf(AlwaysOffSampler);
-    });
-
-    it('supports traceidratio', () => {
-      const sampler = createSamplerFromEnv({
-        OTEL_TRACES_SAMPLER: 'traceidratio',
-        OTEL_TRACES_SAMPLER_ARG: '0.25',
-      });
-
-      expect(sampler).toBeInstanceOf(TraceIdRatioBasedSampler);
-    });
-
-    it('supports parentbased_traceidratio', () => {
-      const sampler = createSamplerFromEnv({
-        OTEL_TRACES_SAMPLER: 'parentbased_traceidratio',
-        OTEL_TRACES_SAMPLER_ARG: '0.25',
-      });
-
-      expect(sampler).toBeInstanceOf(ParentBasedSampler);
-    });
-
-    it('returns undefined for unsupported remote samplers', () => {
-      const sampler = createSamplerFromEnv({
-        OTEL_TRACES_SAMPLER: 'jaeger_remote',
-      });
-
-      expect(sampler).toBeUndefined();
-    });
-  });
-
-  describe('resolveConfigFromEnv', () => {
-    it('should return config from env vars', () => {
-      process.env.OTEL_SERVICE_NAME = 'test-service';
-      process.env.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://localhost:4318';
-
-      const config = resolveConfigFromEnv();
-
-      expect(config.service).toBe('test-service');
-      expect(config.endpoint).toBe('http://localhost:4318');
-    });
-
-    it('should work with no env vars set', () => {
-      const config = resolveConfigFromEnv();
-      expect(config).toEqual({});
-    });
-
-    it('should parse complex real-world scenario', () => {
-      process.env.OTEL_SERVICE_NAME = 'my-api';
-      process.env.OTEL_EXPORTER_OTLP_ENDPOINT = 'https://api.honeycomb.io';
-      process.env.OTEL_EXPORTER_OTLP_HEADERS =
-        'x-honeycomb-team=abc123,x-honeycomb-dataset=production';
-      process.env.OTEL_RESOURCE_ATTRIBUTES =
-        'service.version=1.2.3,deployment.environment=production,team=backend';
-      process.env.OTEL_EXPORTER_OTLP_PROTOCOL = 'http';
-
-      const config = resolveConfigFromEnv();
-
-      expect(config).toEqual({
-        service: 'my-api',
-        endpoint: 'https://api.honeycomb.io',
-        protocol: 'http',
-        headers: {
-          'x-honeycomb-team': 'abc123',
-          'x-honeycomb-dataset': 'production',
-        },
-        resourceAttributes: {
-          'service.version': '1.2.3',
-          'deployment.environment': 'production',
-          team: 'backend',
-        },
-      });
-    });
-
-    it('should include otelSampler when OTEL_TRACES_SAMPLER is set', () => {
-      process.env.OTEL_TRACES_SAMPLER = 'parentbased_always_off';
-
-      const config = resolveConfigFromEnv();
-
-      expect(config.otelSampler).toBeInstanceOf(ParentBasedSampler);
-    });
-  });
-});

package/src/env-config.ts

@@ -1,309 +0,0 @@
-/**
- * Standard OpenTelemetry environment variables
- */
-import type { Sampler as OtelSampler } from '@opentelemetry/sdk-trace-base';
-import {
-  AlwaysOffSampler,
-  AlwaysOnSampler,
-  ParentBasedSampler,
-  TraceIdRatioBasedSampler,
-} from '@opentelemetry/sdk-trace-base';
-
-export interface OtelEnvVars {
-  OTEL_SERVICE_NAME?: string;
-  OTEL_EXPORTER_OTLP_ENDPOINT?: string;
-  OTEL_EXPORTER_OTLP_HEADERS?: string;
-  OTEL_RESOURCE_ATTRIBUTES?: string;
-  OTEL_EXPORTER_OTLP_PROTOCOL?: 'http' | 'grpc';
-  OTEL_TRACES_SAMPLER?: string;
-  OTEL_TRACES_SAMPLER_ARG?: string;
-}
-
-/**
- * Parsed resource attributes as key-value pairs
- */
-export interface ResourceAttributes {
-  [key: string]: string;
-}
-
-/**
- * Parsed OTLP headers as key-value pairs
- */
-export interface OtlpHeaders {
-  [key: string]: string;
-}
-
-/**
- * Environment-resolved configuration (subset of AutotelConfig)
- * Defined locally to avoid circular dependency with init.ts
- */
-export interface EnvConfig {
-  service?: string;
-  endpoint?: string;
-  protocol?: 'http' | 'grpc';
-  headers?: Record<string, string>;
-  resourceAttributes?: Record<string, string>;
-  otelSampler?: OtelSampler;
-}
-
-/**
- * Validate URL format
- */
-function isValidUrl(urlString: string): boolean {
-  try {
-    const url = new URL(urlString);
-    return url.protocol === 'http:' || url.protocol === 'https:';
-  } catch {
-    return false;
-  }
-}
-
-/**
- * Resolve OpenTelemetry environment variables from process.env
- */
-export function resolveOtelEnv(): OtelEnvVars {
-  const env: OtelEnvVars = {};
-
-  // OTEL_SERVICE_NAME - optional string
-  if (process.env.OTEL_SERVICE_NAME) {
-    const value = process.env.OTEL_SERVICE_NAME.trim();
-    if (value) {
-      env.OTEL_SERVICE_NAME = value;
-    }
-  }
-
-  // OTEL_EXPORTER_OTLP_ENDPOINT - optional URL
-  if (process.env.OTEL_EXPORTER_OTLP_ENDPOINT) {
-    const value = process.env.OTEL_EXPORTER_OTLP_ENDPOINT.trim();
-    if (value && isValidUrl(value)) {
-      env.OTEL_EXPORTER_OTLP_ENDPOINT = value;
-    }
-  }
-
-  // OTEL_EXPORTER_OTLP_HEADERS - optional string
-  if (process.env.OTEL_EXPORTER_OTLP_HEADERS) {
-    const value = process.env.OTEL_EXPORTER_OTLP_HEADERS.trim();
-    if (value) {
-      env.OTEL_EXPORTER_OTLP_HEADERS = value;
-    }
-  }
-
-  // OTEL_RESOURCE_ATTRIBUTES - optional string
-  if (process.env.OTEL_RESOURCE_ATTRIBUTES) {
-    const value = process.env.OTEL_RESOURCE_ATTRIBUTES.trim();
-    if (value) {
-      env.OTEL_RESOURCE_ATTRIBUTES = value;
-    }
-  }
-
-  // OTEL_EXPORTER_OTLP_PROTOCOL - optional enum ('http' | 'grpc')
-  if (process.env.OTEL_EXPORTER_OTLP_PROTOCOL) {
-    const value = process.env.OTEL_EXPORTER_OTLP_PROTOCOL.trim().toLowerCase();
-    if (value === 'http' || value === 'grpc') {
-      env.OTEL_EXPORTER_OTLP_PROTOCOL = value;
-    }
-  }
-
-  if (process.env.OTEL_TRACES_SAMPLER) {
-    const value = process.env.OTEL_TRACES_SAMPLER.trim();
-    if (value) {
-      env.OTEL_TRACES_SAMPLER = value;
-    }
-  }
-
-  if (process.env.OTEL_TRACES_SAMPLER_ARG) {
-    const value = process.env.OTEL_TRACES_SAMPLER_ARG.trim();
-    if (value) {
-      env.OTEL_TRACES_SAMPLER_ARG = value;
-    }
-  }
-
-  return env;
-}
-
-function parseRatioSamplerArg(
-  samplerName: string,
-  samplerArg: string | undefined,
-): number {
-  if (samplerArg === undefined) {
-    return 1.0;
-  }
-
-  const ratio = Number(samplerArg);
-  if (!Number.isFinite(ratio) || ratio < 0 || ratio > 1) {
-    console.error(
-      `[autotel] Invalid OTEL_TRACES_SAMPLER_ARG="${samplerArg}" for ${samplerName}. Expected a number in [0..1]. Falling back to 1.0.`,
-    );
-    return 1.0;
-  }
-
-  return ratio;
-}
-
-function warnOnUnusedSamplerArg(
-  samplerName: string,
-  samplerArg: string | undefined,
-): void {
-  if (samplerArg !== undefined) {
-    console.error(
-      `[autotel] OTEL_TRACES_SAMPLER_ARG is not used by OTEL_TRACES_SAMPLER="${samplerName}". Ignoring value "${samplerArg}".`,
-    );
-  }
-}
-
-export function createSamplerFromEnv(
-  env: Pick<OtelEnvVars, 'OTEL_TRACES_SAMPLER' | 'OTEL_TRACES_SAMPLER_ARG'>,
-): OtelSampler | undefined {
-  const samplerName = env.OTEL_TRACES_SAMPLER;
-  if (!samplerName) {
-    return undefined;
-  }
-
-  switch (samplerName) {
-    case 'always_on':
-      warnOnUnusedSamplerArg(samplerName, env.OTEL_TRACES_SAMPLER_ARG);
-      return new AlwaysOnSampler();
-    case 'always_off':
-      warnOnUnusedSamplerArg(samplerName, env.OTEL_TRACES_SAMPLER_ARG);
-      return new AlwaysOffSampler();
-    case 'traceidratio':
-      return new TraceIdRatioBasedSampler(
-        parseRatioSamplerArg(samplerName, env.OTEL_TRACES_SAMPLER_ARG),
-      );
-    case 'parentbased_always_on':
-      warnOnUnusedSamplerArg(samplerName, env.OTEL_TRACES_SAMPLER_ARG);
-      return new ParentBasedSampler({ root: new AlwaysOnSampler() });
-    case 'parentbased_always_off':
-      warnOnUnusedSamplerArg(samplerName, env.OTEL_TRACES_SAMPLER_ARG);
-      return new ParentBasedSampler({ root: new AlwaysOffSampler() });
-    case 'parentbased_traceidratio':
-      return new ParentBasedSampler({
-        root: new TraceIdRatioBasedSampler(
-          parseRatioSamplerArg(samplerName, env.OTEL_TRACES_SAMPLER_ARG),
-        ),
-      });
-    case 'jaeger_remote':
-    case 'parentbased_jaeger_remote':
-    case 'xray':
-      console.error(
-        `[autotel] OTEL_TRACES_SAMPLER="${samplerName}" is not supported yet by autotel. Falling back to the next sampler source.`,
-      );
-      return undefined;
-    default:
-      console.error(
-        `[autotel] Unknown OTEL_TRACES_SAMPLER="${samplerName}". Falling back to the next sampler source.`,
-      );
-      return undefined;
-  }
-}
-
-/**
- * Parse OTEL_RESOURCE_ATTRIBUTES from comma-separated key=value pairs
- * Example: "service.version=1.0.0,deployment.environment=production"
- */
-export function parseResourceAttributes(
-  input: string | undefined,
-): ResourceAttributes {
-  if (!input || input.trim() === '') {
-    return {};
-  }
-
-  const attributes: ResourceAttributes = {};
-  const pairs = input.split(',');
-
-  for (const pair of pairs) {
-    const trimmedPair = pair.trim();
-    if (!trimmedPair) continue;
-
-    const equalIndex = trimmedPair.indexOf('=');
-    if (equalIndex === -1) {
-      // Invalid format, skip this pair
-      continue;
-    }
-
-    const key = trimmedPair.slice(0, equalIndex).trim();
-    const value = trimmedPair.slice(equalIndex + 1).trim();
-
-    if (key && value) {
-      attributes[key] = value;
-    }
-  }
-
-  return attributes;
-}
-
-/**
- * Parse OTEL_EXPORTER_OTLP_HEADERS from comma-separated key=value pairs
- * Example: "api-key=secret123,x-custom-header=value"
- */
-export function parseOtlpHeaders(input: string | undefined): OtlpHeaders {
-  if (!input || input.trim() === '') {
-    return {};
-  }
-
-  const headers: OtlpHeaders = {};
-  const pairs = input.split(',');
-
-  for (const pair of pairs) {
-    const trimmedPair = pair.trim();
-    if (!trimmedPair) continue;
-
-    const equalIndex = trimmedPair.indexOf('=');
-    if (equalIndex === -1) {
-      // Invalid format, skip this pair
-      continue;
-    }
-
-    const key = trimmedPair.slice(0, equalIndex).trim();
-    const value = trimmedPair.slice(equalIndex + 1).trim();
-
-    if (key && value) {
-      headers[key] = value;
-    }
-  }
-
-  return headers;
-}
-
-/**
- * Convert resolved environment variables to config
- */
-export function envToConfig(env: OtelEnvVars): EnvConfig {
-  const config: EnvConfig = {};
-
-  if (env.OTEL_SERVICE_NAME) {
-    config.service = env.OTEL_SERVICE_NAME;
-  }
-
-  if (env.OTEL_EXPORTER_OTLP_ENDPOINT) {
-    config.endpoint = env.OTEL_EXPORTER_OTLP_ENDPOINT;
-  }
-
-  if (env.OTEL_EXPORTER_OTLP_PROTOCOL) {
-    config.protocol = env.OTEL_EXPORTER_OTLP_PROTOCOL;
-  }
-
-  if (env.OTEL_EXPORTER_OTLP_HEADERS) {
-    config.headers = parseOtlpHeaders(env.OTEL_EXPORTER_OTLP_HEADERS);
-  }
-
-  const resourceAttrs = parseResourceAttributes(env.OTEL_RESOURCE_ATTRIBUTES);
-  if (Object.keys(resourceAttrs).length > 0) {
-    config.resourceAttributes = resourceAttrs;
-  }
-
-  const sampler = createSamplerFromEnv(env);
-  if (sampler) {
-    config.otelSampler = sampler;
-  }
-
-  return config;
-}
-
-/**
- * Main function to resolve config from environment variables
- */
-export function resolveConfigFromEnv(): EnvConfig {
-  const env = resolveOtelEnv();
-  return envToConfig(env);
-}