feat(trace): use dynamic composite ratio sampler

packages/opentelemetry-node/lib/central-config.js

@@ -420,6 +420,45 @@ const REMOTE_CONFIG_HANDLERS = [
             return null;
         },
     },
+
+    {
+        keys: ['sampling_rate'],
+        setter: (config, sdkInfo) => {
+            if (!sdkInfo.sampler) {
+                return `ignoring "sampling_rate" because non-default sampler in use`;
+            }
+
+            const rawRate = config['sampling_rate'];
+            let valRate;
+            let verb = 'set';
+            switch (typeof rawRate) {
+                case 'undefined':
+                    valRate = initialConfig.sampling_rate;
+                    verb = 'reset';
+                    break;
+                case 'number':
+                    valRate = rawRate;
+                    break;
+                case 'string':
+                    valRate = Number(rawRate);
+                    if (isNaN(valRate)) {
+                        return `unknown 'sampling_rate' value: "${rawRate}"`;
+                    }
+                    break;
+                default:
+                    return `unknown 'sampling_rate' value type: ${typeof rawRate} (${rawRate})`;
+            }
+
+            if (valRate < 0 || valRate > 1) {
+                return `'sampling_rate' value must be between 0 and 1: ${valRate}`;
+            }
+
+            sdkInfo.sampler.setRatio(valRate);
+            log.info(`central-config: ${verb} "sampling_rate" to "${valRate}"`);
+
+            return null;
+        },
+    },
 ];
 
 /**
@@ -500,7 +539,7 @@ function onRemoteConfig(sdkInfo, opampClient, remoteConfig) {
 
         // Report config status.
         if (applyErrs.length > 0) {
-            log.error(
+            log.warn(
                 {config, applyErrs},
                 'could not apply all remote config settings'
             );
@@ -598,6 +637,7 @@ function setupCentralConfig(sdkInfo) {
         CC_LOGGING_LEVEL_FROM_LUGGITE_LEVEL[
             luggite.nameFromLevel[log.level()] ?? DEFAULT_LOG_LEVEL
         ];
+    initialConfig.sampling_rate = sdkInfo.samplingRate;
     initialConfig.send_traces = !sdkInfo.contextPropagationOnly;
     log.debug({initialConfig}, 'initial central config values');
 

packages/opentelemetry-node/lib/sampler.js

@@ -0,0 +1,89 @@
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const {
+    createCompositeSampler,
+    createComposableParentThresholdSampler,
+    createComposableTraceIDRatioBasedSampler,
+} = require('@opentelemetry/sampler-composite');
+
+/**
+ * @typedef {import('@opentelemetry/api').Attributes} Attributes
+ * @typedef {import('@opentelemetry/api').Context} Context
+ * @typedef {import('@opentelemetry/api').Link} Link
+ * @typedef {import('@opentelemetry/api').SpanKind} SpanKind
+ * @typedef {import('@opentelemetry/sdk-trace-base').Sampler} Sampler
+ * @typedef {import('@opentelemetry/sdk-trace-base').SamplingResult} SamplingResult
+ */
+
+/**
+ * EDOT default sampler, a parent-based ratio sampler which can have its ratio updated dynamically.
+ *
+ * @implements {Sampler}
+ */
+class DefaultSampler {
+    #delegate;
+
+    constructor(ratio = 1.0) {
+        this.#delegate = newSampler(ratio);
+    }
+
+    /**
+     * @param {Context} context
+     * @param {string} traceId
+     * @param {string} spanName
+     * @param {SpanKind} spanKind
+     * @param {Attributes} attributes
+     * @param {Link[]} links
+     * @returns {SamplingResult}
+     */
+    shouldSample(context, traceId, spanName, spanKind, attributes, links) {
+        return this.#delegate.shouldSample(
+            context,
+            traceId,
+            spanName,
+            spanKind,
+            attributes,
+            links
+        );
+    }
+
+    /**
+     * @param {number} ratio
+     */
+    setRatio(ratio) {
+        this.#delegate = newSampler(ratio);
+    }
+
+    toString() {
+        return this.#delegate.toString();
+    }
+}
+
+/**
+ * @param {number} ratio A number between 0 and 1 representing the sampling ratio.
+ */
+function newSampler(ratio) {
+    return createCompositeSampler(
+        createComposableParentThresholdSampler(
+            createComposableTraceIDRatioBasedSampler(ratio)
+        )
+    );
+}
+
+/**
+ * Creates a default EDOT sampler, which is a parent-based ratio sampler that can have
+ * its ratio updated dynamically by central config.
+ *
+ * @param {number} ratio
+ * @returns {Sampler} A ratio sampler which can have its ratio updated dynamically.
+ */
+function createDefaultSampler(ratio) {
+    return new DefaultSampler(ratio);
+}
+
+module.exports = {
+    createDefaultSampler,
+};

packages/opentelemetry-node/lib/sdk.js

@@ -9,6 +9,7 @@
 
 const {
     getBooleanFromEnv,
+    getNumberFromEnv,
     getStringFromEnv,
     getStringListFromEnv,
 } = require('@opentelemetry/core');
