feat(aws-sdk): add suppressInternalInstrumentation config option (#53)

Author: Amir Blum

packages/plugin-aws-sdk/README.md

@@ -34,7 +34,10 @@ aws-sdk plugin has few options available to choose from. You can set the followi
 | Options        | Type                                   | Description                                                                                     |
 | -------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------- |
 | `preRequestHook` | `AwsSdkRequestCustomAttributeFunction` | Hook called before request send, which allow to add custom attributes to span. |
+| `responseHook` | `AwsSdkResponseCustomAttributeFunction` | Hook for adding custom attributes when response is received from aws. |
 | `sqsProcessHook` | `AwsSdkSqsProcessCustomAttributeFunction` | Hook called after starting sqs `process` span (for each sqs received message), which allow to add custom attributes to it. |
+| `suppressInternalInstrumentation` | boolean | Most aws operation use http request under the hood. If http instrumentation is enabled, each aws operation will also create an http/s child describing the communication with amazon servers. Setting the suppressInternalInstrumentation` config value to `true` will cause the plugin to suppress instrumentation of underlying operations, effectively causing those http spans to be non-recordable. |
+
 
 
 ## Span Attributes

packages/plugin-aws-sdk/src/aws-sdk.ts

@@ -9,7 +9,7 @@
     callback    |       1           |       2   
  */
 import { BasePlugin } from '@opentelemetry/core';
-import { Span, StatusCode, Attributes, SpanKind } from '@opentelemetry/api';
+import { Span, StatusCode, Attributes, SpanKind, context, suppressInstrumentation } from '@opentelemetry/api';
 import * as shimmer from 'shimmer';
 import AWS from 'aws-sdk';
 import { AttributeNames } from './enums';
@@ -143,7 +143,7 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
             const callbackWithContext = thisPlugin._tracer.bind(callback, span);
             return thisPlugin._tracer.withSpan(span, () => {
                 thisPlugin.servicesExtensions.requestPostSpanHook(awsRequest);
-                return original.call(awsRequest, callbackWithContext);
+                return thisPlugin._callOriginalFunction(() => original.call(awsRequest, callbackWithContext));
             });
         };
     }
@@ -172,7 +172,7 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
 
             const origPromise: Promise<any> = thisPlugin._tracer.withSpan(span, () => {
                 thisPlugin.servicesExtensions.requestPostSpanHook(awsRequest);
-                return original.apply(awsRequest, arguments);
+                return thisPlugin._callOriginalFunction(() => original.call(awsRequest, arguments));
             });
 
             return requestMetadata.isIncoming ? thisPlugin._bindPromise(origPromise, span) : origPromise;
@@ -206,6 +206,14 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
             this._logger.error('caught error ', error);
         }
     }
+
+    private _callOriginalFunction<T>(originalFunction: (...args: any[]) => T): T {
+        if (this._config?.suppressInternalInstrumentation) {
+            return context.with(suppressInstrumentation(context.active()), originalFunction);
+        } else {
+            return originalFunction();
+        }
+    }
 }
 
 export const plugin = new AwsPlugin('aws-sdk');

packages/plugin-aws-sdk/src/types.ts

@@ -23,4 +23,14 @@ export interface AwsSdkPluginConfig extends PluginConfig {
 
     /** hook for adding custom attribute when an sqs process span is started */
     sqsProcessHook?: AwsSdkSqsProcessCustomAttributeFunction;
+
+    /** 
+     * Most aws operation use http request under the hood.
+     * if http instrumentation is enabled, each aws operation will also create
+     * an http/s child describing the communication with amazon servers.
+     * Setting the `suppressInternalInstrumentation` config value to `true` will
+     * cause the plugin to suppress instrumentation of underlying operations,
+     * effectively causing those http spans to be non-recordable.
+     */
+    suppressInternalInstrumentation?: boolean;
 }

packages/plugin-aws-sdk/test/aws-sdk.spec.ts

@@ -219,11 +219,8 @@ describe('plugin-aws-sdk', () => {
     });
 
     describe('plugin config', () => {
-        beforeAll(() => {
-            mockAwsSend(responseMockSuccess, 'data returned from operation');
-        });
-
         it('preRequestHook called and add request attribute to span', (done) => {
+            mockAwsSend(responseMockSuccess, 'data returned from operation');
             const pluginConfig = {
                 enabled: true,
                 preRequestHook: (span: Span, request: { params: Record<string, any> }) => {
@@ -245,6 +242,7 @@ describe('plugin-aws-sdk', () => {
         });
 
         it('preRequestHook throws does not fail span', (done) => {
+            mockAwsSend(responseMockSuccess, 'data returned from operation');
             const pluginConfig = {
                 enabled: true,
                 preRequestHook: (span: Span, request: any) => {
@@ -266,6 +264,7 @@ describe('plugin-aws-sdk', () => {
         });
 
         it('responseHook called and add response attribute to span', (done) => {
+            mockAwsSend(responseMockSuccess, 'data returned from operation');
             const pluginConfig = {
                 enabled: true,
                 responseHook: (span: Span, response: { params: AWS.Response<any, any> }) => {
@@ -287,5 +286,40 @@ describe('plugin-aws-sdk', () => {
                 done();
             });
         });
+
+        it('suppressInternalInstrumentation set to true with send()', (done) => {
+            mockAwsSend(responseMockSuccess, 'data returned from operation', true);
+            const pluginConfig = {
+                enabled: true,
+                suppressInternalInstrumentation: true,
+            };
+
+            plugin.enable(AWS, provider, logger, pluginConfig);
+
+            const s3 = new AWS.S3();
+
+            s3.createBucket({ Bucket: 'aws-test-bucket' }, function (err, data) {
+                const awsSpans = getAwsSpans();
+                expect(awsSpans.length).toBe(1);
+                done();
+            });
+        });
+
+        it('suppressInternalInstrumentation set to true with promise()', async () => {
+            mockAwsSend(responseMockSuccess, 'data returned from operation', true);
+            const pluginConfig = {
+                enabled: true,
+                suppressInternalInstrumentation: true,
+            };
+
+            plugin.enable(AWS, provider, logger, pluginConfig);
+
+            const s3 = new AWS.S3();
+
+            await s3.createBucket({ Bucket: 'aws-test-bucket' }).promise();
+            const awsSpans = getAwsSpans();
+            expect(awsSpans.length).toBe(1);
+        })
+
     });
 });

packages/plugin-aws-sdk/test/testing-utils.ts

@@ -1,7 +1,9 @@
+import { isInstrumentationSuppressed, context } from '@opentelemetry/api';
 import AWS from 'aws-sdk';
 
-export const mockAwsSend = (sendResult: any, data: any = undefined) => {
+export const mockAwsSend = (sendResult: any, data: any = undefined, expectedInstrumentationSuppressed: boolean = false) => {
     AWS.Request.prototype.send = function (cb?: (error, response) => void) {
+        expect(isInstrumentationSuppressed(context.active())).toStrictEqual(expectedInstrumentationSuppressed);
         if (cb) {
             (this as AWS.Request<any, any>).on('complete', (response) => {
                 cb(response.error, response);
@@ -19,6 +21,7 @@ export const mockAwsSend = (sendResult: any, data: any = undefined) => {
     };
 
     AWS.Request.prototype.promise = function () {
+        expect(isInstrumentationSuppressed(context.active())).toStrictEqual(expectedInstrumentationSuppressed);
         const response = {
             ...sendResult,
             data,