- Incorporate review comments

Author: sudarshan12s

plugins/node/opentelemetry-instrumentation-oracledb/.eslintrc.js

@@ -12,7 +12,7 @@ module.exports = {
     },
     rules: {
         "header/header": ["error", "block", [{
-            pattern: /\* Copyright The OpenTelemetry Authors(?:, [^,\r\n]*)?[\r\n]+ \*[\r\n]+ \* Licensed under the Apache License, Version 2\.0 \(the "License"\);[\r\n]+ \* you may not use this file except in compliance with the License\.[\r\n]+ \* You may obtain a copy of the License at[\r\n]+ \*[\r\n]+ \* {6}https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0[\r\n]+ \*[\r\n]+ \* Unless required by applicable law or agreed to in writing, software[\r\n]+ \* distributed under the License is distributed on an "AS IS" BASIS,[\r\n]+ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.[\r\n]+ \* See the License for the specific language governing permissions and[\r\n]+ \* limitations under the License\.[\r\n]+ \*[\r\n]+ \* Copyright \(c\) 2024, Oracle and\/or its affiliates\.[\r\n]+ \*/gm,
+            pattern: /\* Copyright The OpenTelemetry Authors(?:, [^,\r\n]*)?[\r\n]+ \*[\r\n]+ \* Licensed under the Apache License, Version 2\.0 \(the "License"\);[\r\n]+ \* you may not use this file except in compliance with the License\.[\r\n]+ \* You may obtain a copy of the License at[\r\n]+ \*[\r\n]+ \* {6}https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0[\r\n]+ \*[\r\n]+ \* Unless required by applicable law or agreed to in writing, software[\r\n]+ \* distributed under the License is distributed on an "AS IS" BASIS,[\r\n]+ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.[\r\n]+ \* See the License for the specific language governing permissions and[\r\n]+ \* limitations under the License\.[\r\n]+ \*[\r\n]+ \* Copyright \(c\) 2025, Oracle and\/or its affiliates\.[\r\n]+ \*/gm,
             template: `
  * Copyright The OpenTelemetry Authors
  *
@@ -28,7 +28,7 @@ module.exports = {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * Copyright (c) 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2025, Oracle and/or its affiliates.
  * `
         }]]
     }

plugins/node/opentelemetry-instrumentation-oracledb/.tav.yml

@@ -1,4 +1,4 @@
 oracledb:
     # a sample from supported versions
-  - versions: "6.7.0"
+  - versions: ">=6.7.0 <7"
     commands: npm run test

plugins/node/opentelemetry-instrumentation-oracledb/README.md

@@ -17,7 +17,7 @@ npm install --save @opentelemetry/instrumentation-oracledb
 
 ## Supported Versions
 
