feat(opentelemetry-configuration): parse of array objects on configuration file (#5947)

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

Author: 3 people

experimental/CHANGELOG.md

@@ -14,6 +14,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 * 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
+* feat(opentelemetry-configuration): parse of array objects on configuration file [#5947](https://github.com/open-telemetry/opentelemetry-js/pull/5947) @maryliag
 
 ### :bug: Bug Fixes
 

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

@@ -25,8 +25,11 @@ import * as fs from 'fs';
 import * as yaml from 'yaml';
 import {
   getBooleanFromConfigFile,
+  getBooleanListFromConfigFile,
   getNumberFromConfigFile,
+  getNumberListFromConfigFile,
   getStringFromConfigFile,
+  getStringListFromConfigFile,
 } from './utils';
 
 export class FileConfigProvider implements ConfigProvider {
@@ -110,9 +113,33 @@ function setResourceAttributes(
     config.resource.attributes = [];
     for (let i = 0; i < attributes.length; i++) {
       const att = attributes[i];
+      let value = att['value'];
+      switch (att['type']) {
+        case 'bool':
+          value = getBooleanFromConfigFile(value);
+          break;
+        case 'bool_array':
+          value = getBooleanListFromConfigFile(value);
+          break;
+        case 'int':
+        case 'double':
+          value = getNumberFromConfigFile(value);
+          break;
+        case 'int_array':
+        case 'double_array':
+          value = getNumberListFromConfigFile(value);
+          break;
+        case 'string_array':
+          value = getStringListFromConfigFile(value);
+          break;
+        default:
+          value = getStringFromConfigFile(value);
+          break;
+      }
+
       config.resource.attributes.push({
         name: getStringFromConfigFile(att['name']) ?? '',
-        value: att['value'],
+        value: value,
         type: att['type'] ?? 'string',
       });
     }

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

@@ -162,7 +162,14 @@ export function initializeDefaultConfiguration(): ConfigurationModel {
 
 export interface ConfigAttributes {
   name: string;
-  value: string | boolean | number | string[] | boolean[] | number[];
+  value:
+    | string
+    | boolean
+    | number
+    | string[]
+    | boolean[]
+    | number[]
+    | undefined;
   type:
     | 'string'
     | 'bool'

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

@@ -39,6 +39,34 @@ export function getBooleanFromConfigFile(value: unknown): boolean | undefined {
   }
 }
 
+/**
+ * Retrieves a list of booleans from a configuration file parameter.
+ * - Uses ',' as the delimiter.
+ * - Trims leading and trailing whitespace from each entry.
+ * - Excludes empty entries.
+ * - Returns `undefined` if the variable is empty or contains only whitespace.
+ * - Returns an empty array if all entries are empty or whitespace.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {boolean[] | undefined} - The list of strings or `undefined`.
+ */
+export function getBooleanListFromConfigFile(
+  value: unknown
+): boolean[] | undefined {
+  const list = getStringFromConfigFile(value)?.split(',');
+  if (list) {
+    const filteredList = [];
+    for (let i = 0; i < list.length; i++) {
+      const element = getBooleanFromConfigFile(list[i]);
+      if (element != null) {
+        filteredList.push(element);
+      }
+    }
+    return filteredList;
+  }
+  return list;
+}
+
 /**
  * Retrieves a number from a configuration file parameter.
  * - Returns `undefined` if the environment variable is empty, unset, or contains only whitespace.
@@ -63,9 +91,37 @@ export function getNumberFromConfigFile(value: unknown): number | undefined {
   return n;
 }
 
+/**
+ * Retrieves a list of numbers from a configuration file parameter.
+ * - Uses ',' as the delimiter.
+ * - Trims leading and trailing whitespace from each entry.
+ * - Excludes empty entries.
+ * - Returns `undefined` if the variable is empty or contains only whitespace.
+ * - Returns an empty array if all entries are empty or whitespace.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {number[] | undefined} - The list of numbers or `undefined`.
+ */
+export function getNumberListFromConfigFile(
+  value: unknown
+): number[] | undefined {
+  const list = getStringFromConfigFile(value)?.split(',');
+  if (list) {
+    const filteredList = [];
+    for (let i = 0; i < list.length; i++) {
+      const element = getNumberFromConfigFile(list[i]);
+      if (element) {
+        filteredList.push(element);
+      }
+    }
+    return filteredList;
+  }
+  return list;
+}
+
 /**
  * Retrieves a string from a configuration file parameter.
- * - Returns `undefined` if the environment variable is empty, unset, or contains only whitespace.
+ * - Returns `undefined` if the 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`.
@@ -77,3 +133,23 @@ export function getStringFromConfigFile(value: unknown): string | undefined {
   }
   return raw;
 }
+
+/**
+ * Retrieves a list of strings from a configuration file parameter.
+ * - Uses ',' as the delimiter.
+ * - Trims leading and trailing whitespace from each entry.
+ * - Excludes empty entries.
+ * - Returns `undefined` if the variable is empty or contains only whitespace.
+ * - Returns an empty array if all entries are empty or whitespace.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {string[] | undefined} - The list of strings or `undefined`.
+ */
+export function getStringListFromConfigFile(
+  value: unknown
+): string[] | undefined {
+  return getStringFromConfigFile(value)
+    ?.split(',')
+    .map(v => v.trim())
+    .filter(s => s !== '');
+}

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

@@ -19,8 +19,11 @@ import * as sinon from 'sinon';
 import { diag } from '@opentelemetry/api';
 import {
   getBooleanFromConfigFile,
+  getBooleanListFromConfigFile,
   getNumberFromConfigFile,
+  getNumberListFromConfigFile,
   getStringFromConfigFile,
+  getStringListFromConfigFile,
 } from '../src/utils';
 
 describe('config utils', function () {
@@ -44,6 +47,34 @@ describe('config utils', function () {
     );
   });
 
+  it('should return correct values for getBooleanListFromConfigFile', function () {
+    assert.deepStrictEqual(getBooleanListFromConfigFile(null), undefined);
+    assert.deepStrictEqual(getBooleanListFromConfigFile('  '), undefined);
+    assert.deepStrictEqual(getBooleanListFromConfigFile(' , '), []);
+    assert.deepStrictEqual(getBooleanListFromConfigFile(true), [true]);
+    assert.deepStrictEqual(getBooleanListFromConfigFile('true'), [true]);
+    assert.deepStrictEqual(getBooleanListFromConfigFile(false), [false]);
+    assert.deepStrictEqual(getBooleanListFromConfigFile('false'), [false]);
+    assert.deepStrictEqual(
+      getBooleanListFromConfigFile('true,false,false,true'),
+      [true, false, false, true]
+    );
+    assert.deepStrictEqual(
+      getBooleanListFromConfigFile('true,false,,,true,false'),
+      [true, false, true, false]
+    );
+
+    const warnStub = sinon.stub(diag, 'warn');
+    assert.deepStrictEqual(getBooleanListFromConfigFile('non-boolean'), []);
+    sinon.assert.calledOnceWithMatch(
+      warnStub,
+      `Unknown value 'non-boolean', expected 'true' or 'false'`
+    );
+    assert.deepStrictEqual(getBooleanListFromConfigFile('non-boolean,false'), [
+      false,
+    ]);
+  });
+
   it('should return correct values for getNumberFromConfigFile', function () {
     assert.strictEqual(getNumberFromConfigFile(null), undefined);
     assert.strictEqual(getNumberFromConfigFile(' '), undefined);
@@ -59,11 +90,57 @@ describe('config utils', function () {
     );
   });
 
+  it('should return correct values for getNumberListFromConfigFile', function () {
+    assert.deepStrictEqual(getNumberListFromConfigFile(null), undefined);
+    assert.deepStrictEqual(getNumberListFromConfigFile('  '), undefined);
+    assert.deepStrictEqual(getNumberListFromConfigFile(' , '), []);
+    assert.deepStrictEqual(getNumberListFromConfigFile(5), [5]);
+    assert.deepStrictEqual(getNumberListFromConfigFile('7'), [7]);
+    assert.deepStrictEqual(
+      getNumberListFromConfigFile('1,2,3,4'),
+      [1, 2, 3, 4]
+    );
+    assert.deepStrictEqual(
+      getNumberListFromConfigFile('5,6,,,7,8'),
+      [5, 6, 7, 8]
+    );
+
+    const warnStub = sinon.stub(diag, 'warn');
+    assert.deepStrictEqual(getNumberListFromConfigFile('non-number'), []);
+    sinon.assert.calledOnceWithMatch(
+      warnStub,
+      `Unknown value 'non-number', expected a number`
+    );
+    assert.deepStrictEqual(getNumberListFromConfigFile('non-number,10'), [10]);
+  });
+
   it('should return correct values for getStringFromConfigFile', function () {
     assert.strictEqual(getStringFromConfigFile(null), undefined);
     assert.strictEqual(getStringFromConfigFile(' '), undefined);
     assert.strictEqual(getStringFromConfigFile(undefined), undefined);
     assert.strictEqual(getStringFromConfigFile(1), '1');
     assert.strictEqual(getStringFromConfigFile('string-value'), 'string-value');
   });
+
+  it('should return correct values for getStringListFromConfigFile', function () {
+    assert.deepStrictEqual(getStringListFromConfigFile(null), undefined);
+    assert.deepStrictEqual(getStringListFromConfigFile('  '), undefined);
+    assert.deepStrictEqual(getStringListFromConfigFile(' , '), []);
+    assert.deepStrictEqual(getStringListFromConfigFile(1), ['1']);
+    assert.deepStrictEqual(getStringListFromConfigFile('string-value'), [
+      'string-value',
+    ]);
+    assert.deepStrictEqual(getStringListFromConfigFile('v1,v2,v3,v4'), [
+      'v1',
+      'v2',
+      'v3',
+      'v4',
+    ]);
+    assert.deepStrictEqual(getStringListFromConfigFile('v5,v6,,,v7,v8'), [
+      'v5',
+      'v6',
+      'v7',
+      'v8',
+    ]);
+  });
 });