feat(sdk-node): set TracerProvider in startNodeSDK() (#6607)

Author: maryliag

experimental/CHANGELOG.md

@@ -11,6 +11,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 ### :rocket: Features
 
 * feat(sdk-node): wire attribute_keys from declarative configuration to ViewOptions.attributesProcessors [#6427](https://github.com/open-telemetry/opentelemetry-js/issues/6427) @ravitheja4531-cell
+* feat(sdk-node): set TracerProvider in startNodeSDK() [#6607](https://github.com/open-telemetry/opentelemetry-js/pull/6607) @maryliag
 
 ### :bug: Bug Fixes
 
@@ -61,7 +62,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 * feat(configuration): add sampler configuration parsing support [#6409](https://github.com/open-telemetry/opentelemetry-js/pull/6409) @MikeGoldsmith
 * feat(configuration): add resource detection parsing [#6435](https://github.com/open-telemetry/opentelemetry-js/pull/6435) @MikeGoldsmith
 * feat(configuration): export interfaces required in other packages [#6462](https://github.com/open-telemetry/opentelemetry-js/pull/6462) @maryliag
-* feat(configuration): set MeterProvider on sdk start [#6463](https://github.com/open-telemetry/opentelemetry-js/pull/6463) @maryliag
+* feat(sdk-node): set MeterProvider in startNodeSDK() [#6463](https://github.com/open-telemetry/opentelemetry-js/pull/6463) @maryliag
 * feat(configuration): export interfaces required in other packages [#6507](https://github.com/open-telemetry/opentelemetry-js/pull/6507) @maryliag
 * feat(configuration): refactoring config loader to print warning message [#6524](https://github.com/open-telemetry/opentelemetry-js/pull/6524) @maxday
 * feat(configuration): export `SamplerConfigModel` type for use with `buildSamplerFromConfig` [#6536](https://github.com/open-telemetry/opentelemetry-js/pull/6536) @ravitheja4531-cell

experimental/packages/configuration/src/index.ts

@@ -17,4 +17,8 @@ export type {
   SpanExporter as SpanExporterConfigModel,
   SpanProcessor as SpanProcessorConfigModel,
 } from './models/tracerProviderModel';
+export type {
+  NameStringValuePair as NameStringValuePairConfigModel,
+  HttpTls as HttpTlsConfigModel,
+} from './models/commonModel';
 export { createConfigFactory } from './ConfigFactory';

experimental/packages/opentelemetry-sdk-node/src/start.ts

@@ -12,6 +12,7 @@ import {
   diag,
   DiagConsoleLogger,
   metrics,
+  trace,
   propagation,
 } from '@opentelemetry/api';
 import {
@@ -22,6 +23,8 @@ import {
   getPropagatorFromConfiguration,
   getResourceDetectorsFromConfiguration,
   getResourceFromConfiguration,
+  getSpanLimitsFromConfiguration,
+  getSpanProcessorsFromConfiguration,
 } from './utils';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import type { SDKComponents, SDKOptions } from './types';
@@ -40,6 +43,7 @@ import {
 } from '@opentelemetry/resources';
 import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
 import { ATTR_SERVICE_INSTANCE_ID } from './semconv';
+import { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
 
 /**
  * @experimental Function to start the OpenTelemetry Node SDK
@@ -71,6 +75,9 @@ export function startNodeSDK(sdkOptions: SDKOptions): {
   if (components.meterProvider) {
     metrics.setGlobalMeterProvider(components.meterProvider);
   }
+  if (components.tracerProvider) {
+    trace.setGlobalTracerProvider(components.tracerProvider);
+  }
   if (components.propagator) {
     propagation.setGlobalPropagator(components.propagator);
   }
@@ -83,6 +90,9 @@ export function startNodeSDK(sdkOptions: SDKOptions): {
     if (components.meterProvider) {
       promises.push(components.meterProvider.shutdown());
     }
+    if (components.tracerProvider) {
+      promises.push(components.tracerProvider.shutdown());
+    }
     await Promise.all(promises);
   };
   return { shutdown: shutdownFn };
@@ -134,6 +144,25 @@ function create(
     components.meterProvider = meterProvider;
   }
 
+  const spanProcessors = getSpanProcessorsFromConfiguration(config);
+  if (spanProcessors) {
+    const spanLimits = getSpanLimitsFromConfiguration(config);
+    // TODO (6506): support sampler configuration from config
+    const tracerProvider = new BasicTracerProvider({
+      resource,
+      spanProcessors,
+      spanLimits,
+      generalLimits: {
+        attributeValueLengthLimit:
+          config.attribute_limits?.attribute_value_length_limit,
+        attributeCountLimit: config.attribute_limits?.attribute_count_limit,
+      },
+      // TODO (6616): support idGenerator configuration from config
+      // TODO (6624): support for `meterProvider: components.meterProvider`
+    });
+    components.tracerProvider = tracerProvider;
+  }
+
   return components;
 }
 

experimental/packages/opentelemetry-sdk-node/src/types.ts

@@ -20,6 +20,7 @@ import type {
   SpanProcessor,
   IdGenerator,
 } from '@opentelemetry/sdk-trace-base';
+import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
 
 export interface NodeSDKConfiguration {
   autoDetectResources: boolean;
@@ -57,5 +58,6 @@ export interface SDKComponents {
   contextManager: ContextManager;
   loggerProvider?: LoggerProvider;
   meterProvider?: MeterProvider;
+  tracerProvider?: BasicTracerProvider;
   propagator?: TextMapPropagator;
 }

experimental/packages/opentelemetry-sdk-node/src/utils.ts

@@ -33,6 +33,7 @@ import {
 import type {
   Sampler,
   SpanExporter,
+  SpanLimits,
   SpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
 import {
@@ -57,7 +58,10 @@ import type {
   InstrumentTypeConfigModel,
   AggregationConfigModel,
   PeriodicMetricReaderConfigModel,
+  SpanExporterConfigModel,
   SamplerConfigModel,
+  NameStringValuePairConfigModel,
+  HttpTlsConfigModel,
 } from '@opentelemetry/configuration';
 import type {
   AggregationOption,
@@ -88,6 +92,7 @@ import {
   ConsoleLogRecordExporter,
   SimpleLogRecordProcessor,
 } from '@opentelemetry/sdk-logs';
+import * as fs from 'fs';
 
 const RESOURCE_DETECTOR_ENVIRONMENT = 'env';
 const RESOURCE_DETECTOR_HOST = 'host';
@@ -675,6 +680,151 @@ export function getLogRecordProcessorsFromConfiguration(
   return undefined;
 }
 
+export function getHeadersFromConfiguration(
+  headers: NameStringValuePairConfigModel[] | undefined
+): Record<string, string> | undefined {
+  if (!headers) {
+    return undefined;
+  }
+  const result: Record<string, string> = {};
+  headers.forEach(header => {
+    result[header.name] = header.value;
+  });
+  return result;
+}
+
+export function getHttpAgentOptionsFromTls(
+  tls: HttpTlsConfigModel | undefined
+): { ca?: Buffer; cert?: Buffer; key?: Buffer } | undefined {
+  if (tls && (tls.ca_file || tls.cert_file || tls.key_file)) {
+    const httpsAgentOptions: { ca?: Buffer; cert?: Buffer; key?: Buffer } = {};
+    if (tls.ca_file) {
+      try {
+        httpsAgentOptions.ca = fs.readFileSync(tls.ca_file);
+      } catch (e) {
+        diag.warn(`Failed to read TLS CA file at ${tls.ca_file}: ${e}`);
+      }
+    }
+    if (tls.cert_file) {
+      try {
+        httpsAgentOptions.cert = fs.readFileSync(tls.cert_file);
+      } catch (e) {
+        diag.warn(`Failed to read TLS cert file at ${tls.cert_file}: ${e}`);
+      }
+    }
+    if (tls.key_file) {
+      try {
+        httpsAgentOptions.key = fs.readFileSync(tls.key_file);
+      } catch (e) {
+        diag.warn(`Failed to read TLS key file at ${tls.key_file}: ${e}`);
+      }
+    }
+    return httpsAgentOptions;
+  }
+  return undefined;
+}
+
+export function getSpanExporter(
+  exporter: SpanExporterConfigModel
+): SpanExporter | undefined {
+  if (exporter.otlp_http) {
+    const encoding = exporter.otlp_http.encoding;
+    if (encoding === 'json') {
+      return new OTLPHttpTraceExporter({
+        compression:
+          exporter.otlp_http.compression === 'gzip'
+            ? CompressionAlgorithm.GZIP
+            : CompressionAlgorithm.NONE,
+        url: exporter.otlp_http.endpoint,
+        headers: getHeadersFromConfiguration(exporter.otlp_http.headers),
+        timeoutMillis: exporter.otlp_http.timeout,
+        httpAgentOptions: getHttpAgentOptionsFromTls(exporter.otlp_http.tls),
+      });
+    } else {
+      return new OTLPProtoTraceExporter({
+        compression:
+          exporter.otlp_http.compression === 'gzip'
+            ? CompressionAlgorithm.GZIP
+            : CompressionAlgorithm.NONE,
+        url: exporter.otlp_http.endpoint,
+        headers: getHeadersFromConfiguration(exporter.otlp_http.headers),
+        timeoutMillis: exporter.otlp_http.timeout,
+        httpAgentOptions: getHttpAgentOptionsFromTls(exporter.otlp_http.tls),
+      });
+    }
+  } else if (exporter.otlp_grpc) {
+    return new OTLPGrpcTraceExporter({
+      compression:
+        exporter.otlp_grpc.compression === 'gzip'
+          ? CompressionAlgorithm.GZIP
+          : CompressionAlgorithm.NONE,
+      url: exporter.otlp_grpc.endpoint,
+      timeoutMillis: exporter.otlp_grpc.timeout,
+      // TODO (6614): add support for credentials
+      // TODO (6615): add metadata (headers) support
+    });
+  } else if (exporter.console) {
+    return new ConsoleSpanExporter();
+  }
+  diag.warn(`Unsupported Exporter value. No Span Exporter registered`);
+  return undefined;
+}
+
+export function getSpanProcessorsFromConfiguration(
+  config: ConfigurationModel
+): SpanProcessor[] | undefined {
+  const spanProcessors: SpanProcessor[] = [];
+  config.tracer_provider?.processors?.forEach(processor => {
+    if (processor.batch) {
+      const exporter = getSpanExporter(processor.batch.exporter);
+      if (exporter) {
+        spanProcessors.push(
+          new BatchSpanProcessor(exporter, {
+            maxQueueSize: processor.batch.max_queue_size,
+            maxExportBatchSize: processor.batch.max_export_batch_size,
+            scheduledDelayMillis: processor.batch.schedule_delay,
+            exportTimeoutMillis: processor.batch.export_timeout,
+          })
+        );
+      }
+    }
+    if (processor.simple) {
+      const exporter = getSpanExporter(processor.simple.exporter);
+      if (exporter) {
+        spanProcessors.push(new SimpleSpanProcessor(exporter));
+      }
+    }
+  });
+  if (spanProcessors.length > 0) {
+    return spanProcessors;
+  }
+  return undefined;
+}
+
+export function getSpanLimitsFromConfiguration(
+  config: ConfigurationModel
+): SpanLimits | undefined {
+  if (config.tracer_provider?.limits) {
+    const limitsConfig = config.tracer_provider.limits;
+    const spanLimits: SpanLimits = {};
+    spanLimits.attributeCountLimit = limitsConfig.attribute_count_limit ?? 128;
+    spanLimits.eventCountLimit = limitsConfig.event_count_limit ?? 128;
+    spanLimits.linkCountLimit = limitsConfig.link_count_limit ?? 128;
+    spanLimits.attributePerLinkCountLimit =
+      limitsConfig.link_attribute_count_limit ?? 128;
+    spanLimits.attributePerEventCountLimit =
+      limitsConfig.event_attribute_count_limit ?? 128;
+
+    if (limitsConfig.attribute_value_length_limit != null) {
+      spanLimits.attributeValueLengthLimit =
+        limitsConfig.attribute_value_length_limit;
+    }
+
+    return spanLimits;
+  }
+  return undefined;
+}
+
 export function getMeterReadersFromConfiguration(
   config: ConfigurationModel
 ): IMetricReader[] | undefined {

experimental/packages/opentelemetry-sdk-node/test/fixtures/ca-key.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpQIBAAKCAQEA3Tz2mr7SZiAMfQyuvBjM9Oi..Z1BjP5CE/Wm/Rr500P
+RK+Lh9x5eJPo5CAZ3/ANBE0sTK0ZsDGMak2m1g7..3VHqIxFTz0Ta1d+NAj
+wnLe4nOb7/eEJbDPkk05ShhBrJGBKKxb8n104o/..PdzbFMIyNjJzBM2o5y
+5A13wiLitEO7nco2WfyYkQzaxCw0AwzlkVHiIyC..71pSzkv6sv+4IDMbT/
+XpCo8L6wTarzrywnQsh+etLD6FtTjYbbrvZ8RQM..Hg2qxraAV++HNBYmNW
+s0duEdjUbJK+ZarypXI9TtnS4o1Ckj7POfljiQI..IBAFyidxtqRQyv5KrD
+kbJ+q+rsJxQlaipn2M4lGuQJEfIxELFDyd3XpxP..Un/82NZNXlPmRIopXs
+2T91jiLZEUKQw+n73j26adTbteuEaPGSrTZxBLR..yssO0wWomUyILqVeti
+6AkL0NJAuKcucHGqWVgUIa4g1haE0ilcm6dWUDo..fd+PpzdCJf1s4NdUWK
+YV2GJcutGQb+jqT5DTUqAgST7N8M28rwjK6nVMI..BUpP0xpPnuYDyPOw6x
+4hBt8DZQYyduzIXBXRBKNiNdv8fum68/5klHxp6..4HRkMUL958UVeljUsT
+BFQlO9UCgYEA/VqzXVzlz8K36VSTMPEhB5zBATV..PRiXtYK1YpYV4/jSUj
+vvT4hP8uoYNC+BlEMi98LtnxZIh0V4rqHDsScAq..VyeSLH0loKMZgpwFEm
+bEIDnEOD0nKrfT/9K9sPYgvB43wsLEtUujaYw3W..Liy0WKmB8CgYEA34xn
+1QlOOhHBn9Z8qYjoDYhvcj+a89tD9eMPhesfQFw..rsfGcXIonFmWdVygbe
+6Doihc+GIYIq/QP4jgMksE1ADvczJSke92ZfE2i..fitBpQERNJO0BlabfP
+ALs5NssKNmLkWS2U2BHCbv4DzDXwiQB37KPOL1c..kBHfF2/htIs20d1UVL
++PK+aXKwguI6bxLGZ3of0UH+mGsSl0mkp7kYZCm..OTQtfeRqP8rDSC7DgA
+kHc5ajYqh04AzNFaxjRo+M3IGICUaOdKnXd0Fda..QwfoaX4QlRTgLqb7AN
+ZTzM9WbmnYoXrx17kZlT3lsCgYEAm757XI3WJVj..WoLj1+v48WyoxZpcai
+uv9bT4Cj+lXRS+gdKHK+SH7J3x2CRHVS+WH/SVC..DxuybvebDoT0TkKiCj
+BWQaGzCaJqZa+POHK0klvS+9ln0/6k539p95tfX..X4TCzbVG6+gJiX0ysz
+Yfehn5MCgYEAkMiKuWHCsVyCab3RUf6XA9gd3qY..fCTIGtS1tR5PgFIV+G
+engiVoWc/hkj8SBHZz1n1xLN7KDf8ySU06MDggB..hJ+gXJKy+gf3mF5Kmj
+DtkpjGHQzPF6vOe907y5NQLvVFGXUq/FIJZxB8k..fJdHEm2M4=
+-----END RSA PRIVATE KEY-----

experimental/packages/opentelemetry-sdk-node/test/fixtures/ca.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix
+EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD
+VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y
+aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy
+MDQxOTUwMTZaMIGHMQswCQYDVQQGEwJHQjETMBEGA1..29tZS1TdGF0ZTEU
+MBIGA1UEChMLQmVzdCBDQSBMdGQxNzA1BgNVBAsTLk..DEgUHVibGljIFBy
+aW1hcnkgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxFD..AMTC0Jlc3QgQ0Eg
+THRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCg..Tz2mr7SZiAMfQyu
+vBjM9OiJjRazXBZ1BjP5CE/Wm/Rr500PRK+Lh9x5eJ../ANBE0sTK0ZsDGM
+ak2m1g7oruI3dY3VHqIxFTz0Ta1d+NAjwnLe4nOb7/..k05ShhBrJGBKKxb
+8n104o/5p8HAsZPdzbFMIyNjJzBM2o5y5A13wiLitE..fyYkQzaxCw0Awzl
+kVHiIyCuaF4wj571pSzkv6sv+4IDMbT/XpCo8L6wTa..sh+etLD6FtTjYbb
+rvZ8RQM1tlKdoMHg2qxraAV++HNBYmNWs0duEdjUbJ..XI9TtnS4o1Ckj7P
+OfljiQIDAQABo4HnMIHkMB0GA1UdDgQWBBQ8urMCRL..5AkIp9NJHJw5TCB
+tAYDVR0jBIGsMIGpgBQ8urMCRLYYMHUKU5AkIp9NJH..aSBijCBhzELMAkG
+A1UEBhMCR0IxEzARBgNVBAgTClNvbWUtU3RhdGUxFD..AoTC0Jlc3QgQ0Eg
+THRkMTcwNQYDVQQLEy5DbGFzcyAxIFB1YmxpYyBQcm..ENlcnRpZmljYXRp
+b24gQXV0aG9yaXR5MRQwEgYDVQQDEwtCZXN0IENBIE..DAMBgNVHRMEBTAD
+AQH/MA0GCSqGSIb3DQEBBAUAA4IBAQC1uYBcsSncwA..DCsQer772C2ucpX
+xQUE/C0pWWm6gDkwd5D0DSMDJRqV/weoZ4wC6B73f5..bLhGYHaXJeSD6Kr
+XcoOwLdSaGmJYslLKZB3ZIDEp0wYTGhgteb6JFiTtn..sf2xdrYfPCiIB7g
+BMAV7Gzdc4VspS6ljrAhbiiawdBiQlQmsBeFz9JkF4..b3l8BoGN+qMa56Y
+It8una2gY4l2O//on88r5IWJlm1L0oA8e4fR2yrBHX..adsGeFKkyNrwGi/
+7vQMfXdGsRrXNGRGnX+vWDZ3/zWI0joDtCkNnqEpVn..HoX
+-----END CERTIFICATE-----

experimental/packages/opentelemetry-sdk-node/test/fixtures/cert.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix
+EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD
+VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y
+aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy
+MDQxOTUwMTZaMIGHMQswCQYDVQQGEwJHQjETMBEGA1..29tZS1TdGF0ZTEU
+MBIGA1UEChMLQmVzdCBDQSBMdGQxNzA1BgNVBAsTLk..DEgUHVibGljIFBy
+aW1hcnkgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxFD..AMTC0Jlc3QgQ0Eg
+THRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCg..Tz2mr7SZiAMfQyu
+vBjM9OiJjRazXBZ1BjP5CE/Wm/Rr500PRK+Lh9x5eJ../ANBE0sTK0ZsDGM
+ak2m1g7oruI3dY3VHqIxFTz0Ta1d+NAjwnLe4nOb7/..k05ShhBrJGBKKxb
+8n104o/5p8HAsZPdzbFMIyNjJzBM2o5y5A13wiLitE..fyYkQzaxCw0Awzl
+kVHiIyCuaF4wj571pSzkv6sv+4IDMbT/XpCo8L6wTa..sh+etLD6FtTjYbb
+rvZ8RQM1tlKdoMHg2qxraAV++HNBYmNWs0duEdjUbJ..XI9TtnS4o1Ckj7P
+OfljiQIDAQABo4HnMIHkMB0GA1UdDgQWBBQ8urMCRL..5AkIp9NJHJw5TCB
+tAYDVR0jBIGsMIGpgBQ8urMCRLYYMHUKU5AkIp9NJH..aSBijCBhzELMAkG
+A1UEBhMCR0IxEzARBgNVBAgTClNvbWUtU3RhdGUxFD..AoTC0Jlc3QgQ0Eg
+THRkMTcwNQYDVQQLEy5DbGFzcyAxIFB1YmxpYyBQcm..ENlcnRpZmljYXRp
+b24gQXV0aG9yaXR5MRQwEgYDVQQDEwtCZXN0IENBIE..DAMBgNVHRMEBTAD
+AQH/MA0GCSqGSIb3DQEBBAUAA4IBAQC1uYBcsSncwA..DCsQer772C2ucpX
+xQUE/C0pWWm6gDkwd5D0DSMDJRqV/weoZ4wC6B73f5..bLhGYHaXJeSD6Kr
+XcoOwLdSaGmJYslLKZB3ZIDEp0wYTGhgteb6JFiTtn..sf2xdrYfPCiIB7g
+BMAV7Gzdc4VspS6ljrAhbiiawdBiQlQmsBeFz9JkF4..b3l8BoGN+qMa56Y
+It8una2gY4l2O//on88r5IWJlm1L0oA8e4fR2yrBHX..adsGeFKkyNrwGi/
+7vQMfXdGsRrXNGRGnX+vWDZ3/zWI0joDtCkNnqEpVn..HoX
+-----END CERTIFICATE-----