refactor: Updated cassandra-driver instrumentation to subscribe to events emitted. (newrelic#3372)

Author: bizob2828

lib/instrumentation/cassandra-driver.js

@@ -23,7 +23,6 @@ module.exports = function instrumentations() {
     'aws-sdk': { module: './instrumentation/aws-sdk' },
     bluebird: { type: InstrumentationDescriptor.TYPE_PROMISE },
     bunyan: { type: InstrumentationDescriptor.TYPE_GENERIC },
-    'cassandra-driver': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     connect: { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     express: { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     fastify: { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },

lib/instrumentations.js

@@ -8,6 +8,7 @@
 // The expected export of these files is:
 // 'package-name': [ { path: 'subscriberPath', instrumentations: [] }, ... ]
 const subscribers = {
+  ...require('./subscribers/cassandra-driver/config'),
   ...require('./subscribers/elasticsearch/config'),
   ...require('./subscribers/ioredis/config'),
   ...require('./subscribers/mcp-sdk/config'),

lib/subscriber-configs.js

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const DbQuerySubscriber = require('../db-query')
+
+/**
+ * Given the arguments for Cassandra's `batch` method, this finds the first
+ * query in the batch.
+ *
+ * @param {Array} args - original arguments passed to the batch function
+ * @returns {string} The query for this batch request.
+ */
+function findBatchQueryArg(args) {
+  const sql = (args[0] && args[0][0]) || ''
+  return sql.query || sql
+}
+
+/**
+ * Subscribes to the `batch` event in `cassandra-driver`
+ * and extracts relevant information from the queries.
+ */
+class CassandraBatchSubscriber extends DbQuerySubscriber {
+  constructor({ agent, logger, channelName = 'nr_batch' }) {
+    super({ agent, logger, channelName, packageName: 'cassandra-driver', system: 'Cassandra' })
+    this.events = ['asyncEnd']
+    this.isBatch = true
+  }
+
+  handler(data, ctx) {
+    const { self, arguments: args } = data
+    this.queryString = findBatchQueryArg(args)
+    this.setParameters(self)
+    return super.handler(data, ctx)
+  }
+
+  setParameters(self) {
+    this.parameters = {}
+    this.parameters.product = this.system
+    this.parameters.database_name = self?.keyspace
+    this.parameters.host = self?.options?.contactPoints?.[0]
+    this.parameters.port_path_or_id = self?.options?.protocolOptions?.port
+  }
+}
+
+module.exports = CassandraBatchSubscriber

lib/subscribers/cassandra-driver/client-batch.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const DbOperationSubscriber = require('../db-operation')
+
+/**
+ * Subscribes to the `connect` event in `cassandra-driver`'s `Client`.
+ */
+class CassandraConnectSubscriber extends DbOperationSubscriber {
+  constructor({ agent, logger, channelName = 'nr_connect' }) {
+    super({ agent, logger, channelName, packageName: 'cassandra-driver', system: 'Cassandra' })
+    this.events = ['asyncEnd']
+    this.operation = 'connect'
+  }
+
+  handler(data, ctx) {
+    const { self } = data
+    this.setParameters(self)
+    return super.handler(data, ctx)
+  }
+
+  setParameters(self) {
+    this.parameters = {}
+    this.parameters.product = this.system
+    this.parameters.database_name = self?.keyspace
+    this.parameters.host = self?.options?.contactPoints?.[0]
+    this.parameters.port_path_or_id = self?.options?.protocolOptions?.port
+  }
+}
+
+module.exports = CassandraConnectSubscriber

lib/subscribers/cassandra-driver/client-connect.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const DbQuerySubscriber = require('../db-query')
+
+/**
+ * Subscribes to the `execute` event in `cassandra-driver`
+ * and extracts relevant information from the query.
+ */
+class CassandraEachRowSubscriber extends DbQuerySubscriber {
+  constructor({ agent, logger, channelName = 'nr_eachRow' }) {
+    super({ agent, logger, channelName, packageName: 'cassandra-driver', system: 'Cassandra' })
+    this.events = ['asyncEnd']
+  }
+
+  handler(data, ctx) {
+    const { self, arguments: args } = data
+    this.queryString = args?.[0]
+    this.setParameters(self)
+    return super.handler(data, ctx)
+  }
+
+  setParameters(self) {
+    this.parameters = {}
+    this.parameters.product = this.system
+    this.parameters.database_name = self?.keyspace
+    this.parameters.host = self?.controlConnection?.connection?.address
+    this.parameters.port_path_or_id = self?.controlConnection?.connection?.port
+  }
+}
+
+module.exports = CassandraEachRowSubscriber

lib/subscribers/cassandra-driver/client-each-row.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const DbQuerySubscriber = require('../db-query')
+
+/**
+ * Subscribes to the `execute` event in `cassandra-driver`
+ * and extracts relevant information from the query.
+ */
+class CassandraExecuteSubscriber extends DbQuerySubscriber {
+  constructor({ agent, logger, channelName = 'nr_execute' }) {
+    super({ agent, logger, channelName, packageName: 'cassandra-driver', system: 'Cassandra' })
+    this.events = ['asyncEnd']
+  }
+
+  handler(data, ctx) {
+    const { self, arguments: args } = data
+    this.queryString = args?.[0]
+    this.setParameters(self)
+    return super.handler(data, ctx)
+  }
+
+  setParameters(self) {
+    this.parameters = {}
+    this.parameters.product = this.system
+    this.parameters.database_name = self?.keyspace
+    this.parameters.host = self?.controlConnection?.connection?.address
+    this.parameters.port_path_or_id = self?.controlConnection?.connection?.port
+  }
+}
+
+module.exports = CassandraExecuteSubscriber

lib/subscribers/cassandra-driver/client-execute.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const DbOperationSubscriber = require('../db-operation')
+
+/**
+ * Subscribes to the `shutdown` event in `cassandra-driver`.
+ */
+class CassandraShutdownSubscriber extends DbOperationSubscriber {
+  constructor({ agent, logger, channelName = 'nr_shutdown' }) {
+    super({ agent, logger, channelName, packageName: 'cassandra-driver', system: 'Cassandra' })
+    this.events = ['asyncStart', 'asyncEnd']
+    this.operation = 'shutdown'
+  }
+
+  handler(data, ctx) {
+    const { self } = data
+    this.setParameters(self)
+    return super.handler(data, ctx)
+  }
+
+  setParameters() {
+    this.parameters = {}
+    this.parameters.product = this.system
+  }
+}
+
+module.exports = CassandraShutdownSubscriber