Limit the size of API Gateway trigger's body attribute

coralogix · Oct 16, 2023 · cc4b184 · cc4b184
1 parent ef8ce13
commit cc4b184
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 11 deletions.
diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/instrumentation.ts
@@ -250,6 +250,7 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
             // the handler happened to both call the callback and complete a returned Promise, whichever happens first will
             // win and the latter will be ignored.
             const wrappedCallback = plugin._wrapCallback(
+              config,
               callback,
               lambdaSpan,
               triggerSpan
@@ -309,13 +310,13 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
                   value => {
                     strict(triggerSpan);
 
-                    void plugin._endWrapperSpan(triggerSpan, value, undefined);
+                    void plugin._endWrapperSpan(config, triggerSpan, value, undefined);
 
                     return value;
                   },
                   async error => {
                     strict(triggerSpan);
-                    await plugin._endWrapperSpan(triggerSpan, undefined, error);
+                    await plugin._endWrapperSpan(config, triggerSpan, undefined, error);
                     throw error; // We don't want the instrumentation to hide the error from AWS
                   }
                 );
@@ -325,6 +326,7 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
 
                 //if (hasLambdaSynchronouslyThrown) {
                 void plugin._endWrapperSpan(
+                  config,
                   triggerSpan,
                   innerResult,
                   undefined
@@ -338,7 +340,7 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
             error => {
               if (error) {
                 strict(triggerSpan);
-                void plugin._endWrapperSpan(triggerSpan, undefined, error);
+                void plugin._endWrapperSpan(config, triggerSpan, undefined, error);
                 void plugin._flush();
               }
             }
@@ -389,9 +391,10 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
   }
 
   private async _endWrapperSpan(
+    config: AwsLambdaInstrumentationConfig,
     span: Span,
     lambdaResponse: any,
-    errorFromLambda: string | Error | null | undefined
+    errorFromLambda: string | Error | null | undefined,
   ) {
     if (errorFromLambda) {
       span.recordException(errorFromLambda);
@@ -411,12 +414,13 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
         this.triggerOrigin
       )
     ) {
-      finalizeSpan(this.triggerOrigin, span, lambdaResponse);
+      finalizeSpan(config, this.triggerOrigin, span, lambdaResponse);
     }
     span.end();
   }
 
   private _wrapCallback(
+    config: AwsLambdaInstrumentationConfig,
     originalAWSLambdaCallback: Callback,
     span: Span,
     wrapperSpan?: Span
@@ -428,7 +432,7 @@ export class AwsLambdaInstrumentation extends InstrumentationBase {
 
       plugin._endSpan(span, err);
       if (wrapperSpan) {
-        void plugin._endWrapperSpan(wrapperSpan, res, err);
+        void plugin._endWrapperSpan(config, wrapperSpan, res, err);
       }
 
       void this._flush().then(() => {

diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/triggers/api-gateway/common.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/triggers/api-gateway/common.ts
@@ -18,6 +18,8 @@ import { SpanStatusCode } from '@opentelemetry/api';
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
 import { APIGatewayProxyResult } from 'aws-lambda';
 
+const DEFAULT_OTEL_PAYLOAD_SIZE_LIMIT = 50 * 1024;
+
 export function isGatewayResult(result: any): result is APIGatewayProxyResult {
   return (
     result &&
@@ -27,7 +29,7 @@ export function isGatewayResult(result: any): result is APIGatewayProxyResult {
   );
 }
 
-export const finalizeApiGatewaySpan: SpanFinalizer = (span, response) => {
+export const finalizeApiGatewaySpan: SpanFinalizer = (span, response, config) => {
   if (!isGatewayResult(response)) {
     return;
   }
@@ -51,9 +53,11 @@ export const finalizeApiGatewaySpan: SpanFinalizer = (span, response) => {
   const { body } = response;
 
   if (body) {
+    const bodyStr = typeof body === 'object' ? JSON.stringify(body) : body;
+    const payloadSizeLimit = config?.payloadSizeLimit ?? DEFAULT_OTEL_PAYLOAD_SIZE_LIMIT;
     span.setAttribute(
       'http.response.body',
-      typeof body === 'object' ? JSON.stringify(body) : body
+      bodyStr.substring(0, payloadSizeLimit)
     );
   }
 };
diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/triggers/common.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/triggers/common.ts
@@ -17,6 +17,7 @@
 import { SpanOptions } from '@opentelemetry/api/build/src/trace/SpanOptions';
 import { Span } from '@opentelemetry/api';
 import { TriggerOrigin } from './index';
+import { AwsLambdaInstrumentationConfig } from '../types';
 
 export type TriggerValidator<T> = (event: any) => event is T;
 export interface TriggerSpanInitializerResult {
@@ -27,7 +28,7 @@ export interface TriggerSpanInitializerResult {
 export type TriggerSpanInitializer<T> = (
   event: T
 ) => TriggerSpanInitializerResult;
-export type SpanFinalizer = (span: Span, response?: any) => void;
+export type SpanFinalizer = (span: Span, response?: any, config?: AwsLambdaInstrumentationConfig) => void;
 
 export interface LambdaTrigger<T> {
   validator: TriggerValidator<T>;

diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/triggers/index.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/triggers/index.ts
@@ -25,6 +25,7 @@ import { EventBridgeTrigger } from './event-bridge';
 import { DynamoDBTrigger } from './dynamodb-stream';
 import { Span } from '@opentelemetry/api';
 import { CloudWatchLogsTrigger } from './cloudwatch-logs';
+import { AwsLambdaInstrumentationConfig } from '../types';
 
 export const LambdaAttributes = {
   TRIGGER_SERVICE: 'faas.trigger.type',
@@ -86,12 +87,13 @@ export const getEventTrigger = (
 };
 
 export const finalizeSpan = (
+  config: AwsLambdaInstrumentationConfig,
   origin: TriggerOrigin,
   triggerSpan: Span,
-  response: any
+  response: any,
 ) => {
   const trigger = lambdaTriggers[origin];
   if (trigger.finalizer) {
-    trigger.finalizer(triggerSpan, response);
+    trigger.finalizer(triggerSpan, response, config);
   }
 };
diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/types.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/types.ts
@@ -41,4 +41,5 @@ export interface AwsLambdaInstrumentationConfig extends InstrumentationConfig {
   disableAwsContextPropagation?: boolean;
   detectTrigger?: boolean;
   eventContextExtractor?: EventContextExtractor;
+  payloadSizeLimit?: number;
 }