Skip to content

Commit

Permalink
fix: dropped support for disabling AWS SDK instrumentation in old syn…
Browse files Browse the repository at this point in the history
…tax (#1383)

BREAKING CHANGE:
- Removed the ability to disable AWS SDK instrumentation using the old syntax disabledTracers: ['aws-sdk/v2/index'].
- Migrate to the new syntax for disabling instrumentation: disabledTracers: ['aws-sdk/v2'].
  • Loading branch information
aryamohanan committed Oct 18, 2024
1 parent 8c43a7a commit 0b05672
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 12 deletions.
4 changes: 2 additions & 2 deletions packages/core/src/tracing/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ let processIdentityProvider = null;

// Note: Also update initializedTooLateHeuristic.js and the accompanying test when adding instrumentations.
let instrumentations = [
'./instrumentation/cloud/aws-sdk/v2/index',
'./instrumentation/cloud/aws-sdk/v3/index',
'./instrumentation/cloud/aws-sdk/v2',
'./instrumentation/cloud/aws-sdk/v3',
'./instrumentation/cloud/aws-sdk/v2/sdk',
'./instrumentation/cloud/aws-sdk/v2/sqs',
'./instrumentation/cloud/azure/blob',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ awsProducts.forEach(awsProduct => {

let isActive = false;

exports.instrumentationName = 'aws-sdk/v2';

exports.isActive = function () {
return isActive;
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ awsProducts.forEach(awsProduct => {

let isActive = false;

exports.instrumentationName = 'aws-sdk/v3';

exports.init = function init() {
sqsConsumer.init();

Expand Down
23 changes: 17 additions & 6 deletions packages/core/test/tracing/index_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -127,16 +127,27 @@ mochaSuiteFn('[UNIT] tracing/index', function () {
expect(activateStubRdKafka).to.have.been.calledWith(extraConfigFromAgent);
});

it('[deprecated] aws-sdk/v2/index', () => {
initAndActivate({ tracing: { disabledTracers: ['aws-sdk/v2/index'] } });
it('disable aws-sdk/v3', () => {
initAndActivate({ tracing: { disabledTracers: ['aws-sdk/v3'] } });

// aws-sdk/v2 has been disabled (via aws-sdk/v2/index)
// aws-sdk/v3 has been disabled (via aws-sdk/v3)
expect(initAwsSdkv3).not.to.have.been.called;
expect(activateAwsSdkv3).not.to.have.been.called;

// aws-sdk/v2 has not been disabled (via aws-sdk/v2)
expect(initAwsSdkv2).to.have.been.called;
expect(activateAwsSdkv2).to.have.been.called;
});
it('disable aws-sdk/v3 and aws-sdk/v2', () => {
initAndActivate({ tracing: { disabledTracers: ['aws-sdk/v3', 'aws-sdk/v2'] } });

// aws-sdk/v2 has been disabled (via aws-sdk/v2)
expect(initAwsSdkv2).not.to.have.been.called;
expect(activateAwsSdkv2).not.to.have.been.called;

// aws-sdk/v3 has not been disabled
expect(initAwsSdkv3).to.have.been.called;
expect(activateAwsSdkv3).to.have.been.called;
// aws-sdk/v3 has been disabled (via aws-sdk/v3)
expect(initAwsSdkv3).not.to.have.been.called;
expect(activateAwsSdkv3).not.to.have.been.called;
});

function initAndActivate(initConfig, extraConfigForActivate) {
Expand Down

0 comments on commit 0b05672

Please sign in to comment.