Skip to content

refactor: added instanaCtr dependency injection #1987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

refactor: added instanaCtr dependency injection #1987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 35 additions & 24 deletions packages/aws-fargate/src/activate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,30 @@
'use strict';

const instanaCore = require('@instana/core');
const { backendConnector, consoleLogger: log } = require('@instana/serverless');
const { backendConnector, consoleLogger: serverlessLogger } = require('@instana/serverless');

const identityProvider = require('./identity_provider');
const metrics = require('./metrics');
const { fullyQualifiedContainerId } = require('./metrics/container/containerUtil');
const { tracing, coreConfig, coreUtils } = instanaCore;

const { tracing, util: coreUtil } = instanaCore;
const { normalizeConfig } = coreUtil;
const instanaCtr = new instanaCore.InstanaCtr();

const logger = log.init();
const config = normalizeConfig({}, logger);
coreUtils.init(instanaCtr);
coreConfig.init(instanaCtr);
serverlessLogger.init(instanaCtr);

instanaCtr.set('utils', coreUtils.create());
instanaCtr.set('config', coreConfig.create());
instanaCtr.set('logger', serverlessLogger.create());

function init() {
instanaCore.preInit(config);
instanaCore.preInit(instanaCtr.config(), instanaCtr.utils());

metrics.init(config, function onReady(err, ecsContainerPayload) {
metrics.init(instanaCtr.config(), function onReady(err, ecsContainerPayload) {
if (err) {
logger.error(
`Initializing @instana/aws-fargate failed. This fargate task will not be monitored.
instanaCtr.logger().error(
`Initializing @instana/aws-fargate failed. This fargate task will not be monitored.
${err?.message} ${err?.stack}`
);
metrics.deactivate();
Expand All @@ -34,45 +39,51 @@ function init() {
try {
const taskArn = ecsContainerPayload && ecsContainerPayload.data ? ecsContainerPayload.data.taskArn : null;
if (!taskArn) {
logger.error(
'Initializing @instana/aws-fargate failed, the metadata did not have a task ARN. This fargate task will ' +
'not be monitored.'
);
instanaCtr
.logger()
.error(
'Initializing @instana/aws-fargate failed, the metadata did not have a task ARN. This fargate task will ' +
'not be monitored.'
);
metrics.deactivate();
return;
}
const containerId = ecsContainerPayload.data.containerName
? fullyQualifiedContainerId(taskArn, ecsContainerPayload.data.containerName)
: null;
if (!containerId) {
logger.error(
'Initializing @instana/aws-fargate failed, the metadata did not have a container name. This fargate task ' +
'will not be monitored.'
);
instanaCtr
.logger()
.error(
'Initializing @instana/aws-fargate failed, the metadata did not have a container name. This fargate task ' +
'will not be monitored.'
);
metrics.deactivate();
return;
}

identityProvider.init(taskArn, containerId);

backendConnector.init({
config,
config: instanaCtr.config(),
identityProvider,
defaultTimeout: 950
});

instanaCore.init(config, backendConnector, identityProvider);
instanaCore.init(instanaCtr.config(), instanaCtr.utils(), backendConnector, identityProvider);
metrics.activate(backendConnector);
tracing.activate();

logger.debug('@instana/aws-fargate initialized.');
instanaCtr.logger().debug('@instana/aws-fargate initialized.');

// eslint-disable-next-line no-unused-expressions
process.send && process.send('instana.aws-fargate.initialized');
} catch (e) {
logger.error(
`Initializing @instana/aws-fargate failed. This fargate task will not be monitored. ${e?.message} ${e?.stack}`
);
instanaCtr
.logger()
.error(
`Initializing @instana/aws-fargate failed. This fargate task will not be monitored. ${e?.message} ${e?.stack}`
);
}
});
}
Expand All @@ -88,7 +99,7 @@ exports.sdk = tracing.sdk;

// NOTE: this is the external interface for the customer. They can set a custom logger.
exports.setLogger = function setLogger(_logger) {
log.init({ logger: _logger });
instanaCtr.logger().setLogger(_logger);
};

exports.opentracing = tracing.opentracing;
2 changes: 1 addition & 1 deletion packages/aws-fargate/test/Control.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const config = require('@instana/core/test/config');
const AbstractServerlessControl = require('../../serverless/test/util/AbstractServerlessControl');
const portfinder = require('../../collector/test/test_util/portfinder');
const PATH_TO_INSTANA_FARGATE_PACKAGE = path.join(__dirname, '..');
const isLatestEsmSupportedVersion = require('@instana/core').util.esm.isLatestEsmSupportedVersion;
const isLatestEsmSupportedVersion = require('@instana/core').coreUtils.esm.isLatestEsmSupportedVersion;
let execArg;

function Control(opts) {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-fargate/test/metrics/transmissionCycle_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ describe('transmission cycle', function () {
let onReadyError;

before(() => {
const config = core.util.normalizeConfig({});
const config = core.config.normalize();
core.secrets.init(config);

const metadataMockPort = portfinder();
Expand Down
114 changes: 69 additions & 45 deletions packages/aws-lambda/src/wrapper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
'use strict';

const instanaCore = require('@instana/core');
const { backendConnector, consoleLogger: log, environment } = require('@instana/serverless');
const { backendConnector, consoleLogger: serverlessLogger, environment } = require('@instana/serverless');
const arnParser = require('./arn');
const identityProvider = require('./identity_provider');
const metrics = require('./metrics');
Expand All @@ -15,21 +15,29 @@ const triggers = require('./triggers');
const processResult = require('./process_result');
const captureHeaders = require('./capture_headers');

const { tracing, util: coreUtil } = instanaCore;
const { normalizeConfig } = coreUtil;
const { tracing, coreConfig, coreUtils } = instanaCore;
const { tracingHeaders, constants, spanBuffer } = tracing;

const lambdaConfigDefaults = {
tracing: { forceTransmissionStartingAt: 25, transmissionDelay: 100, initialTransmissionDelay: 100 }
};

const logger = log.init();
let config = normalizeConfig({}, logger, lambdaConfigDefaults);
let coldStart = true;

const instanaCtr = new instanaCore.InstanaCtr();

coreUtils.init(instanaCtr);
coreConfig.init(instanaCtr);
serverlessLogger.init(instanaCtr);

instanaCtr.set('utils', coreUtils.create());
instanaCtr.set('config', coreConfig.create({}, lambdaConfigDefaults));
instanaCtr.set('logger', serverlessLogger.create());

// Initialize instrumentations early to allow for require statements after our
// package has been required but before the actual instana.wrap(...) call.
instanaCore.preInit(config);
// TODO: refactor to use `instanaCtr` only!
instanaCore.preInit(instanaCtr.config(), instanaCtr.utils());

/**
* Wraps an AWS Lambda handler so that metrics and traces are reported to Instana. This function will figure out if the
Expand Down Expand Up @@ -191,7 +199,7 @@ function shimmedHandler(originalHandler, originalThis, originalArgs, _config) {
process.env.INSTANA_ENABLE_LAMBDA_TIMEOUT_DETECTION &&
process.env.INSTANA_ENABLE_LAMBDA_TIMEOUT_DETECTION === 'true'
) {
logger.debug('Heuristical timeout detection enabled. Please only use for debugging purposes.');
instanaCtr.logger().debug('Heuristical timeout detection enabled. Please only use for debugging purposes.');
registerTimeoutDetection(context, entrySpan);
}

Expand Down Expand Up @@ -245,34 +253,41 @@ function init(event, arnInfo, _config) {

// CASE: customer provides a custom logger or custom level
if (customConfig.logger || customConfig.level) {
log.init(customConfig);
instanaCtr.setLogger(serverlessLogger.create(customConfig));
}

// NOTE: We SHOULD renormalize because of:
// NOTE: We SHOULD re-create the config object, because:
// - in-code _config object
// - late env variables (less likely)
// - custom logger
// - we always renormalize unconditionally to ensure safety.
config = normalizeConfig(customConfig, logger, lambdaConfigDefaults);
// This is a consequence of pre-initializing early.
instanaCtr.set('config', coreConfig.create(customConfig, lambdaConfigDefaults));

if (!config.tracing.enabled) {
if (!instanaCtr.config().tracing.enabled) {
return false;
}

const useLambdaExtension = shouldUseLambdaExtension();
if (useLambdaExtension) {
logger.info('@instana/aws-lambda will use the Instana Lambda extension to send data to the Instana back end.');
instanaCtr
.logger()
.info('@instana/aws-lambda will use the Instana Lambda extension to send data to the Instana back end.');
} else {
logger.info(
'@instana/aws-lambda will not use the Instana Lambda extension, but instead send data to the Instana back end ' +
'directly.'
);
instanaCtr
.logger()
.info(
'@instana/aws-lambda will not use the Instana Lambda extension, ' +
'but instead send data to the Instana back end ' +
'directly.'
);
}

identityProvider.init(arnInfo);
triggers.init(config);
triggers.init(instanaCtr.config());

backendConnector.init({
config,
config: instanaCtr.config(),
identityProvider,
defaultTimeout: 500,
useLambdaExtension,
Expand All @@ -282,16 +297,16 @@ function init(event, arnInfo, _config) {
retries: !!useLambdaExtension
});

instanaCore.init(config, backendConnector, identityProvider);
instanaCore.init(instanaCtr.config(), instanaCtr.utils(), backendConnector, identityProvider);

// After core init, because ssm requires require('@aws-sdk/client-ssm'), which triggers
// the requireHook + shimmer. Any module which requires another external module has to be
// initialized after the core.
ssm.init(config);
ssm.init(instanaCtr.config());

spanBuffer.setIsFaaS(true);
captureHeaders.init(config);
metrics.init(config);
captureHeaders.init(instanaCtr.config());
metrics.init(instanaCtr.config());
metrics.activate();
tracing.activate();

Expand All @@ -311,10 +326,12 @@ function registerTimeoutDetection(context, entrySpan) {
: 2000;

if (initialRemainingMillis <= minimumTimeoutInMs) {
logger.debug(
'Heuristical timeout detection will be disabled for Lambda functions with a short timeout ' +
'(2 seconds and smaller).'
);
instanaCtr
.logger()
.debug(
'Heuristical timeout detection will be disabled for Lambda functions with a short timeout ' +
'(2 seconds and smaller).'
);
return;
}

Expand All @@ -329,9 +346,9 @@ function registerTimeoutDetection(context, entrySpan) {
triggerTimeoutHandlingAfter = initialRemainingMillis - 400;
}

logger.debug(
`Registering heuristical timeout detection to be triggered in ${triggerTimeoutHandlingAfter} milliseconds.`
);
instanaCtr
.logger()
.debug(`Registering heuristical timeout detection to be triggered in ${triggerTimeoutHandlingAfter} milliseconds.`);

setTimeout(() => {
postHandlerForTimeout(entrySpan, getRemainingTimeInMillis(context));
Expand All @@ -342,7 +359,9 @@ function getRemainingTimeInMillis(context) {
if (context && typeof context.getRemainingTimeInMillis === 'function') {
return context.getRemainingTimeInMillis();
} else {
logger.warn('context.getRemainingTimeInMillis() is not available, timeout detection will be disabled.');
instanaCtr
.logger()
.warn('context.getRemainingTimeInMillis() is not available, timeout detection will be disabled.');
return null;
}
}
Expand All @@ -352,36 +371,41 @@ function getRemainingTimeInMillis(context) {
// used or not e.g. by checking the lambda handler name if that is possible.
function shouldUseLambdaExtension() {
if (process.env.INSTANA_DISABLE_LAMBDA_EXTENSION) {
logger.info('INSTANA_DISABLE_LAMBDA_EXTENSION is set, not using the Lambda extension.');
instanaCtr.logger().info('INSTANA_DISABLE_LAMBDA_EXTENSION is set, not using the Lambda extension.');
return false;
} else {
// Note: We could also use context.memoryLimitInMB here instead of the env var AWS_LAMBDA_FUNCTION_MEMORY_SIZE (both
// should always yield the same value), but this behaviour needs to be in sync with what the Lambda extension does.
// The context object is not available to the extension, so we prefer the env var over the value from the context.
const memorySetting = process.env.AWS_LAMBDA_FUNCTION_MEMORY_SIZE;
if (!memorySetting) {
logger.debug(
'The environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE is not present, cannot determine memory settings.'
);
instanaCtr
.logger()
.debug(
'The environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE is not present, cannot determine memory settings.'
);
return true;
}
const memorySize = parseInt(memorySetting, 10);
if (isNaN(memorySize)) {
logger.debug(
`Could not parse the value of the environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE: "${memorySetting}", ` +
'cannot determine memory settings, not using the Lambda extension.'
);
instanaCtr
.logger()
.debug(
'Could not parse the value of the environment variable ' +
`AWS_LAMBDA_FUNCTION_MEMORY_SIZE: "${memorySetting}", ` +
'cannot determine memory settings, not using the Lambda extension.'
);
return false;
}
if (memorySize < 256) {
let logFn = logger.debug;
let logFn = instanaCtr.logger().debug;

// CASE: We try to determine if the customer has the extension installed. We need to put a warning
// because the extension is **not** working and might block the lambda extension when
// its not used correctly e.g. slow startup of extension or waiting for invokes or incoming spans
// from the tracer.
if (process.env._HANDLER?.includes('instana-aws-lambda-auto-wrap')) {
logFn = logger.warn;
logFn = instanaCtr.logger().warn;
}

logFn(
Expand Down Expand Up @@ -428,7 +452,7 @@ function sendToBackend({ spans, metricsPayload, finalLambdaRequest, callback })

return ssm.waitAndGetInstanaKey((err, value) => {
if (err) {
logger.debug(err);
instanaCtr.logger().debug(err);
return callback();
}

Expand Down Expand Up @@ -513,14 +537,14 @@ function postHandlerForTimeout(entrySpan, remainingMillis) {
* `setTimeout` is not 100% reliable
*/
if (remainingMillis < 200) {
logger.debug('Skipping heuristical timeout detection because lambda timeout exceeded already.');
instanaCtr.logger().debug('Skipping heuristical timeout detection because lambda timeout exceeded already.');
return;
}

if (entrySpan) {
// CASE: Timeout not needed, we already send the data to the backend successfully
if (entrySpan.transmitted) {
logger.debug('Skipping heuristical timeout detection because BE data was sent already.');
instanaCtr.logger().debug('Skipping heuristical timeout detection because BE data was sent already.');
return;
}

Expand All @@ -531,7 +555,7 @@ function postHandlerForTimeout(entrySpan, remainingMillis) {
entrySpan.transmit();
}

logger.debug(`Heuristical timeout detection was triggered with ${remainingMillis} milliseconds left.`);
instanaCtr.logger().debug(`Heuristical timeout detection was triggered with ${remainingMillis} milliseconds left.`);

// deliberately not gathering metrics but only sending spans.
const spans = spanBuffer.getAndResetSpans();
Expand All @@ -551,7 +575,7 @@ exports.currentSpan = function getHandleForCurrentSpan() {
exports.sdk = tracing.sdk;

exports.setLogger = function setLogger(_logger) {
log.init({ logger: _logger });
instanaCtr.logger().setLogger(_logger);
};

exports.opentracing = tracing.opentracing;
Loading