Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 26 additions & 50 deletions packages/core/src/config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const configValidators = require('./configValidators');
const deepMerge = require('../util/deepMerge');
const { DEFAULT_STACK_TRACE_LENGTH, DEFAULT_STACK_TRACE_MODE } = require('../util/constants');
const { validateStackTraceMode, validateStackTraceLength } = require('./configValidators/stackTraceValidation');
const util = require('./util');

/**
* @typedef {Object} InstanaTracingOption
Expand Down Expand Up @@ -141,6 +142,7 @@ module.exports.configValidators = configValidators;
module.exports.init = _logger => {
logger = _logger;
configNormalizers.init({ logger });
util.init(logger);
};

/**
Expand Down Expand Up @@ -216,12 +218,12 @@ function normalizeMetricsConfig(config) {
config.metrics = {};
}

config.metrics.transmissionDelay = normalizeSingleValue(
config.metrics.transmissionDelay,
defaults.metrics.transmissionDelay,
'config.metrics.transmissionDelay',
'INSTANA_METRICS_TRANSMISSION_DELAY'
);
config.metrics.transmissionDelay = util.resolveNumericConfig({
envVar: 'INSTANA_METRICS_TRANSMISSION_DELAY',
configValue: config.metrics.transmissionDelay,
defaultValue: defaults.metrics.transmissionDelay,
configPath: 'config.metrics.transmissionDelay'
});

config.metrics.timeBetweenHealthcheckCalls =
config.metrics.timeBetweenHealthcheckCalls || defaults.metrics.timeBetweenHealthcheckCalls;
Expand Down Expand Up @@ -372,12 +374,12 @@ function normalizeActivateImmediately(config) {
function normalizeTracingTransmission(config) {
config.tracing.maxBufferedSpans = config.tracing.maxBufferedSpans || defaults.tracing.maxBufferedSpans;

config.tracing.transmissionDelay = normalizeSingleValue(
config.tracing.transmissionDelay,
defaults.tracing.transmissionDelay,
'config.tracing.transmissionDelay',
'INSTANA_TRACING_TRANSMISSION_DELAY'
);
config.tracing.transmissionDelay = util.resolveNumericConfig({
envVar: 'INSTANA_TRACING_TRANSMISSION_DELAY',
configValue: config.tracing.transmissionDelay,
defaultValue: defaults.tracing.transmissionDelay,
configPath: 'config.tracing.transmissionDelay'
});

// DEPRECATED! This was never documented, but we shared it with a customer.
if (process.env['INSTANA_DEV_MIN_DELAY_BEFORE_SENDING_SPANS']) {
Expand All @@ -397,19 +399,19 @@ function normalizeTracingTransmission(config) {
}
}

config.tracing.forceTransmissionStartingAt = normalizeSingleValue(
config.tracing.forceTransmissionStartingAt,
defaults.tracing.forceTransmissionStartingAt,
'config.tracing.forceTransmissionStartingAt',
'INSTANA_FORCE_TRANSMISSION_STARTING_AT'
);
config.tracing.forceTransmissionStartingAt = util.resolveNumericConfig({
envVar: 'INSTANA_FORCE_TRANSMISSION_STARTING_AT',
configValue: config.tracing.forceTransmissionStartingAt,
defaultValue: defaults.tracing.forceTransmissionStartingAt,
configPath: 'config.tracing.forceTransmissionStartingAt'
});

config.tracing.initialTransmissionDelay = normalizeSingleValue(
config.tracing.initialTransmissionDelay,
defaults.tracing.initialTransmissionDelay,
'config.tracing.initialTransmissionDelay',
'INSTANA_TRACING_INITIAL_TRANSMISSION_DELAY'
);
config.tracing.initialTransmissionDelay = util.resolveNumericConfig({
envVar: 'INSTANA_TRACING_INITIAL_TRANSMISSION_DELAY',
configValue: config.tracing.initialTransmissionDelay,
defaultValue: defaults.tracing.initialTransmissionDelay,
configPath: 'config.tracing.initialTransmissionDelay'
});
}

/**
Expand Down Expand Up @@ -713,32 +715,6 @@ function parseSecretsEnvVar(envVarValue) {
};
}

/**
* @param {*} configValue
* @param {*} defaultValue
* @param {string} configPath
* @param {string} envVarKey
* @returns {*}
*/
function normalizeSingleValue(configValue, defaultValue, configPath, envVarKey) {
const envVarVal = process.env[envVarKey];
let originalValue = configValue;
if (configValue == null && envVarVal == null) {
return defaultValue;
} else if (configValue == null && envVarVal != null) {
originalValue = envVarVal;
configValue = parseInt(originalValue, 10);
}

if (typeof configValue !== 'number' || isNaN(configValue)) {
logger.warn(
`The value of ${configPath} (or ${envVarKey}) ("${originalValue}") is ' +
'not numerical or cannot be parsed to a numerical value. Assuming the default value ${defaultValue}.`
);
return defaultValue;
}
return configValue;
}
/**
* @param {InstanaConfig} config
*/
Expand Down
55 changes: 55 additions & 0 deletions packages/core/src/config/util.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
* (c) Copyright IBM Corp. 2026
*/

'use strict';

/** @type {import('../core').GenericLogger} */
let logger;

/**
* @param {import('../core').GenericLogger} [_logger]
*/
exports.init = _logger => {
logger = _logger;
};

/**
* @param {Object} params
* @param {string} params.envVar
* @param {number|string|undefined|null} params.configValue
* @param {number} params.defaultValue
* @param {string} params.configPath
* @returns {number}
*/
exports.resolveNumericConfig = function resolveNumericConfig({ envVar, configValue, defaultValue, configPath }) {
const envRaw = process.env[envVar];

/** @param {number|string|null|undefined} val */
const toValidNumber = val => {
const num = typeof val === 'number' ? val : Number(val);
return Number.isNaN(num) ? undefined : num;
};

if (envRaw != null) {
const envParsed = toValidNumber(envRaw);
if (envParsed !== undefined) {
return envParsed;
}

logger.warn(`Invalid numeric value from env:${envVar}: "${envRaw}". Ignoring and checking config value.`);
}

if (configValue != null) {
const configParsed = toValidNumber(configValue);
if (configParsed !== undefined) {
return configParsed;
}

logger.warn(
`Invalid numeric value for ${configPath} from config: "${configValue}". Falling back to default: ${defaultValue}.`
);
}

return defaultValue;
};
Loading