feat(opentelemetry-configuration): Parse of Configuration File (#5875)

Co-authored-by: Marc Pichler <[email protected]>
Co-authored-by: Trent Mick <[email protected]>

Author: 3 people

experimental/CHANGELOG.md

@@ -13,6 +13,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 * feat(otlp-transformer): add span flags support for isRemote property [#5910](https://github.com/open-telemetry/opentelemetry-js/pull/5910) @nikhilmantri0902
 * feat(sampler-composite): Added experimental implementations of draft composite sampling spec [#5839](https://github.com/open-telemetry/opentelemetry-js/pull/5839) @anuraaga
 * feat(opentelemetry-configuration): add more attributes to config model [#5826](https://github.com/open-telemetry/opentelemetry-js/pull/5826) @maryliag
+* feat(opentelemetry-configuration): Parse of Configuration File [#5875](https://github.com/open-telemetry/opentelemetry-js/pull/5875) @maryliag
 
 ### :bug: Bug Fixes
 

experimental/packages/opentelemetry-configuration/package.json

@@ -41,7 +41,8 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/core": "2.1.0"
+    "@opentelemetry/core": "2.1.0",
+    "yaml": "^1.10.2"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.0",

experimental/packages/opentelemetry-configuration/src/EnvironmentConfigProvider.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import { DiagLogLevel } from '@opentelemetry/api';
 import {
   ConfigurationModel,
   initializeDefaultConfiguration,
@@ -36,12 +35,11 @@ export class EnvironmentConfigProvider implements ConfigProvider {
 
   constructor() {
     this._config = initializeDefaultConfiguration();
-    this._config.disable = getBooleanFromEnv('OTEL_SDK_DISABLED');
+    this._config.disabled = getBooleanFromEnv('OTEL_SDK_DISABLED');
 
-    const logLevel = getStringFromEnv('OTEL_LOG_LEVEL');
+    const logLevel = diagLogLevelFromString(getStringFromEnv('OTEL_LOG_LEVEL'));
     if (logLevel) {
-      this._config.log_level =
-        diagLogLevelFromString(logLevel) ?? DiagLogLevel.INFO;
+      this._config.log_level = logLevel;
     }
 
     const nodeResourceDetectors = getStringListFromEnv(

experimental/packages/opentelemetry-configuration/src/FileConfigProvider.ts

@@ -14,19 +14,27 @@
  * limitations under the License.
  */
 
-import { getStringFromEnv } from '@opentelemetry/core';
+import { diagLogLevelFromString, getStringFromEnv } from '@opentelemetry/core';
 import {
+  ConfigAttributes,
   ConfigurationModel,
   initializeDefaultConfiguration,
 } from './configModel';
 import { ConfigProvider } from './IConfigProvider';
 import * as fs from 'fs';
+import * as yaml from 'yaml';
+import {
+  getBooleanFromConfigFile,
+  getNumberFromConfigFile,
+  getStringFromConfigFile,
+} from './utils';
 
 export class FileConfigProvider implements ConfigProvider {
   private _config: ConfigurationModel;
 
   constructor() {
     this._config = initializeDefaultConfiguration();
+    parseConfigFile(this._config);
   }
 
   getInstrumentationConfig(): ConfigurationModel {
@@ -37,7 +45,10 @@ export class FileConfigProvider implements ConfigProvider {
 export function hasValidConfigFile(): boolean {
   const configFile = getStringFromEnv('OTEL_EXPERIMENTAL_CONFIG_FILE');
   if (configFile) {
-    if (!configFile.endsWith('.yaml') || !fs.existsSync(configFile)) {
+    if (
+      !(configFile.endsWith('.yaml') || configFile.endsWith('.yml')) ||
+      !fs.existsSync(configFile)
+    ) {
       throw new Error(
         `Config file ${configFile} set on OTEL_EXPERIMENTAL_CONFIG_FILE is not valid`
       );
@@ -46,3 +57,64 @@ export function hasValidConfigFile(): boolean {
   }
   return false;
 }
+
+function parseConfigFile(config: ConfigurationModel) {
+  const supportedFileVersions = ['1.0-rc.1'];
+  const configFile = getStringFromEnv('OTEL_EXPERIMENTAL_CONFIG_FILE') || '';
+  const file = fs.readFileSync(configFile, 'utf8');
+  const parsedContent = yaml.parse(file);
+
+  if (
+    parsedContent['file_format'] &&
+    supportedFileVersions.includes(parsedContent['file_format'])
+  ) {
+    const disabled = getBooleanFromConfigFile(parsedContent['disabled']);
+    if (disabled || disabled === false) {
+      config.disabled = disabled;
+    }
+
+    const logLevel = getNumberFromConfigFile(
+      diagLogLevelFromString(parsedContent['log_level'])
+    );
+    if (logLevel) {
+      config.log_level = logLevel;
+    }
+
+    const attrList = getStringFromConfigFile(
+      parsedContent['resource']?.['attributes_list']
+    );
+    if (attrList) {
+      config.resource.attributes_list = attrList;
+    }
+
+    const schemaUrl = getStringFromConfigFile(
+      parsedContent['resource']?.['schema_url']
+    );
+    if (schemaUrl) {
+      config.resource.schema_url = schemaUrl;
+    }
+
+    setResourceAttributes(config, parsedContent['resource']?.['attributes']);
+  } else {
+    throw new Error(
+      `Unsupported File Format: ${parsedContent['file_format']}. It must be one of the following: ${supportedFileVersions}`
+    );
+  }
+}
+
+function setResourceAttributes(
+  config: ConfigurationModel,
+  attributes: ConfigAttributes[]
+) {
+  if (attributes) {
+    config.resource.attributes = [];
+    for (let i = 0; i < attributes.length; i++) {
+      const att = attributes[i];
+      config.resource.attributes.push({
+        name: getStringFromConfigFile(att['name']) ?? '',
+        value: att['value'],
+        type: att['type'] ?? 'string',
+      });
+    }
+  }
+}

experimental/packages/opentelemetry-configuration/src/configModel.ts

@@ -21,7 +21,7 @@ export interface ConfigurationModel {
    * Configure if the SDK is disabled or not.
    * If omitted or null, false is used.
    */
-  disable: boolean;
+  disabled: boolean;
 
   /**
    * Configure the log level of the internal logger used by the SDK.
@@ -70,7 +70,7 @@ export interface ConfigurationModel {
 
 export function initializeDefaultConfiguration(): ConfigurationModel {
   const config: ConfigurationModel = {
-    disable: false,
+    disabled: false,
     log_level: DiagLogLevel.INFO,
     node_resource_detectors: ['all'],
     resource: {},
@@ -163,7 +163,7 @@ export function initializeDefaultConfiguration(): ConfigurationModel {
 export interface ConfigAttributes {
   name: string;
   value: string | boolean | number | string[] | boolean[] | number[];
-  type?:
+  type:
     | 'string'
     | 'bool'
     | 'int'

experimental/packages/opentelemetry-configuration/src/utils.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 { diag } from '@opentelemetry/api';
+import { inspect } from 'util';
+
+/**
+ * Retrieves a boolean value from a configuration file parameter.
+ * - Trims leading and trailing whitespace and ignores casing.
+ * - Returns `undefined` if the value is empty, unset, or contains only whitespace.
+ * - Returns `undefined` and a warning for values that cannot be mapped to a boolean.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {boolean} - The boolean value or `false` if the environment variable is unset empty, unset, or contains only whitespace.
+ */
+export function getBooleanFromConfigFile(value: unknown): boolean | undefined {
+  const raw = String(value)?.trim().toLowerCase();
+  if (raw === 'true') {
+    return true;
+  } else if (raw === 'false') {
+    return false;
+  } else if (raw == null || raw === '') {
+    return undefined;
+  } else {
+    diag.warn(`Unknown value ${inspect(raw)}, expected 'true' or 'false'`);
+    return undefined;
+  }
+}
+
+/**
+ * Retrieves a number from a configuration file parameter.
+ * - Returns `undefined` if the environment variable is empty, unset, or contains only whitespace.
+ * - Returns `undefined` and a warning if is not a number.
+ * - Returns a number in all other cases.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {number | undefined} - The number value or `undefined`.
+ */
+export function getNumberFromConfigFile(value: unknown): number | undefined {
+  const raw = String(value)?.trim();
+  if (raw == null || raw.trim() === '') {
+    return undefined;
+  }
+
+  const n = Number(raw);
+  if (isNaN(n)) {
+    diag.warn(`Unknown value ${inspect(raw)}, expected a number`);
+    return undefined;
+  }
+
+  return n;
+}
+
+/**
+ * Retrieves a string from a configuration file parameter.
+ * - Returns `undefined` if the environment variable is empty, unset, or contains only whitespace.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {string | undefined} - The string value or `undefined`.
+ */
+export function getStringFromConfigFile(value: unknown): string | undefined {
+  const raw = String(value)?.trim();
+  if (value == null || raw === '') {
+    return undefined;
+  }
+  return raw;
+}