fix: disabling aws sdk instrumentation #866
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aryamohanan
approved these changes
Sep 18, 2023
kirrg001
force-pushed
the
fix/aws-sdk-disable
branch
from
d0b80b7 to
5dcb4b1
Compare
basti1302
approved these changes
Sep 19, 2023
| expect(activateStubGrpc).to.not.have.been.called; | ||
| expect(activateStubGrpcJs).to.have.been.called; | ||
| expect(activateStubKafkaJs).to.have.been.called; | ||
| expect(activateStubRdKafka).to.have.been.called; | ||
| expect(activateAwsSdkv2).to.have.been.called; |
There was a problem hiding this comment.
thought: We could use the same pairs of init and activate checks as in the test case 'deactivate instrumentation via config' here. On the other hand, the test setup only deactivates grpc, so to be honest, I do not remember why we check for all the other instrumentations here as well 🤔 I think just having expectations for grpc and maybe grpcjs for their respective init and activate methods would be enough?
Comment on lines
119
to
125
| it('skip init step when instrumentation disabled', () => { | ||
| initAndActivate({ tracing: { disabledTracers: ['grpcjs', 'kafkajs'] } }); | ||
| initAndActivate({ tracing: { disabledTracers: ['grpcjs', 'kafkajs', 'aws-sdk/v2'] } }); | ||
| expect(initStubKafkaJs).not.to.have.been.called; | ||
| expect(initStubGrpcJs).not.to.have.been.called; | ||
| expect(initAwsSdkv2).to.not.have.been.called; | ||
| expect(initStubGrpc).to.have.been.called; | ||
| }); |
There was a problem hiding this comment.
though: We could merge this into 'deactivate instrumentation via config' instead of having a separate test case, see above.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refs 139073
This is
a) not documented https://www.ibm.com/docs/en/instana-observability/current?topic=nodejs-collector-configuration#disabling-individual-tracers
b) customers would need to use
aws/sdk/v2/index, which is really not a good designThis is a first fix to this.
In the next major release we could drop the support for the old syntax. The major ticket contains it already.
This PR ensures that we still support the old notation, because it could be that some customers are using this.
Another addition could be: add an optional function like
handleDisablingInstrumentationand each instrumentation can handle it on it's own if wished e.g. aws sdk could disable only certain instrumentations. Right now users can only disable the while library.