- Minor changes to align naming variable and more comments added.

Author: sudarshan12s

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

@@ -25,10 +25,12 @@ export enum AttributeNames {
   ORACLE_EXEC_OPTIONS = 'db.oracle.exec.options',
   ORACLE_INSTANCE = 'db.oracle.instance',
   ORACLE_PDBNAME = 'db.oracle.pdbname',
-  ORACLE_IMPLICIT_RELEASE = 'db.oracle.ImplicitRelease',
+  ORACLE_IMPLICIT_RELEASE = 'db.oracle.implicit_release',
 }
 
 // Contains span names produced by instrumentation
+// It lists the RPC names (suffix with _MSG like EXECUTE_MSG) and
+// exported oracledb functions (like EXECUTE).
 export enum SpanNames {
   CONNECT = 'oracledb.getConnection',
   POOL_CONNECT = 'oracledb.Pool.getConnection',

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

@@ -25,7 +25,7 @@ import * as utils from './utils';
 import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
 
 export class OracleInstrumentation extends InstrumentationBase {
-  private _tmHandler!: utils.OracleTelemetryTraceHandler | null;
+  private _tmHandler: utils.OracleTelemetryTraceHandler | null = null;
 
   constructor(config: OracleInstrumentationConfig = {}) {
     super(PACKAGE_NAME, PACKAGE_VERSION, config);

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

@@ -20,26 +20,27 @@ import * as oracledbTypes from 'oracledb';
 import type * as api from '@opentelemetry/api';
 import { SpanConnectionConfig } from './types';
 
-// Captures the context associated with onEnterFn, onExitFn hooks.
+// onEnterFn returns this Context(contains only span for now) and it is
+// received in onExitFn to end the span.
 export interface InstrumentationContext {
   span: api.Span;
 }
 
 // Captures the entire span data
 export interface TraceSpanData {
-  operation: string;
+  operation: string; // RPC or exported function name.
   error?: oracledbTypes.DBError;
   connectLevelConfig?: SpanConnectionConfig;
   callLevelConfig?: SpanCallLevelConfig;
-  additionalConfig?: any;
-  fn: Function;
-  args?: any[];
+  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.
   userContext: InstrumentationContext;
 }
 
 // Captures call level related span data
 export interface SpanCallLevelConfig {
-  statement?: string;
-  operation?: string;
-  values?: any[];
+  statement?: string; // SQL stmt.
+  operation?: string; // SQL op ('SELECT | INSERT ..').
+  values?: any[]; // bind values.
 }

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

@@ -29,9 +29,9 @@ export interface SpanConnectionConfig {
   instanceName?: string;
   serverMode?: string;
   pdbName?: string;
-  poolMin?: string;
-  poolMax?: string;
-  poolIncrement?: string;
+  poolMin?: number;
+  poolMax?: number;
+  poolIncrement?: number;
 }
 
 export interface OracleRequestHookInformation {