autotel-backends 2.12.33 → 2.12.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autotel-backends",
-  "version": "2.12.33",
+  "version": "2.12.34",
   "description": "Vendor backend configurations for Autotel (Honeycomb, Datadog, etc.)",
   "type": "module",
   "main": "./dist/index.js",
@@ -35,7 +35,6 @@
   },
   "files": [
     "dist",
-    "src",
     "README.md",
     "skills"
   ],
@@ -59,7 +58,7 @@
   "dependencies": {
     "@opentelemetry/exporter-logs-otlp-http": ">=0.218.0",
     "@opentelemetry/sdk-logs": ">=0.218.0",
-    "autotel": "4.1.0"
+    "autotel": "4.2.0"
   },
   "peerDependencies": {
     "@opentelemetry/exporter-metrics-otlp-http": ">=0.218.0",

package/src/datadog.test.ts

@@ -1,232 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { createDatadogConfig } from './datadog';
-
-describe('createDatadogConfig()', () => {
-  describe('validation', () => {
-    it('should throw if apiKey is missing for direct ingestion', () => {
-      expect(() => {
-        createDatadogConfig({
-          service: 'test-service',
-        });
-      }).toThrow('Datadog API key is required for direct cloud ingestion');
-    });
-
-    it('should not throw if apiKey is missing when useAgent is true', () => {
-      expect(() => {
-        createDatadogConfig({
-          service: 'test-service',
-          useAgent: true,
-        });
-      }).not.toThrow();
-    });
-  });
-
-  describe('direct cloud ingestion', () => {
-    it('should return config with correct endpoint and headers', () => {
-      const config = createDatadogConfig({
-        apiKey: 'test-api-key',
-        service: 'my-service',
-      });
-
-      expect(config).toMatchObject({
-        service: 'my-service',
-        endpoint: 'https://otlp.datadoghq.com',
-        headers: 'dd-api-key=test-api-key',
-      });
-    });
-
-    it('should use correct endpoint for EU site', () => {
-      const config = createDatadogConfig({
-        apiKey: 'test-api-key',
-        service: 'my-service',
-        site: 'datadoghq.eu',
-      });
-
-      expect(config.endpoint).toBe('https://otlp.datadoghq.eu');
-    });
-
-    it('should include environment and version when specified', () => {
-      const config = createDatadogConfig({
-        apiKey: 'test-api-key',
-        service: 'my-service',
-        environment: 'production',
-        version: '1.0.0',
-      });
-
-      expect(config.environment).toBe('production');
-      expect(config.version).toBe('1.0.0');
-    });
-  });
-
-  describe('agent mode', () => {
-    it('should use agent endpoint when useAgent is true', () => {
-      const config = createDatadogConfig({
-        service: 'my-service',
-        useAgent: true,
-      });
-
-      expect(config.endpoint).toBe('http://localhost:4318');
-      expect(config.headers).toBeUndefined();
-    });
-
-    it('should use custom agent host and port', () => {
-      const config = createDatadogConfig({
-        service: 'my-service',
-        useAgent: true,
-        agentHost: 'dd-agent',
-        agentPort: 4319,
-      });
-
-      expect(config.endpoint).toBe('http://dd-agent:4319');
-    });
-  });
-
-  describe('enableLogs env var configuration', () => {
-    const originalEnv = { ...process.env };
-
-    beforeEach(() => {
-      // Clear env vars before each test
-      delete process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT;
-      delete process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL;
-      delete process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS;
-      delete process.env.OTEL_RESOURCE_ATTRIBUTES;
-    });
-
-    afterEach(() => {
-      // Restore original env
-      process.env = { ...originalEnv };
-    });
-
-    it('sets OTLP logs env vars for direct ingestion', () => {
-      // Mock the peer dependencies to avoid the error
-      vi.mock('@opentelemetry/sdk-logs', () => ({
-        BatchLogRecordProcessor: vi.fn().mockImplementation(() => ({})),
-      }));
-      vi.mock('@opentelemetry/exporter-logs-otlp-http', () => ({
-        OTLPLogExporter: vi.fn().mockImplementation(() => ({})),
-      }));
-
-      try {
-        createDatadogConfig({
-          apiKey: 'test-key',
-          site: 'datadoghq.eu',
-          service: 'test-service',
-          environment: 'production',
-          version: '1.0.0',
-          enableLogs: true,
-        });
-      } catch {
-        // Ignore peer dependency error - we just want to test env var setting
-      }
-
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT).toBe(
-        'https://otlp.datadoghq.eu/v1/logs',
-      );
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL).toBe(
-        'http/protobuf',
-      );
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS).toBe(
-        'dd-api-key=test-key',
-      );
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toContain(
-        'service.name=test-service',
-      );
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toContain(
-        'deployment.environment=production',
-      );
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toContain(
-        'service.version=1.0.0',
-      );
-    });
-
-    it('sets OTLP logs env vars for agent mode (no api key header)', () => {
-      try {
-        createDatadogConfig({
-          service: 'test-service',
-          useAgent: true,
-          agentHost: 'dd-agent',
-          agentPort: 4318,
-          enableLogs: true,
-        });
-      } catch {
-        // Ignore peer dependency error
-      }
-
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT).toBe(
-        'http://dd-agent:4318/v1/logs',
-      );
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL).toBe(
-        'http/protobuf',
-      );
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS).toBeUndefined();
-    });
-
-    it('does not override existing env vars', () => {
-      process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT =
-        'http://custom:4318/v1/logs';
-      process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = 'grpc';
-      process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS = 'custom-header=value';
-      process.env.OTEL_RESOURCE_ATTRIBUTES = 'custom.attr=value';
-
-      try {
-        createDatadogConfig({
-          apiKey: 'test-key',
-          service: 'test-service',
-          enableLogs: true,
-        });
-      } catch {
-        // Ignore peer dependency error
-      }
-
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT).toBe(
-        'http://custom:4318/v1/logs',
-      );
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL).toBe('grpc');
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS).toBe(
-        'custom-header=value',
-      );
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toBe('custom.attr=value');
-    });
-
-    it('sets resource attributes without optional fields when not provided', () => {
-      try {
-        createDatadogConfig({
-          apiKey: 'test-key',
-          service: 'test-service',
-          enableLogs: true,
-        });
-      } catch {
-        // Ignore peer dependency error
-      }
-
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toBe(
-        'service.name=test-service',
-      );
-    });
-
-    it('does not set env vars when enableLogs is false', () => {
-      createDatadogConfig({
-        apiKey: 'test-key',
-        service: 'test-service',
-        enableLogs: false,
-      });
-
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT).toBeUndefined();
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL).toBeUndefined();
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS).toBeUndefined();
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toBeUndefined();
-    });
-
-    it('does not set env vars by default', () => {
-      createDatadogConfig({
-        apiKey: 'test-key',
-        service: 'test-service',
-      });
-
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT).toBeUndefined();
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL).toBeUndefined();
-      expect(process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS).toBeUndefined();
-      expect(process.env.OTEL_RESOURCE_ATTRIBUTES).toBeUndefined();
-    });
-  });
-});

