feat(oracledb): Add support for Oracle DB instrumentation (#2612)

Co-authored-by: Marylia Gutierrez <[email protected]>

Author: sudarshan12s

.github/component-label-map.yml

@@ -188,6 +188,11 @@ pkg:instrumentation-net:
   - changed-files:
       - any-glob-to-any-file:
           - plugins/node/opentelemetry-instrumentation-net/**
+pkg:instrumentation-oracledb:
+  - changed-files:
+      - any-glob-to-any-file:
+          - plugins/node/opentelemetry-instrumentation-oracledb/**
+          - packages/opentelemetry-test-utils/**
 pkg:instrumentation-pg:
   - changed-files:
       - any-glob-to-any-file:

.github/component_owners.yml

@@ -123,6 +123,9 @@ components:
     # Unmaintained
   plugins/node/opentelemetry-instrumentation-net:
     - seemk
+  plugins/node/opentelemetry-instrumentation-oracledb:
+    - sudarshan12s
+    - sharadraju
   plugins/node/instrumentation-runtime-node:
     - d4nyll
   plugins/node/opentelemetry-instrumentation-pg:

.github/workflows/test-all-versions.yml

@@ -80,6 +80,19 @@ jobs:
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
+      oracledb:
+        image: gvenzl/oracle-free:slim
+        env:
+          APP_USER: otel
+          APP_USER_PASSWORD: secret
+          ORACLE_PASSWORD: oracle
+        ports:
+          - 1521:1521
+        options: >-
+          --health-cmd "sqlplus system/oracle@//localhost/FREEPDB1"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
       postgres:
         image: postgres:16-alpine
         env:
@@ -122,6 +135,12 @@ jobs:
       MYSQL_USER: otel
       OPENTELEMETRY_REDIS_HOST: localhost
       OPENTELEMETRY_REDIS_PORT: 6379
+      ORACLE_HOSTNAME: localhost
+      ORACLE_PORT: 1521
+      ORACLE_CONNECTSTRING: localhost:1521/freepdb1
+      ORACLE_USER: otel
+      ORACLE_PASSWORD: secret
+      ORACLE_SERVICENAME: FREEPDB1
       POSTGRES_DB: otel_pg_database
       POSTGRES_HOST: localhost
       POSTGRES_PORT: 5432
@@ -130,6 +149,7 @@ jobs:
       RUN_MONGODB_TESTS: 1
       RUN_MSSQL_TESTS: 1
       RUN_MYSQL_TESTS: 1
+      RUN_ORACLEDB_TESTS: 1
       RUN_POSTGRES_TESTS: 1
       RUN_REDIS_TESTS: 1
       NPM_CONFIG_UNSAFE_PERM: true

.github/workflows/unit-test.yml

@@ -83,6 +83,19 @@ jobs:
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
+      oracledb:
+        image: gvenzl/oracle-free:slim
+        env:
+          APP_USER: otel
+          APP_USER_PASSWORD: secret
+          ORACLE_PASSWORD: oracle
+        ports:
+          - 1521:1521
+        options: >-
+          --health-cmd "sqlplus system/oracle@//localhost/FREEPDB1"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
       postgres:
         image: postgres:16-alpine
         env:
@@ -122,6 +135,7 @@ jobs:
       RUN_MONGODB_TESTS: 1
       RUN_MYSQL_TESTS: 1
       RUN_MSSQL_TESTS: 1
+      RUN_ORACLEDB_TESTS: 1
       RUN_POSTGRES_TESTS: 1
       RUN_REDIS_TESTS: 1
       RUN_RABBIT_TESTS: 1
@@ -140,6 +154,12 @@ jobs:
       OPENTELEMETRY_MEMCACHED_PORT: 11211
       OPENTELEMETRY_REDIS_HOST: localhost
       OPENTELEMETRY_REDIS_PORT: 6379
+      ORACLE_HOSTNAME: localhost
+      ORACLE_PORT: 1521
+      ORACLE_CONNECTSTRING: localhost:1521/freepdb1
+      ORACLE_USER: otel
+      ORACLE_PASSWORD: secret
+      ORACLE_SERVICENAME: FREEPDB1
       POSTGRES_DB: otel_pg_database
       POSTGRES_HOST: localhost
       POSTGRES_PORT: 5432

.release-please-manifest.json

@@ -50,6 +50,7 @@
   "plugins/node/opentelemetry-instrumentation-mysql2": "0.46.0",
   "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.46.0",
   "plugins/node/opentelemetry-instrumentation-net": "0.44.0",
+  "plugins/node/opentelemetry-instrumentation-oracledb": "0.26.0",
   "plugins/node/opentelemetry-instrumentation-pg": "0.52.0",
   "plugins/node/opentelemetry-instrumentation-pino": "0.47.0",
   "plugins/node/opentelemetry-instrumentation-redis": "0.47.0",

metapackages/auto-instrumentations-node/README.md

@@ -193,6 +193,7 @@ registerInstrumentations({
 - [@opentelemetry/instrumentation-mysql2](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql2)
 - [@opentelemetry/instrumentation-nestjs-core](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-nestjs-core)
 - [@opentelemetry/instrumentation-net](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-net)
+- [@opentelemetry/instrumentation-oracledb](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-oracledb)
 - [@opentelemetry/instrumentation-pg](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pg)
 - [@opentelemetry/instrumentation-pino](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pino)
 - [@opentelemetry/instrumentation-redis](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-redis)

metapackages/auto-instrumentations-node/package.json

@@ -78,6 +78,7 @@
     "@opentelemetry/instrumentation-mysql2": "^0.46.0",
     "@opentelemetry/instrumentation-nestjs-core": "^0.46.0",
     "@opentelemetry/instrumentation-net": "^0.44.0",
+    "@opentelemetry/instrumentation-oracledb": "^0.26.0",
     "@opentelemetry/instrumentation-pg": "^0.52.0",
     "@opentelemetry/instrumentation-pino": "^0.47.0",
     "@opentelemetry/instrumentation-redis": "^0.47.0",

metapackages/auto-instrumentations-node/src/utils.ts

@@ -46,6 +46,7 @@ import { MySQL2Instrumentation } from '@opentelemetry/instrumentation-mysql2';
 import { MySQLInstrumentation } from '@opentelemetry/instrumentation-mysql';
 import { NestInstrumentation } from '@opentelemetry/instrumentation-nestjs-core';
 import { NetInstrumentation } from '@opentelemetry/instrumentation-net';
+import { OracleInstrumentation } from '@opentelemetry/instrumentation-oracledb';
 import { PgInstrumentation } from '@opentelemetry/instrumentation-pg';
 import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
 import { RedisInstrumentation as RedisInstrumentationV2 } from '@opentelemetry/instrumentation-redis';
@@ -124,6 +125,7 @@ const InstrumentationMap = {
   '@opentelemetry/instrumentation-mysql': MySQLInstrumentation,
   '@opentelemetry/instrumentation-nestjs-core': NestInstrumentation,
   '@opentelemetry/instrumentation-net': NetInstrumentation,
+  '@opentelemetry/instrumentation-oracledb': OracleInstrumentation,
   '@opentelemetry/instrumentation-pg': PgInstrumentation,
   '@opentelemetry/instrumentation-pino': PinoInstrumentation,
   '@opentelemetry/instrumentation-redis': RedisInstrumentationV2,

package-lock.json

@@ -42,6 +42,8 @@ const dockerRunCmds = {
     'docker run --rm -d --name otel-mssql -p 1433:1433 -e MSSQL_SA_PASSWORD=mssql_passw0rd -e ACCEPT_EULA=Y mcr.microsoft.com/mssql/server:2022-latest',
   mysql:
     'docker run --rm -d --name otel-mysql -p 33306:3306 -e MYSQL_ROOT_PASSWORD=rootpw -e MYSQL_DATABASE=test_db -e MYSQL_USER=otel -e MYSQL_PASSWORD=secret mysql:5.7 --log_output=TABLE --general_log=ON',
+  oracledb:
+    'docker run --rm -d --name otel-oracledb -p 1521:1521 -e ORACLE_PASSWORD=oracle -e APP_USER=otel -e APP_USER_PASSWORD=secret gvenzl/oracle-free:slim',
   postgres:
     'docker run --rm -d --name otel-postgres -p 54320:5432 -e POSTGRES_PASSWORD=postgres postgres:16-alpine',
   redis: 'docker run --rm -d --name otel-redis -p 63790:6379 redis:alpine',