-- [`oracledb`](https://www.npmjs.com/package/oracledb) versions `>=6.7.0`
+- [`oracledb`](https://www.npmjs.com/package/oracledb) versions `>=6.7.0 <7`
 
 ## Usage
 

plugins/node/opentelemetry-instrumentation-oracledb/src/constants.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * Copyright (c) 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2025, Oracle and/or its affiliates.
  * */
 
 // Oracle specific attributes not covered by semantic conventions
@@ -31,6 +31,8 @@ export enum AttributeNames {
 // Contains span names produced by instrumentation
 // It lists the RPC names (suffix with _MSG like EXECUTE_MSG) and
 // exported oracledb functions (like EXECUTE).
+// These constants need to be in sync with what is generated by the
+// 'oracledb' module.
 export enum SpanNames {
   CONNECT = 'oracledb.getConnection',
   POOL_CONNECT = 'oracledb.Pool.getConnection',

plugins/node/opentelemetry-instrumentation-oracledb/src/instrumentation.ts

@@ -34,11 +34,14 @@ export class OracleInstrumentation extends InstrumentationBase {
   protected init() {
     const moduleOracleDB = new InstrumentationNodeModuleDefinition(
       'oracledb',
-      ['>= 6.7 < 9.*'],
+      ['>= 6.7 < 7'],
       (moduleExports: typeof oracleDBTypes) => {
         const newmoduleExports: any = moduleExports;
         const config = this.getConfig();
-        const obj = new utils.OracleTelemetryTraceHandler(this.tracer, config);
+        const obj = new utils.OracleTelemetryTraceHandler(
+          () => this.tracer,
+          config
+        );
         obj.enable();
 
         // Register the instance with oracledb.

plugins/node/opentelemetry-instrumentation-oracledb/src/internal-types.ts

@@ -26,7 +26,9 @@ export interface InstrumentationContext {
   span: api.Span;
 }
 
-// Captures the entire span data
+// Captures the entire span data.
+// This corresponds to js object filled by the 'oracledb' module
+// See: https://github.com/oracle/node-oracledb/blob/main/lib/traceHandler.js
 export interface TraceSpanData {
   operation: string; // RPC or exported function name.
   error?: oracledbTypes.DBError;
@@ -35,6 +37,12 @@ export interface TraceSpanData {
   additionalConfig?: any; // custom key/values associated with a function.
   fn: Function; // Replaced with bind function associating the active context.
   args?: any[]; // input arguments passed to the exported function.
+
+  /**
+   * This value is filled by instrumented module inside 'onEnterFn',
+   * 'onBeginRoundTrip' hook functions, which is passed back by oracledb module
+   * in 'onExitFn' and 'onEndRoundTrip' hook functions respectively.
+   */
   userContext: InstrumentationContext;
 }
 

plugins/node/opentelemetry-instrumentation-oracledb/src/utils.ts

@@ -57,12 +57,12 @@ const newmoduleExports: any = oracledbTypes;
  */
 export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
   .TraceHandlerBase {
-  private _tracer: Tracer;
+  private _getTracer: () => Tracer;
   private _instrumentConfig: OracleInstrumentationConfig;
 
-  constructor(tracer: Tracer, config: OracleInstrumentationConfig) {
+  constructor(getTracer: () => Tracer, config: OracleInstrumentationConfig) {
     super();
-    this._tracer = tracer;
+    this._getTracer = getTracer;
     this._instrumentConfig = config;
   }
 
@@ -190,6 +190,16 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
     }
   }
 
+  // Updates the spanName with suffix, serviceName seperated by delimiter, space
+  // Ex: 'oracledb.Pool.getConnection freepdb'
+  // This function is called when connectLevelConfig has serviceName populated.
+  private _updateSpanName(traceContext: TraceSpanData) {
+    const dbName = traceContext.connectLevelConfig?.serviceName ?? '';
+    traceContext.userContext.span.updateName(
+      `${traceContext.operation}${dbName ? ` ${dbName}` : ''}`
+    );
+  }
+
   // Updates the span with final traceContext atributes
   // which are updated after the exported function call.
   // roundTrip flag will skip dumping bind values for
@@ -220,9 +230,10 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
       );
     }
     if (traceContext.error) {
+      span.recordException(traceContext.error);
       span.setStatus({
         code: SpanStatusCode.ERROR,
-        message: traceContext.error?.message,
+        message: traceContext.error.message,
       });
     }
   }
@@ -244,7 +255,7 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
       : {};
 
     traceContext.userContext = {
-      span: this._tracer.startSpan(spanName, {
+      span: this._getTracer().startSpan(spanName, {
         kind: SpanKind.CLIENT,
         attributes: spanAttributes,
       }),
@@ -269,11 +280,7 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
   // This method is invoked after exported function from oracledb module
   // completes.
   onExitFn(traceContext: TraceSpanData) {
-    if (
-      this._shouldSkipInstrumentation() ||
-      !traceContext.userContext ||
-      !traceContext.userContext.span
-    ) {
+    if (!traceContext.userContext?.span) {
       return;
     }
     this._updateFinalSpanAttributes(traceContext);
@@ -287,6 +294,7 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
       default:
         break;
     }
+    this._updateSpanName(traceContext);
     traceContext.userContext.span.end();
   }
 
@@ -299,7 +307,7 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
     const spanName = traceContext.operation;
     const spanAttrs = {};
     traceContext.userContext = {
-      span: this._tracer.startSpan(spanName, {
+      span: this._getTracer().startSpan(spanName, {
         kind: SpanKind.CLIENT,
         attributes: spanAttrs,
       }),
@@ -309,17 +317,14 @@ export class OracleTelemetryTraceHandler extends newmoduleExports.traceHandler
   // This method is invoked after a round trip call to DB is done
   // from the oracledb module as part of sql execution.
   onEndRoundTrip(traceContext: TraceSpanData) {
-    if (
-      this._shouldSkipInstrumentation() ||
-      !traceContext.userContext ||
-      !traceContext.userContext.span
-    ) {
+    if (!traceContext.userContext?.span) {
       return;
     }
 
     // Set if addtional connection and call parameters
     // are available
     this._updateFinalSpanAttributes(traceContext, true);
+    this._updateSpanName(traceContext);
     traceContext.userContext.span.end();
   }
 }