package/src/datadog.ts

@@ -1,346 +0,0 @@
-/**
- * Datadog preset for autotel
- *
- * Provides a simplified configuration helper for Datadog integration
- * with best practices built-in.
- *
- * @example Direct cloud ingestion (serverless, edge)
- * ```typescript
- * import { init } from 'autotel';
- * import { createDatadogConfig } from 'autotel-backends/datadog';
- *
- * init(createDatadogConfig({
- *   apiKey: process.env.DATADOG_API_KEY!,
- *   service: 'my-lambda',
- *   enableLogs: true,
- * }));
- * ```
- *
- * @example Local Datadog Agent (long-running services, Kubernetes)
- * ```typescript
- * import { init } from 'autotel';
- * import { createDatadogConfig } from 'autotel-backends/datadog';
- *
- * init(createDatadogConfig({
- *   service: 'my-api',
- *   useAgent: true,  // No API key needed - Agent handles it
- * }));
- * ```
- */
-
-import { createRequire } from 'node:module';
-import type { AutotelConfig } from 'autotel';
-import type { LogRecordProcessor } from '@opentelemetry/sdk-logs';
-
-// `__filename` exists under CJS (including esbuild's CJS output wrapper) but
-// not pure ESM. `typeof` is safe against an undeclared identifier and lets
-// the conditional pick the working URL in either format.
-declare const __filename: string | undefined;
-
-/**
- * Datadog site regions
- */
-export type DatadogSite =
-  | 'datadoghq.com' // US1 (default)
-  | 'datadoghq.eu' // EU
-  | 'us3.datadoghq.com' // US3
-  | 'us5.datadoghq.com' // US5
-  | 'ap1.datadoghq.com' // AP1
-  | 'ddog-gov.com'; // US1-FED
-
-/**
- * Configuration options for Datadog preset
- */
-export interface DatadogPresetConfig {
-  /**
-   * Datadog API key (required for direct cloud ingestion).
-   * Not needed if using local Datadog Agent (useAgent: true).
-   *
-   * Get your API key from:
-   * https://app.datadoghq.com/organization-settings/api-keys
-   */
-  apiKey?: string;
-
-  /**
-   * Datadog site/region.
-   * Determines which Datadog intake endpoint to use.
-   *
-   * @default 'datadoghq.com' (US1)
-   */
-  site?: DatadogSite;
-
-  /**
-   * Service name (required).
-   * Appears in Datadog APM, Service Catalog, and all telemetry.
-   */
-  service: string;
-
-  /**
-   * Deployment environment (e.g., 'production', 'staging', 'development').
-   * Used for environment filtering in Datadog.
-   *
-   * @default process.env.DD_ENV || process.env.NODE_ENV || 'development'
-   */
-  environment?: string;
-
-  /**
-   * Service version for deployment tracking.
-   * Enables Deployment Tracking in Datadog APM.
-   *
-   * @default process.env.DD_VERSION || auto-detected from package.json
-   */
-  version?: string;
-
-  /**
-   * Enable log export to Datadog via OTLP.
-   *
-   * When enabled, this:
-   * 1. Sets up OTel Logs SDK with OTLP exporter (for direct OTel logs API usage)
-   * 2. Auto-configures OTEL_EXPORTER_OTLP_LOGS_* env vars for pino-opentelemetry-transport
-   *
-   * For Pino users: Just add pino-opentelemetry-transport to your logger config:
-   * ```typescript
-   * const logger = pino({
-   *   transport: {
-   *     targets: [
-   *       { target: 'pino-pretty' },
-   *       { target: 'pino-opentelemetry-transport' }, // Auto-configured!
-   *     ],
-   *   },
-   * });
-   * ```
-   *
-   * @default false
-   */
-  enableLogs?: boolean;
-
-  /**
-   * Use local Datadog Agent instead of direct cloud ingestion.
-   *
-   * Benefits:
-   * - Lower egress costs (Agent aggregates locally)
-   * - Advanced features: trace-log correlation, multi-line logs, data scrubbing
-   * - 500+ integrations for enrichment
-   * - Infrastructure metrics collection
-   *
-   * Requires: Datadog Agent 7.35+ with OTLP enabled
-   *
-   * @default false
-   */
-  useAgent?: boolean;
-
-  /**
-   * Datadog Agent hostname (when useAgent: true).
-   *
-   * @default 'localhost'
-   */
-  agentHost?: string;
-
-  /**
-   * Datadog Agent OTLP port (when useAgent: true).
-   *
-   * @default 4318 (OTLP HTTP)
-   */
-  agentPort?: number;
-
-  /**
-   * Custom log record processors (advanced).
-   * Overrides the default log processor if enableLogs is true.
-   */
-  logRecordProcessors?: LogRecordProcessor[];
-}
-
-/**
- * Create an autotel configuration optimized for Datadog.
- *
- * This preset handles:
- * - Proper OTLP endpoint configuration (Agent vs direct ingestion)
- *   - Direct: https://otlp.{site} → SDK appends /v1/traces, /v1/metrics, /v1/logs
- *   - Agent: http://localhost:4318 (default)
- * - Datadog API key authentication headers (direct ingestion only)
- * - Unified service tagging (service, env, version)
- * - Resource attribute best practices
- * - Optional log export configuration
- *
- * @param config - Datadog-specific configuration options
- * @returns AutotelConfig ready to pass to init()
- *
- * @example Simple cloud ingestion
- * ```typescript
- * init(createDatadogConfig({
- *   apiKey: process.env.DATADOG_API_KEY!,
- *   service: 'my-app',
- * }));
- * ```
- *
- * @example With logs and custom environment
- * ```typescript
- * init(createDatadogConfig({
- *   apiKey: process.env.DATADOG_API_KEY!,
- *   service: 'my-app',
- *   environment: 'production',
- *   version: '2.1.0',
- *   enableLogs: true,
- * }));
- * ```
- *
- * @example Using local Datadog Agent
- * ```typescript
- * init(createDatadogConfig({
- *   service: 'my-api',
- *   useAgent: true,
- *   agentHost: 'datadog-agent.default.svc.cluster.local', // Kubernetes
- * }));
- * ```
- */
-export function createDatadogConfig(
-  config: DatadogPresetConfig,
-): AutotelConfig {
-  const {
-    apiKey,
-    site = 'datadoghq.com',
-    service,
-    environment,
-    version,
-    enableLogs = false,
-    useAgent = false,
-    agentHost = 'localhost',
-    agentPort = 4318,
-    logRecordProcessors,
-  } = config;
-
-  // Validation: API key required for direct ingestion
-  if (!useAgent && !apiKey) {
-    throw new Error(
-      'Datadog API key is required for direct cloud ingestion. ' +
-        'Either provide apiKey or set useAgent: true to use local Datadog Agent.',
-    );
-  }
-
-  const baseConfig: AutotelConfig = {
-    service,
-    environment,
-    version,
-  };
-
-  // Local Datadog Agent configuration
-  if (useAgent) {
-    const agentEndpoint = `http://${agentHost}:${agentPort}`;
-
-    // Auto-configure env vars for pino-opentelemetry-transport in agent mode
-    if (enableLogs) {
-      const logsEndpoint = `http://${agentHost}:${agentPort}/v1/logs`;
-
-      if (!process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) {
-        process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = logsEndpoint;
-      }
-
-      if (!process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL) {
-        process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = 'http/protobuf';
-      }
-
-      // No API key header needed for agent mode - Agent handles authentication
-
-      const resourceAttrs = [
-        `service.name=${service}`,
-        environment ? `deployment.environment=${environment}` : null,
-        version ? `service.version=${version}` : null,
-      ]
-        .filter(Boolean)
-        .join(',');
-
-      if (!process.env.OTEL_RESOURCE_ATTRIBUTES) {
-        process.env.OTEL_RESOURCE_ATTRIBUTES = resourceAttrs;
-      }
-    }
-
-    return {
-      ...baseConfig,
-      endpoint: agentEndpoint,
-      // No API key or headers needed - Agent handles authentication
-    };
-  }
-
-  // Direct cloud ingestion configuration
-  // Datadog OTLP endpoint: base URL without path (SDK appends /v1/traces, /v1/metrics, /v1/logs)
-  const otlpEndpoint = `https://otlp.${site}`;
-  const authHeaders = `dd-api-key=${apiKey}`;
-
-  const cloudConfig: AutotelConfig = {
-    ...baseConfig,
-    endpoint: otlpEndpoint,
-    headers: authHeaders,
-  };
-
-  // Add log export if enabled
-  if (enableLogs) {
-    // Auto-configure env vars for pino-opentelemetry-transport and other OTel log transports
-    // These are read by pino-opentelemetry-transport, otlp-logger, and similar libraries
-    const logsEndpoint = useAgent
-      ? `http://${agentHost}:${agentPort}/v1/logs`
-      : `https://otlp.${site}/v1/logs`;
-
-    // Only set if not already configured (allow user override)
-    if (!process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) {
-      process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = logsEndpoint;
-    }
-
-    if (!process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL) {
-      process.env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = 'http/protobuf';
-    }
-
-    // Only set API key header for direct cloud ingestion (not agent mode)
-    if (!useAgent && apiKey && !process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS) {
-      process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS = `dd-api-key=${apiKey}`;
-    }
-
-    // Set resource attributes for service identification
-    const resourceAttrs = [
-      `service.name=${service}`,
-      environment ? `deployment.environment=${environment}` : null,
-      version ? `service.version=${version}` : null,
-    ]
-      .filter(Boolean)
-      .join(',');
-
-    if (!process.env.OTEL_RESOURCE_ATTRIBUTES) {
-      process.env.OTEL_RESOURCE_ATTRIBUTES = resourceAttrs;
-    }
-
-    if (logRecordProcessors) {
-      // Use custom processors if provided
-      cloudConfig.logRecordProcessors = logRecordProcessors;
-    } else {
-      // Create default OTLP log exporter
-      try {
-        const pkgRequire = createRequire(
-          typeof __filename === 'string' ? __filename : import.meta.url,
-        );
-        const { BatchLogRecordProcessor } = pkgRequire(
-          '@opentelemetry/sdk-logs',
-        );
-        const { OTLPLogExporter } = pkgRequire(
-          '@opentelemetry/exporter-logs-otlp-http',
-        );
-
-        cloudConfig.logRecordProcessors = [
-          new BatchLogRecordProcessor(
-            new OTLPLogExporter({
-              url: `${otlpEndpoint}/v1/logs`,
-              headers: {
-                'dd-api-key': apiKey,
-              },
-            }),
-          ),
-        ];
-      } catch {
-        throw new Error(
-          'Log export requires @opentelemetry/sdk-logs and @opentelemetry/exporter-logs-otlp-http. ' +
-            'Install them or set enableLogs: false.',
-        );
-      }
-    }
-  }
-
-  return cloudConfig;
-}