@@ -45,10 +46,12 @@
     setupDynConfExporters,
     dynConfSpanExporters,
 } = require('./dynconf');
+const {createDefaultSampler} = require('./sampler');
 const DISTRO_VERSION = require('../package.json').version;
 
 /**
  * @typedef {import('@opentelemetry/sdk-node').NodeSDKConfiguration} NodeSDKConfiguration
+ * @typedef {import('@opentelemetry/sdk-trace-base').Sampler} Sampler
  */
 
 /**
@@ -66,7 +69,7 @@
         try {
             await shutdownFn();
         } catch (err) {
             console.warn('warning: error shutting down OTel SDK', err);
         }
         process.exit(128 + os.constants.signals.SIGTERM);
     });
@@ -76,7 +79,7 @@
         try {
             await shutdownFn();
         } catch (err) {
             console.warn('warning: error shutting down OTel SDK', err);
         }
     });
 }
@@ -241,6 +244,26 @@
 
     const config = {...defaultConfig, ...cfg};
 
+    /** @type {Sampler} */
+    let sampler = undefined;
+    let samplingRate = 1.0;
+    if (!config.sampler && !getStringFromEnv('OTEL_TRACES_SAMPLER')) {
+        // If the user has not set a sampler via config or env var, use our default sampler.
+        // First get as string to differentiate between missing and invalid.
+        if (getStringFromEnv('OTEL_TRACES_SAMPLER_ARG')) {
+            const samplingRateArg = getNumberFromEnv('OTEL_TRACES_SAMPLER_ARG');
+            if (samplingRateArg === undefined) {
+                log.warn(
+                    `Invalid OTEL_TRACES_SAMPLER_ARG value: ${process.env.OTEL_TRACES_SAMPLER_ARG}. Using default sampling rate of ${samplingRate}`
+                );
+            } else {
+                samplingRate = samplingRateArg;
+            }
+        }
+        sampler = createDefaultSampler(samplingRate);
+        config.sampler = sampler;
+    }
+
     // Some tricks to get a handle on noop signal providers, to be used for
     // dynamic configuration.
     const tracerProviderProxy = new api.ProxyTracerProvider();
@@ -306,6 +329,8 @@
         noopTracerProvider,
         // @ts-ignore: Ignore access of private _tracerProvider for now. (TODO)
         sdkTracerProvider: sdk._tracerProvider,
+        sampler,
+        samplingRate,
         contextPropagationOnly,
     });
 

packages/opentelemetry-node/package.json

@@ -126,6 +126,7 @@
     "@opentelemetry/resource-detector-azure": "^0.14.0",
     "@opentelemetry/resource-detector-container": "^0.7.0",
     "@opentelemetry/resources": "^2.0.0",
+    "@opentelemetry/sampler-composite": "^0.206.0",
     "@opentelemetry/sdk-logs": "^0.206.0",
     "@opentelemetry/sdk-metrics": "^2.0.0",
     "@opentelemetry/sdk-node": "^0.206.0",

packages/opentelemetry-node/test/OTEL_TRACES_SAMPLER.js

@@ -0,0 +1,53 @@
+/*
+ * Copyright Elasticsearch B.V. and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const {test} = require('tape');
+const {runTestFixtures} = require('./testutils');
+
+/** @type {import('./testutils').TestFixture[]} */
+const testFixtures = [
+    {
+        name: 'OTEL_TRACES_SAMPLER unset (default sampling of 100%)',
+        args: ['./fixtures/use-http-get.js'],
+        cwd: __dirname,
+        env: {
+            NODE_OPTIONS: '--import=@elastic/opentelemetry-node',
+        },
+        checkTelemetry: (t, col) => {
+            t.equal(col.sortedSpans.length, 1);
+        },
+    },
+    {
+        name: 'OTEL_TRACES_SAMPLER unset, OTEL_TRACES_SAMPLER_ARG=0 (no sampling)',
+        args: ['./fixtures/use-http-get.js'],
+        cwd: __dirname,
+        env: {
+            NODE_OPTIONS: '--import=@elastic/opentelemetry-node',
+            OTEL_TRACES_SAMPLER_ARG: '0',
+        },
+        checkTelemetry: (t, col) => {
+            t.equal(col.sortedSpans.length, 0);
+        },
+    },
+    {
+        name: 'OTEL_TRACES_SAMPLER=always_off, (no sampling)',
+        args: ['./fixtures/use-http-get.js'],
+        cwd: __dirname,
+        env: {
+            NODE_OPTIONS: '--import=@elastic/opentelemetry-node',
+            OTEL_TRACES_SAMPLER: 'always_off',
+        },
+        checkTelemetry: (t, col) => {
+            t.equal(col.sortedSpans.length, 0);
+        },
+    },
+];
+
+// ----- main line -----
+
+test('OTEL_TRACES_SAMPLER', (suite) => {
+    runTestFixtures(suite, testFixtures);
+    suite.end();
+});