feat(opentelemetry-sdk-node): skeleton for experimental function to start SDK

experimental/packages/configuration/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@opentelemetry/configuration",
-  "private": true,
   "version": "0.208.0",
   "description": "OpenTelemetry Configuration",
   "main": "build/src/index.js",

experimental/packages/opentelemetry-sdk-node/package.json

@@ -44,6 +44,7 @@
   },
   "dependencies": {
     "@opentelemetry/api-logs": "0.208.0",
+    "@opentelemetry/configuration": "0.208.0",
     "@opentelemetry/core": "2.2.0",
     "@opentelemetry/exporter-logs-otlp-grpc": "0.208.0",
     "@opentelemetry/exporter-logs-otlp-http": "0.208.0",

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

@@ -0,0 +1,51 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  ConfigFactory,
+  createConfigFactory,
+} from '@opentelemetry/configuration';
+import { SDKOptions } from './types';
+import { diag, DiagConsoleLogger } from '@opentelemetry/api';
+import { setupContextManager } from './utils';
+
+/**
+ * Experimental function to start the OpenTelemetry Node SDK
+ * @param sdkOptions
+ */
+export const startNodeSDK = (sdkOptions: Partial<SDKOptions> = {}) => {
+  const configFactory: ConfigFactory = createConfigFactory();
+  const config = configFactory.getConfigModel();
+
+  if (config.disabled) {
+    diag.info('OpenTelemetry SDK is disabled');
+    return NOOP_SDK;
+  }
+  if (config.log_level != null) {
+    diag.setLogger(new DiagConsoleLogger(), { logLevel: config.log_level });
+  }
+
+  setupContextManager(sdkOptions?.contextManager);
+
+  const shutdownFn = async () => {
+    const promises: Promise<unknown>[] = [];
+    await Promise.all(promises);
+  };
+  return { shutdown: shutdownFn };
+};
+
+const NOOP_SDK = {
+  shutdown: () => {},
+};

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

@@ -51,3 +51,7 @@ export interface NodeSDKConfiguration {
   spanLimits: SpanLimits;
   idGenerator: IdGenerator;
 }
+
+export interface SDKOptions {
+  contextManager: ContextManager | null;
+}

experimental/packages/opentelemetry-sdk-node/test/sdkNode.test.ts

@@ -0,0 +1,62 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as assert from 'assert';
+import { startNodeSDK } from '../src/start';
+import { context, diag } from '@opentelemetry/api';
+import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
+import * as Sinon from 'sinon';
+
+describe('startNodeSDK', () => {
+  const _origEnvVariables = { ...process.env };
+
+  afterEach(function () {
+    for (const key of Object.keys(process.env)) {
+      delete process.env[key];
+    }
+    for (const [key, value] of Object.entries(_origEnvVariables)) {
+      process.env[key] = value;
+    }
+    Sinon.restore();
+  });
+
+  it('should return NOOP_SDK when disabled is true', () => {
+    const info = Sinon.spy(diag, 'info');
+    process.env.OTEL_SDK_DISABLED = 'true';
+    const sdk = startNodeSDK({});
+
+    Sinon.assert.calledWith(info, 'OpenTelemetry SDK is disabled');
+
+    sdk.shutdown();
+  });
+
+  it('should return NOOP_SDK when disabled is true', () => {
+    process.env.OTEL_EXPERIMENTAL_CONFIG_FILE =
+      'test/fixtures/kitchen-sink.yaml';
+    const sdk = startNodeSDK({});
+
+    assertDefaultContextManagerRegistered();
+
+    sdk.shutdown();
+  });
+});
+
+function assertDefaultContextManagerRegistered() {
+  assert.ok(
+    context['_getContextManager']().constructor.name ===
+      AsyncLocalStorageContextManager.name
+  );
+}

experimental/packages/opentelemetry-sdk-node/tsconfig.json

@@ -45,6 +45,9 @@
     {
       "path": "../api-logs"
     },
+    {
+      "path": "../configuration"
+    },
     {
       "path": "../exporter-logs-otlp-grpc"
     },

tsconfig.json

@@ -6,6 +6,7 @@
     "entryPoints": [
       "api",
       "experimental/packages/api-logs",
+      "experimental/packages/configuration",
       "experimental/packages/exporter-logs-otlp-grpc",
       "experimental/packages/exporter-logs-otlp-http",
       "experimental/packages/exporter-logs-otlp-proto",