package/src/google-cloud.test.ts

@@ -1,56 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { createGoogleCloudConfig } from './google-cloud';
-
-describe('createGoogleCloudConfig()', () => {
-  describe('validation', () => {
-    it('should throw if projectId is missing', () => {
-      expect(() => {
-        createGoogleCloudConfig({
-          // @ts-expect-error - testing missing projectId
-          projectId: '',
-          service: 'test-service',
-        });
-      }).toThrow('projectId is required');
-    });
-  });
-
-  describe('useCollector mode', () => {
-    it('should return endpoint and headers when useCollector is true', () => {
-      const config = createGoogleCloudConfig({
-        projectId: 'my-project',
-        service: 'my-service',
-        useCollector: true,
-      });
-
-      expect(config).toMatchObject({
-        service: 'my-service',
-        endpoint: 'http://localhost:4318',
-        headers: { 'x-goog-user-project': 'my-project' },
-      });
-    });
-
-    it('should use custom collectorEndpoint when provided', () => {
-      const config = createGoogleCloudConfig({
-        projectId: 'my-project',
-        service: 'my-service',
-        useCollector: true,
-        collectorEndpoint: 'http://collector:4318',
-      });
-
-      expect(config.endpoint).toBe('http://collector:4318');
-    });
-
-    it('should pass through environment and version', () => {
-      const config = createGoogleCloudConfig({
-        projectId: 'my-project',
-        service: 'my-service',
-        useCollector: true,
-        environment: 'production',
-        version: '1.2.3',
-      });
-
-      expect(config.environment).toBe('production');
-      expect(config.version).toBe('1.2.3');
-    });
-  });
-});