feat: add table name to sequelize spans (#132)

Author: Nir Hadassi

.gitignore

@@ -23,4 +23,7 @@ yarn.lock
 
 # aspecto
 aspecto.json
-aspecto.log
+aspecto.log
+
+# created from sequelize unit tests
+memory 

packages/instrumentation-sequelize/README.md

@@ -44,6 +44,8 @@ Sequelize instrumentation has few options available to choose from. You can set
 | `responseHook` | `SequelizeResponseCustomAttributesFunction` | Hook called before response is returned, which allows to add custom attributes to span.      |
 | `ignoreOrphanedSpans` | `boolean` | Set to true if you only want to trace operation which has parent spans |
 | `moduleVersionAttributeName` | `string` | If passed, a span attribute will be added to all spans with key of the provided `moduleVersionAttributeName` and value of the patched module version |
+| `suppressInternalInstrumentation` | `boolean` | Sequelize operation use db libs under the hood. Setting this to true will hide the underlying spans (if instrumented). |
+
 
 ## Semantic Behavior
 Internal implementation queries generated on startup from connection-manager are not instrumented.

packages/instrumentation-sequelize/package.json

@@ -54,6 +54,7 @@
         "opentelemetry-instrumentation-testing-utils": "^0.5.0",
         "pg": "^8.4.2",
         "sequelize": "^5.22.0",
+        "sqlite3": "^5.0.2",
         "ts-node": "^9.1.1",
         "typescript": "^4.0.3"
     },

packages/instrumentation-sequelize/src/sequelize.ts

@@ -4,6 +4,7 @@ import { NetTransportValues, SemanticAttributes } from '@opentelemetry/semantic-
 import * as sequelize from 'sequelize';
 import { SequelizeInstrumentationConfig } from './types';
 import { VERSION } from './version';
+import { extractTableFromQuery } from './utils';
 import {
     InstrumentationBase,
     InstrumentationModuleDefinition,
@@ -106,6 +107,13 @@ export class SequelizeInstrumentation extends InstrumentationBase<typeof sequeli
             const sequelizeInstance: sequelize.Sequelize = this;
             const config = sequelizeInstance?.config;
 
+            let tableName = option?.instance?.constructor?.tableName;
+            if (!tableName) {
+                if (Array.isArray(option?.tableNames) && option.tableNames.length > 0)
+                    tableName = option?.tableNames.sort().join(',');
+                else tableName = extractTableFromQuery(statement);
+            }
+
             const attributes = {
                 [SemanticAttributes.DB_SYSTEM]: sequelizeInstance.getDialect(),
                 [SemanticAttributes.DB_USER]: config?.username,
@@ -115,7 +123,7 @@ export class SequelizeInstrumentation extends InstrumentationBase<typeof sequeli
                 [SemanticAttributes.DB_NAME]: config?.database,
                 [SemanticAttributes.DB_OPERATION]: operation,
                 [SemanticAttributes.DB_STATEMENT]: statement,
-                component: 'sequelize',
+                [SemanticAttributes.DB_SQL_TABLE]: tableName,
                 // [SemanticAttributes.NET_PEER_IP]: '?', // Part of protocol
             };
 
@@ -132,8 +140,15 @@ export class SequelizeInstrumentation extends InstrumentationBase<typeof sequeli
                 attributes,
             });
 
+            const activeContextWithSpan = trace.setSpan(context.active(), newSpan);
+
             return context
-                .with(trace.setSpan(context.active(), newSpan), () => original.apply(this, arguments))
+                .with(
+                    self._config.suppressInternalInstrumentation
+                        ? suppressTracing(activeContextWithSpan)
+                        : activeContextWithSpan,
+                    () => original.apply(this, arguments)
+                )
                 .then((response: any) => {
                     if (self._config?.responseHook) {
                         safeExecuteInTheMiddle(

packages/instrumentation-sequelize/src/types.ts

@@ -13,4 +13,12 @@ export interface SequelizeInstrumentationConfig extends InstrumentationConfig {
      * and value of the module version.
      */
     moduleVersionAttributeName?: string;
+    /**
+     * Sequelize operation use postgres/mysql/mariadb/etc. under the hood.
+     * If, for example, postgres instrumentation is enabled, a postgres operation will also create
+     * a postgres span describing the communication.
+     * Setting the `suppressInternalInstrumentation` config value to `true` will
+     * cause the instrumentation to suppress instrumentation of underlying operations.
+     */
+    suppressInternalInstrumentation?: boolean;
 }

packages/instrumentation-sequelize/src/utils.ts

@@ -0,0 +1,18 @@
+export const extractTableFromQuery = (query: string) => {
+    try {
+        const result = query?.match(/(?<=from|join|truncate)\s+\"?\`?(\w+)\"?\`?/gi);
+        if (!Array.isArray(result)) return;
+
+        return result
+            .map((table) =>
+                table
+                    .trim()
+                    .replace(/^"(.*)"$/, '$1')
+                    .replace(/^`(.*)`$/, '$1')
+            )
+            .sort()
+            .join(',');
+    } catch {
+        return;
+    }
+};