/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { DiagConsoleLogger, DiagLogLevel, diag } from '@opentelemetry/api'; import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc'; import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-grpc'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base'; import { NodeSDK } from '@opentelemetry/sdk-node'; import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; import { Resource } from '@opentelemetry/resources'; import { BatchSpanProcessor, ConsoleSpanExporter, } from '@opentelemetry/sdk-trace-node'; import { BatchLogRecordProcessor, ConsoleLogRecordExporter, } from '@opentelemetry/sdk-logs'; import { ConsoleMetricExporter, PeriodicExportingMetricReader, } from '@opentelemetry/sdk-metrics'; import { HttpInstrumentation } from '@opentelemetry/instrumentation-http'; import { Config } from '../config/config.js'; import { SERVICE_NAME } from './constants.js'; import { initializeMetrics } from './metrics.js'; import { logCliConfiguration } from './loggers.js'; // For troubleshooting, set the log level to DiagLogLevel.DEBUG diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO); let sdk: NodeSDK | undefined; let telemetryInitialized = false; export function isTelemetrySdkInitialized(): boolean { return telemetryInitialized; } function parseGrpcEndpoint( otlpEndpointSetting: string | undefined, ): string | undefined { if (!otlpEndpointSetting) { return undefined; } // Trim leading/trailing quotes that might come from env variables const trimmedEndpoint = otlpEndpointSetting.replace(/^["']|["']$/g, ''); try { const url = new URL(trimmedEndpoint); // OTLP gRPC exporters expect an endpoint in the format scheme://host:port // The `origin` property provides this, stripping any path, query, or hash. return url.origin; } catch (error) { diag.error('Invalid OTLP endpoint URL provided:', trimmedEndpoint, error); return undefined; } } export function initializeTelemetry(config: Config): void { if (telemetryInitialized || !config.getTelemetryEnabled()) { return; } const resource = new Resource({ [SemanticResourceAttributes.SERVICE_NAME]: SERVICE_NAME, [SemanticResourceAttributes.SERVICE_VERSION]: process.version, 'session.id': config.getSessionId(), }); const otlpEndpointSetting = config.getTelemetryOtlpEndpoint(); const gcpProjectId = process.env.GOOGLE_CLOUD_PROJECT; let spanExporter; let logExporter; let metricReader; if (otlpEndpointSetting && otlpEndpointSetting.trim() !== '') { const grpcParsedEndpoint = parseGrpcEndpoint(otlpEndpointSetting); if (grpcParsedEndpoint) { diag.info(`Using user-configured OTLP endpoint: ${grpcParsedEndpoint}`); spanExporter = new OTLPTraceExporter({ url: grpcParsedEndpoint, compression: CompressionAlgorithm.GZIP, }); logExporter = new OTLPLogExporter({ url: grpcParsedEndpoint, compression: CompressionAlgorithm.GZIP, }); metricReader = new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: grpcParsedEndpoint, compression: CompressionAlgorithm.GZIP, }), exportIntervalMillis: 10000, }); } else { diag.warn( `Invalid user-configured OTLP endpoint: "${otlpEndpointSetting}". Falling back to console exporter.`, ); spanExporter = new ConsoleSpanExporter(); logExporter = new ConsoleLogRecordExporter(); metricReader = new PeriodicExportingMetricReader({ exporter: new ConsoleMetricExporter(), exportIntervalMillis: 10000, }); } } else if (gcpProjectId) { diag.info( `No OTLP endpoint configured, GOOGLE_CLOUD_PROJECT detected (${gcpProjectId}). Exporting telemetry to Google Cloud.`, ); const gcpTraceUrl = 'https://trace.googleapis.com:443'; const gcpMetricUrl = 'https://monitoring.googleapis.com:443'; const gcpLogUrl = 'https://logging.googleapis.com:443'; spanExporter = new OTLPTraceExporter({ url: gcpTraceUrl, compression: CompressionAlgorithm.GZIP, }); logExporter = new OTLPLogExporter({ url: gcpLogUrl, compression: CompressionAlgorithm.GZIP, }); metricReader = new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: gcpMetricUrl, compression: CompressionAlgorithm.GZIP, }), exportIntervalMillis: 10000, }); } else { diag.info( 'No OTLP endpoint or GOOGLE_CLOUD_PROJECT detected. Using console exporters.', ); spanExporter = new ConsoleSpanExporter(); logExporter = new ConsoleLogRecordExporter(); metricReader = new PeriodicExportingMetricReader({ exporter: new ConsoleMetricExporter(), exportIntervalMillis: 10000, }); } sdk = new NodeSDK({ resource, spanProcessors: [new BatchSpanProcessor(spanExporter)], logRecordProcessor: new BatchLogRecordProcessor(logExporter), metricReader, instrumentations: [new HttpInstrumentation()], }); try { sdk.start(); console.log('OpenTelemetry SDK started successfully.'); telemetryInitialized = true; initializeMetrics(config); logCliConfiguration(config); } catch (error) { console.error('Error starting OpenTelemetry SDK:', error); } process.on('SIGTERM', shutdownTelemetry); process.on('SIGINT', shutdownTelemetry); } export async function shutdownTelemetry(): Promise { if (!telemetryInitialized || !sdk) { return; } try { await sdk.shutdown(); console.log('OpenTelemetry SDK shut down successfully.'); } catch (error) { console.error('Error shutting down SDK:', error); } finally { telemetryInitialized = false; } }