instrumentation: fix oracle db connection string (#6003)

* instrumentation: improve oracle db connection string

Oracle supports three different ways to pass through conenctions.
We only supported URLs so far. Others were unsupported. Instead of
relying on the input, this changes the implementation to use the
drivers own information to get that part in v6. This reduces the overhead
of the instrumentation and we should always get the correct
information, no matter how the user passes the information through.

On top also parse oracle descriptors in v5 of the oracledb driver.

Author: BridgeAR

.github/workflows/apm-integrations.yml

@@ -771,14 +771,12 @@ jobs:
       SERVICES: oracledb
       DD_TEST_AGENT_URL: http://testagent:9126
       DD_INJECT_FORCE: 'true'
-      # Needed to fix issue with `actions/checkout@v3: https://github.com/actions/checkout/issues/1590
-      ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
     steps:
       # https://github.com/actions/runner/issues/2906#issuecomment-2109514798
       - name: Install Node for runner (with glibc 2.17 compatibility)
         run: |
-          curl -LO https://unofficial-builds.nodejs.org/download/release/v20.9.0/node-v20.9.0-linux-x64-glibc-217.tar.xz
-          tar -xf node-v20.9.0-linux-x64-glibc-217.tar.xz --strip-components 1 -C /node20217
+          curl -LO https://unofficial-builds.nodejs.org/download/release/v20.19.3/node-v20.19.3-linux-x64-glibc-217.tar.xz
+          tar -xf node-v20.19.3-linux-x64-glibc-217.tar.xz --strip-components 1 -C /node20217
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: ./.github/actions/node
         with:

packages/datadog-instrumentations/src/oracledb.js

@@ -38,12 +38,34 @@ addHook({ name: 'oracledb', versions: ['>=5'] }, oracledb => {
       }
 
       return new AsyncResource('apm:oracledb:inner-scope').runInAsyncScope(() => {
+        // The connAttrs are used to pass through the argument to the potential
+        // serviceName method a user might have passed through as well as parsing
+        // the connection string in v5.
         const connAttrs = connectionAttributes.get(this)
-        startChannel.publish({ query: dbQuery, connAttrs })
+
+        const details = typeof this.hostName === 'string' ? this : this._impl
+
+        let hostname
+        let port
+        let dbInstance
+
+        if (details) {
+          dbInstance = details.serviceName
+          hostname = details.hostName ?? details.nscon?.ntAdapter?.hostName
+          port = String(details.port ?? details.nscon?.ntAdapter?.port ?? '')
+        }
+
+        startChannel.publish({
+          query: dbQuery,
+          connAttrs,
+          dbInstance,
+          port,
+          hostname,
+        })
         try {
           let result = execute.apply(this, arguments)
 
-          if (result && typeof result.then === 'function') {
+          if (typeof result?.then === 'function') {
             result = result.then(
               x => {
                 finish()

packages/datadog-plugin-oracledb/src/connection-parser.js

@@ -0,0 +1,35 @@
+const { URL } = require('url')
+const log = require('../../dd-trace/src/log')
+
+function parseOracleDescriptor (descriptor) {
+  const hostnameMatch = descriptor.match(/HOST\s*=\s*([^)]+)/i)
+  const hostname = hostnameMatch?.[1] || 'localhost' // Default Oracle hostname
+
+  const portMatch = descriptor.match(/PORT\s*=\s*([^)]+)/i)
+  const port = portMatch?.[1] || '1521' // Default Oracle port
+
+  const sidMatch = descriptor.match(/SID\s*=\s*([^)]+)/i)
+
+  const dbInstance = sidMatch?.[1] || descriptor.match(/SERVICE_NAME\s*=\s*([^)]+)/i)?.[1] || 'XEPDB1' // Default Oracle service name
+
+  return { hostname, port, dbInstance }
+}
+
+module.exports = function getDBInformation (connAttrs) {
+  // Users can pass either connectString or connectionString
+  const connectString = ((connAttrs.connectString || connAttrs.connectionString) ?? '').trim()
+  if (connectString.startsWith('(')) {
+    return parseOracleDescriptor(connectString)
+  }
+  try {
+    const url = new URL(`oracle://${connectString}`)
+    return {
+      hostname: url.hostname || 'localhost', // Default Oracle hostname
+      port: url.port || '1521', // Default Oracle port
+      dbInstance: url.pathname && url.pathname.slice(1) || 'XEPDB1' // Default Oracle service name
+    }
+  } catch (error) {
+    log.error('Invalid oracle connection string', error)
+    return {}
+  }
+}

packages/datadog-plugin-oracledb/src/index.js

@@ -2,17 +2,30 @@
 
 const { CLIENT_PORT_KEY } = require('../../dd-trace/src/constants')
 const DatabasePlugin = require('../../dd-trace/src/plugins/database')
-const log = require('../../dd-trace/src/log')
+
+let parser
 
 class OracledbPlugin extends DatabasePlugin {
   static get id () { return 'oracledb' }
   static get system () { return 'oracle' }
   static get peerServicePrecursors () { return ['db.instance', 'db.hostname'] }
 
-  start ({ query, connAttrs }) {
-    const service = this.serviceName({ pluginConfig: this.config, params: connAttrs })
-    // Users can pass either connectString or connectionString
-    const url = getUrl(connAttrs.connectString || connAttrs.connectionString)
+  start ({ query, connAttrs, port, hostname, dbInstance }) {
+    let service = this.serviceName({ pluginConfig: this.config, params: connAttrs })
+
+    if (hostname === undefined) {
+      // Lazy load for performance. This is not needed in v6 and up
+      parser ??= require('./connection-parser')
+      const dbInfo = parser(connAttrs)
+      hostname = dbInfo.hostname
+      port ??= dbInfo.port
+      dbInstance ??= dbInfo.dbInstance
+    }
+
+    if (service === undefined && hostname) {
+      // Fallback for users not providing the service properly in a serviceName method
+      service = `${hostname}:${port}/${dbInstance}`
+    }
 
     this.startSpan(this.operationName(), {
       service,
@@ -21,22 +34,12 @@ class OracledbPlugin extends DatabasePlugin {
       kind: 'client',
       meta: {
         'db.user': this.config.user,
-        'db.instance': url.pathname && url.pathname.slice(1),
-        'db.hostname': url.hostname,
-        [CLIENT_PORT_KEY]: url.port
+        'db.instance': dbInstance,
+        'db.hostname': hostname,
+        [CLIENT_PORT_KEY]: port,
       }
     })
   }
 }
 
-// TODO: Avoid creating an error since it's a heavy operation.
-function getUrl (connectString) {
-  try {
-    return new URL(`http://${connectString}`)
-  } catch (e) {
-    log.error('Invalid oracle connection string', e)
-    return {}
-  }
-}
-
 module.exports = OracledbPlugin