feat(plugin-aws-sdk): make dynamodb complaint to database client semantic conventions (#45)

Author: Amir Blum

packages/plugin-aws-sdk/package.json

@@ -47,6 +47,7 @@
     "dependencies": {
         "@opentelemetry/api": "^0.13.0",
         "@opentelemetry/core": "^0.13.0",
+        "@opentelemetry/semantic-conventions": "^0.13.0",
         "opentelemetry-propagation-utils": "0.1.0",
         "shimmer": "^1.2.1"
     },

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

@@ -84,12 +84,18 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
         return newSpan;
     }
 
-    private _callPreRequestHooks(span: Span, request: AWS.Request<any, any>) {
+    private _callUserPreRequestHook(span: Span, request: AWS.Request<any, any>) {
         if (this._config?.preRequestHook) {
             this._safeExecute(span, () => this._config.preRequestHook(span, request), false);
         }
     }
 
+    private _callUserResponseHook(span: Span, response: AWS.Response<any, any>) {
+        if (this._config?.responseHook) {
+            this._safeExecute(span, () => this._config.responseHook(span, response), false);
+        }
+    }
+
     private _registerCompletedEvent(span: Span, request: AWS.Request<any, any>) {
         const thisPlugin = this;
         request.on('complete', (response) => {
@@ -102,6 +108,7 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
                 span.setAttribute(AttributeNames.AWS_ERROR, response.error);
             }
 
+            this._callUserResponseHook(span, response);
             this.servicesExtensions.responseHook(response, span);
 
             span.setAttributes({
@@ -130,7 +137,7 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
                 requestMetadata.spanKind,
                 requestMetadata.spanName
             );
-            thisPlugin._callPreRequestHooks(span, awsRequest);
+            thisPlugin._callUserPreRequestHook(span, awsRequest);
             thisPlugin._registerCompletedEvent(span, awsRequest);
 
             const callbackWithContext = thisPlugin._tracer.bind(callback, span);
@@ -160,7 +167,7 @@ class AwsPlugin extends BasePlugin<typeof AWS> {
                 requestMetadata.spanKind,
                 requestMetadata.spanName
             );
-            thisPlugin._callPreRequestHooks(span, awsRequest);
+            thisPlugin._callUserPreRequestHook(span, awsRequest);
             thisPlugin._registerCompletedEvent(span, awsRequest);
 
             const origPromise: Promise<any> = thisPlugin._tracer.withSpan(span, () => {

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

@@ -1,9 +1,7 @@
 import { Span, Attributes, SpanKind } from '@opentelemetry/api';
 
-/*
-isIncoming - if true, then the operation callback / promise should be bind with the operation's span 
-*/
 export interface RequestMetadata {
+    // isIncoming - if true, then the operation callback / promise should be bind with the operation's span
     isIncoming: boolean;
     spanAttributes?: Attributes;
     spanKind?: SpanKind;
@@ -17,5 +15,5 @@ export interface ServiceExtension {
     // called before request is sent, and after span is started
     requestPostSpanHook?: (request: AWS.Request<any, any>) => void;
 
-    responseHook: (response: AWS.Response<any, any>, span: Span) => void;
+    responseHook?: (response: AWS.Response<any, any>, span: Span) => void;
 }

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

@@ -3,12 +3,14 @@ import { ServiceExtension, RequestMetadata } from './ServiceExtension';
 import { SqsServiceExtension } from './sqs';
 import * as AWS from 'aws-sdk';
 import { AwsSdkPluginConfig } from '../types';
+import { DynamodbServiceExtension } from './dynamodb';
 
 export class ServicesExtensions implements ServiceExtension {
     services: Map<string, ServiceExtension> = new Map();
 
     constructor(tracer: Tracer, logger: Logger, pluginConfig: AwsSdkPluginConfig) {
         this.services.set('sqs', new SqsServiceExtension(tracer, logger, pluginConfig?.sqsProcessHook));
+        this.services.set('dynamodb', new DynamodbServiceExtension());
     }
 
     requestHook(request: AWS.Request<any, any>): RequestMetadata {
@@ -31,7 +33,6 @@ export class ServicesExtensions implements ServiceExtension {
     responseHook(response: AWS.Response<any, any>, span: Span) {
         const serviceId = (response as any)?.request?.service?.serviceIdentifier;
         const serviceExtension = this.services.get(serviceId);
-        if (!serviceExtension) return;
-        serviceExtension.responseHook(response, span);
+        serviceExtension?.responseHook?.(response, span);
     }
 }

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

@@ -0,0 +1,26 @@
+import { Logger, SpanKind } from '@opentelemetry/api';
+import { RequestMetadata, ServiceExtension } from './ServiceExtension';
+import { DatabaseAttribute } from '@opentelemetry/semantic-conventions';
+
+export class DynamodbServiceExtension implements ServiceExtension {
+    requestHook(request: AWS.Request<any, any>): RequestMetadata {
+        let spanKind: SpanKind = SpanKind.CLIENT;
+        let spanName: string;
+        let isIncoming = false;
+        const operation = (request as any)?.operation;
+
+        const spanAttributes = {
+            [DatabaseAttribute.DB_SYSTEM]: 'dynamodb',
+            [DatabaseAttribute.DB_NAME]: (request as any)?.params?.TableName,
+            [DatabaseAttribute.DB_OPERATION]: operation,
+            [DatabaseAttribute.DB_STATEMENT]: JSON.stringify((request as any)?.params),
+        };
+
+        return {
+            isIncoming,
+            spanAttributes,
+            spanKind,
+            spanName,
+        };
+    }
+}

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

@@ -5,14 +5,21 @@ export interface AwsSdkRequestCustomAttributeFunction {
     (span: Span, request: AWS.Request<any, any>): void;
 }
 
+export interface AwsSdkResponseCustomAttributeFunction {
+    (span: Span, response: AWS.Response<any, any>): void;
+}
+
 export interface AwsSdkSqsProcessCustomAttributeFunction {
     (span: Span, message: AWS.SQS.Message): void;
 }
 
 export interface AwsSdkPluginConfig extends PluginConfig {
-    /** hook for adding custom attributes before producer message is sent */
+    /** hook for adding custom attributes before request is sent to aws */
     preRequestHook?: AwsSdkRequestCustomAttributeFunction;
 
+    /** hook for adding custom attributes when response is received from aws */
+    responseHook?: AwsSdkResponseCustomAttributeFunction;
+
     /** hook for adding custom attribute when an sqs process span is started */
     sqsProcessHook?: AwsSdkSqsProcessCustomAttributeFunction;
 }