diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
index 35f3207bd6..077851b533 100644
--- a/.github/workflows/unit-test.yml
+++ b/.github/workflows/unit-test.yml
@@ -57,7 +57,12 @@ jobs:
--health-interval 10s
--health-timeout 5s
--health-retries 5
+ cassandra:
+ image: bitnami/cassandra:3
+ ports:
+ - 9042:9042
env:
+ RUN_CASSANDRA_TESTS: 1
RUN_MEMCACHED_TESTS: 1
RUN_MONGODB_TESTS: 1
RUN_MYSQL_TESTS: 1
@@ -80,6 +85,8 @@ jobs:
MYSQL_HOST: mysql
MYSQL_PORT: 3306
NPM_CONFIG_UNSAFE_PERM: true
+ CASSANDRA_HOST: cassandra
+ CASSANDRA_PORT: 9042
steps:
- name: Checkout
uses: actions/checkout@v1
diff --git a/packages/opentelemetry-test-utils/testUtils.ts b/packages/opentelemetry-test-utils/testUtils.ts
index 387b0502eb..f508ee977d 100644
--- a/packages/opentelemetry-test-utils/testUtils.ts
+++ b/packages/opentelemetry-test-utils/testUtils.ts
@@ -30,6 +30,8 @@ import {
} from '@opentelemetry/core';
const dockerRunCmds = {
+ cassandra:
+ 'docker run -d -p 9042:9042 --name otel-cassandra bitnami/cassandra:3',
redis: 'docker run --rm -d --name otel-redis -p 63790:6379 redis:alpine',
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 circleci/mysql:5.7',
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/.eslintignore b/plugins/node/opentelemetry-instrumentation-cassandra/.eslintignore
new file mode 100644
index 0000000000..378eac25d3
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/.eslintignore
@@ -0,0 +1 @@
+build
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-cassandra/.eslintrc.js
new file mode 100644
index 0000000000..6aeb0710ef
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/.eslintrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+ "env": {
+ "mocha": true,
+ "node": true
+ },
+ ...require('../../../eslint.config.js'),
+}
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/.npmignore b/plugins/node/opentelemetry-instrumentation-cassandra/.npmignore
new file mode 100644
index 0000000000..9505ba9450
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/.npmignore
@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/LICENSE b/plugins/node/opentelemetry-instrumentation-cassandra/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/README.md b/plugins/node/opentelemetry-instrumentation-cassandra/README.md
new file mode 100644
index 0000000000..16ced4cad4
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/README.md
@@ -0,0 +1,68 @@
+# OpenTelemetry instrumentation for cassandra-driver
+
+[![NPM Published Version][npm-img]][npm-url]
+[![dependencies][dependencies-image]][dependencies-url]
+[![devDependencies][devDependencies-image]][devDependencies-url]
+[![Apache License][license-image]][license-image]
+
+This module provides automatic instrumentation for injection of trace context to [`cassandra-driver`](https://www.npmjs.com/package/cassandra-driver).
+
+## Installation
+
+```bash
+npm install --save @opentelemetry/instrumentation-cassandra-driver
+```
+
+## Usage
+
+```js
+const { NodeTracerProvider } = require('@opentelemetry/node');
+const { CassandraDriverInstrumentation } = require('@opentelemetry/instrumentation-cassandra-driver');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+
+const provider = new NodeTracerProvider();
+provider.register();
+
+registerInstrumentations({
+ instrumentations: [
+ new CassandraDriverInstrumentation(),
+ // other instrumentations
+ ],
+});
+
+const cassandra = require('cassandra-driver');
+const client = new cassandra.Client({ ... });
+await client.execute('select * from foo');
+```
+
+### Instrumentation options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `enhancedDatabaseReporting` | `boolean` | `false` | Whether to include database queries with spans. These can contain sensitive information when using unescaped parameters - i.e. `insert into persons (name) values ('Bob')` instead of `insert into persons (name) values (?)`. |
+| `maxQueryLength` | `number` | `65536` | If `enhancedDatabaseReporting` is enabled, limits the attached query strings
+to this length. |
+
+### Supported versions
+
+`>=4.4 <5.0`
+
+## Useful links
+
+* For more information on OpenTelemetry, visit:
+* For more about OpenTelemetry JavaScript:
+* For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+
+## License
+
+Apache 2.0 - See [LICENSE][license-url] for more information.
+
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
+[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
+[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
+[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-cassandra-driver
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-cassandra-driver
+[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-cassandra-driver&type=dev
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-cassandra-driver&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-cassandra-driver
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-cassandra-driver.svg
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/package.json b/plugins/node/opentelemetry-instrumentation-cassandra/package.json
new file mode 100644
index 0000000000..9033d1ffb6
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/package.json
@@ -0,0 +1,72 @@
+{
+ "name": "@opentelemetry/instrumentation-cassandra-driver",
+ "version": "0.20.0",
+ "description": "OpenTelemetry instrumentation for cassandra-driver",
+ "main": "build/src/index.js",
+ "types": "build/src/index.d.ts",
+ "repository": "open-telemetry/opentelemetry-js-contrib",
+ "scripts": {
+ "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
+ "tdd": "npm run test -- --watch-extensions ts --watch",
+ "clean": "rimraf build/*",
+ "lint": "eslint . --ext .ts",
+ "lint:fix": "eslint . --ext .ts --fix",
+ "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+ "precompile": "tsc --version",
+ "prepare": "npm run compile",
+ "version:update": "node ../../../scripts/version-update.js",
+ "compile": "npm run version:update && tsc -p ."
+ },
+ "keywords": [
+ "opentelemetry",
+ "logging",
+ "nodejs",
+ "tracing",
+ "profiling",
+ "instrumentation",
+ "cassandra-driver"
+ ],
+ "author": "OpenTelemetry Authors",
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=8.5.0"
+ },
+ "files": [
+ "build/src/**/*.js",
+ "build/src/**/*.d.ts",
+ "doc",
+ "LICENSE",
+ "README.md"
+ ],
+ "publishConfig": {
+ "access": "public"
+ },
+ "peerDependencies": {
+ "@opentelemetry/api": "^1.0.1"
+ },
+ "devDependencies": {
+ "@opentelemetry/api": "1.0.1",
+ "@opentelemetry/context-async-hooks": "0.22.0",
+ "@opentelemetry/node": "0.22.0",
+ "@opentelemetry/test-utils": "0.22.0",
+ "@opentelemetry/tracing": "0.22.0",
+ "@types/mocha": "7.0.2",
+ "@types/node": "14.17.2",
+ "@types/semver": "7.3.6",
+ "@types/sinon": "10.0.2",
+ "codecov": "3.8.2",
+ "gts": "3.1.0",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "3.0.2",
+ "sinon": "9.2.4",
+ "ts-mocha": "8.0.0",
+ "ts-node": "9.1.1",
+ "typescript": "4.3.2",
+ "cassandra-driver": "4.6.3"
+ },
+ "dependencies": {
+ "@opentelemetry/instrumentation": "^0.22.0",
+ "@opentelemetry/semantic-conventions": "^0.22.0"
+ }
+}
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/src/index.ts b/plugins/node/opentelemetry-instrumentation-cassandra/src/index.ts
new file mode 100644
index 0000000000..175fc1f262
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/src/index.ts
@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './instrumentation';
+export { CassandraDriverInstrumentationConfig } from './types';
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-cassandra/src/instrumentation.ts
new file mode 100644
index 0000000000..0a04570309
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/src/instrumentation.ts
@@ -0,0 +1,362 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+ context,
+ trace,
+ Span,
+ SpanAttributes,
+ SpanKind,
+ SpanStatusCode,
+} from '@opentelemetry/api';
+import {
+ InstrumentationBase,
+ InstrumentationNodeModuleDefinition,
+ InstrumentationNodeModuleFile,
+ isWrapped,
+ safeExecuteInTheMiddle,
+} from '@opentelemetry/instrumentation';
+import { CassandraDriverInstrumentationConfig } from './types';
+import {
+ SemanticAttributes,
+ DbSystemValues,
+} from '@opentelemetry/semantic-conventions';
+import { VERSION } from './version';
+import { EventEmitter } from 'events';
+import type * as CassandraDriver from 'cassandra-driver';
+
+const supportedVersions = ['>=4.4 <5.0'];
+
+export class CassandraDriverInstrumentation extends InstrumentationBase {
+ constructor(config: CassandraDriverInstrumentationConfig = {}) {
+ super('@opentelemetry/instrumentation-cassandra-driver', VERSION, config);
+ }
+
+ protected init() {
+ return new InstrumentationNodeModuleDefinition(
+ 'cassandra-driver',
+ supportedVersions,
+ driverModule => {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ const Client = driverModule.Client.prototype as any;
+
+ if (isWrapped(Client['_execute'])) {
+ this._unwrap(Client, '_execute');
+ }
+
+ if (isWrapped(Client.batch)) {
+ this._unwrap(Client, 'batch');
+ }
+
+ if (isWrapped(Client.stream)) {
+ this._unwrap(Client, 'stream');
+ }
+
+ this._wrap(Client, '_execute', this._getPatchedExecute());
+ this._wrap(Client, 'batch', this._getPatchedBatch());
+ this._wrap(Client, 'stream', this._getPatchedStream());
+
+ return driverModule;
+ },
+ driverModule => {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ const Client = driverModule.Client.prototype as any;
+
+ if (isWrapped(Client['_execute'])) {
+ this._unwrap(Client, '_execute');
+ }
+
+ if (isWrapped(Client.batch)) {
+ this._unwrap(Client, 'batch');
+ }
+
+ if (isWrapped(Client.stream)) {
+ this._unwrap(Client, 'stream');
+ }
+ },
+ [
+ new InstrumentationNodeModuleFile(
+ 'cassandra-driver/lib/request-execution.js',
+ supportedVersions,
+ execution => {
+ if (isWrapped(execution.prototype['_sendOnConnection'])) {
+ this._unwrap(execution.prototype, '_sendOnConnection');
+ }
+
+ this._wrap(
+ execution.prototype,
+ '_sendOnConnection',
+ this._getPatchedSendOnConnection()
+ );
+ return execution;
+ },
+ execution => {
+ if (execution === undefined) return;
+ this._unwrap(execution.prototype, '_sendOnConnection');
+ }
+ ),
+ ]
+ );
+ }
+
+ private _getMaxQueryLength(): number {
+ const config = this.getConfig() as CassandraDriverInstrumentationConfig;
+ return config.maxQueryLength ?? 65536;
+ }
+
+ private _shouldIncludeDbStatement(): boolean {
+ const config = this.getConfig() as CassandraDriverInstrumentationConfig;
+ return config.enhancedDatabaseReporting ?? false;
+ }
+
+ private _getPatchedExecute() {
+ return (
+ original: (...args: unknown[]) => Promise
+ ) => {
+ const plugin = this;
+ return function patchedExecute(
+ this: CassandraDriver.Client,
+ ...args: unknown[]
+ ) {
+ const span = plugin.startSpan({ op: 'execute', query: args[0] }, this);
+
+ const execContext = trace.setSpan(context.active(), span);
+ const execPromise = safeExecuteInTheMiddle(
+ () => {
+ return context.with(execContext, () => {
+ return original.apply(this, args);
+ });
+ },
+ error => {
+ if (error) {
+ failSpan(span, error);
+ }
+ }
+ );
+
+ const wrappedPromise = wrapPromise(span, execPromise);
+
+ return context.bind(execContext, wrappedPromise);
+ };
+ };
+ }
+
+ private _getPatchedSendOnConnection() {
+ return (original: (...args: unknown[]) => unknown) => {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ return function patchedSendOnConnection(this: any, ...args: unknown[]) {
+ const span = trace.getSpan(context.active());
+ const conn = this['_connection'];
+
+ if (span !== undefined && conn !== undefined) {
+ const port = parseInt(conn.port, 10);
+
+ span.setAttribute(SemanticAttributes.NET_PEER_NAME, conn.address);
+
+ if (!isNaN(port)) {
+ span.setAttribute(SemanticAttributes.NET_PEER_PORT, port);
+ }
+ }
+
+ return original.apply(this, args);
+ };
+ };
+ }
+
+ private _getPatchedBatch() {
+ return (original: (...args: unknown[]) => unknown) => {
+ const plugin = this;
+ return function patchedBatch(
+ this: CassandraDriver.Client,
+ ...args: unknown[]
+ ) {
+ const queries = Array.isArray(args[0]) ? args[0] : [];
+ const span = plugin.startSpan(
+ { op: 'batch', query: combineQueries(queries) },
+ this
+ );
+
+ const batchContext = trace.setSpan(context.active(), span);
+
+ if (typeof args[args.length - 1] === 'function') {
+ const originalCallback = args[
+ args.length - 1
+ ] as CassandraDriver.ValueCallback;
+
+ const patchedCallback = function (
+ this: unknown,
+ ...cbArgs: Parameters
+ ) {
+ const error = cbArgs[0];
+
+ if (error) {
+ span.setStatus({
+ code: SpanStatusCode.ERROR,
+ message: error.message,
+ });
+ span.recordException(error);
+ }
+
+ span.end();
+
+ return originalCallback.apply(this, cbArgs);
+ };
+
+ args[args.length - 1] = patchedCallback;
+
+ return context.with(batchContext, () => {
+ return original.apply(this, args);
+ });
+ }
+
+ const batchPromise = safeExecuteInTheMiddle(
+ () => {
+ return original.apply(
+ this,
+ args
+ ) as Promise;
+ },
+ error => {
+ if (error) {
+ failSpan(span, error);
+ }
+ }
+ );
+
+ const wrappedPromise = wrapPromise(span, batchPromise);
+
+ return context.bind(batchContext, wrappedPromise);
+ };
+ };
+ }
+
+ private _getPatchedStream() {
+ return (original: (...args: unknown[]) => EventEmitter) => {
+ const plugin = this;
+ return function patchedStream(
+ this: CassandraDriver.Client,
+ ...args: unknown[]
+ ) {
+ // Since stream internally uses execute, there is no need to add DB_STATEMENT twice
+ const span = plugin.startSpan({ op: 'stream' }, this);
+
+ const callback = args[3];
+
+ const endSpan = (error: Error) => {
+ if (error) {
+ span.setStatus({
+ code: SpanStatusCode.ERROR,
+ message: error.message,
+ });
+ span.recordException(error);
+ }
+ span.end();
+ };
+
+ if (callback === undefined) {
+ args[3] = endSpan;
+ } else if (typeof callback === 'function') {
+ const wrappedCallback = function (this: unknown, err: Error) {
+ endSpan(err);
+ return callback.call(this, err);
+ };
+ args[3] = wrappedCallback;
+ }
+
+ return safeExecuteInTheMiddle(
+ () => {
+ return original.apply(this, args);
+ },
+ error => {
+ if (error) {
+ failSpan(span, error);
+ }
+ }
+ );
+ };
+ };
+ }
+
+ public startSpan(
+ { op, query }: { op: string; query?: unknown },
+ client: CassandraDriver.Client
+ ): Span {
+ const attributes: SpanAttributes = {
+ [SemanticAttributes.DB_SYSTEM]: DbSystemValues.CASSANDRA,
+ };
+
+ if (this._shouldIncludeDbStatement() && query !== undefined) {
+ const statement = truncateQuery(query, this._getMaxQueryLength());
+ attributes[SemanticAttributes.DB_STATEMENT] = statement;
+ }
+
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ const user = (client as any).options?.credentials?.username;
+
+ if (user) {
+ attributes[SemanticAttributes.DB_USER] = user;
+ }
+
+ if (client.keyspace) {
+ attributes[SemanticAttributes.DB_NAME] = client.keyspace;
+ }
+
+ return this.tracer.startSpan(`cassandra-driver.${op}`, {
+ kind: SpanKind.CLIENT,
+ attributes,
+ });
+ }
+}
+
+function failSpan(span: Span, error: Error) {
+ span.setStatus({
+ code: SpanStatusCode.ERROR,
+ message: error.message,
+ });
+ span.recordException(error);
+ span.end();
+}
+
+function combineQueries(queries: Array) {
+ return queries
+ .map(query => (typeof query === 'string' ? query : query.query))
+ .join('\n');
+}
+
+function wrapPromise(span: Span, promise: Promise): Promise {
+ return promise
+ .then(result => {
+ return new Promise(resolve => {
+ span.end();
+ resolve(result);
+ });
+ })
+ .catch((error: Error) => {
+ return new Promise((_, reject) => {
+ span.setStatus({
+ code: SpanStatusCode.ERROR,
+ message: error.message,
+ });
+ span.recordException(error);
+ span.end();
+ reject(error);
+ });
+ });
+}
+
+function truncateQuery(query: unknown, maxQueryLength: number) {
+ return String(query).substr(0, maxQueryLength);
+}
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/src/types.ts b/plugins/node/opentelemetry-instrumentation-cassandra/src/types.ts
new file mode 100644
index 0000000000..eff54d1786
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/src/types.ts
@@ -0,0 +1,32 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { InstrumentationConfig } from '@opentelemetry/instrumentation';
+
+export interface CassandraDriverInstrumentationConfig
+ extends InstrumentationConfig {
+ /**
+ * Include database statements with spans.
+ * These can contain sensitive information when using unescaped queries.
+ * @default false
+ */
+ enhancedDatabaseReporting?: boolean;
+ /**
+ * Max recorded query length.
+ * @default 65536
+ */
+ maxQueryLength?: number;
+}
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/src/version.ts b/plugins/node/opentelemetry-instrumentation-cassandra/src/version.ts
new file mode 100644
index 0000000000..a14ba6ef88
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/src/version.ts
@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// this is autogenerated file, see scripts/version-update.js
+export const VERSION = '0.20.0';
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/test/cassandra-driver.test.ts b/plugins/node/opentelemetry-instrumentation-cassandra/test/cassandra-driver.test.ts
new file mode 100644
index 0000000000..e4c96d1493
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/test/cassandra-driver.test.ts
@@ -0,0 +1,319 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+ InMemorySpanExporter,
+ SimpleSpanProcessor,
+ ReadableSpan,
+} from '@opentelemetry/tracing';
+import {
+ context,
+ SpanKind,
+ SpanStatus,
+ SpanStatusCode,
+} from '@opentelemetry/api';
+import { NodeTracerProvider } from '@opentelemetry/node';
+import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
+import {
+ SemanticAttributes,
+ DbSystemValues,
+} from '@opentelemetry/semantic-conventions';
+import * as assert from 'assert';
+import * as testUtils from '@opentelemetry/test-utils';
+import type * as CassandraDriver from 'cassandra-driver';
+import {
+ CassandraDriverInstrumentation,
+ CassandraDriverInstrumentationConfig,
+} from '../src';
+
+const memoryExporter = new InMemorySpanExporter();
+const provider = new NodeTracerProvider();
+provider.addSpanProcessor(new SimpleSpanProcessor(memoryExporter));
+context.setGlobalContextManager(new AsyncHooksContextManager());
+
+const testCassandra = process.env.RUN_CASSANDRA_TESTS;
+const testCassandraLocally = process.env.RUN_CASSANDRA_TESTS_LOCAL;
+const shouldTest = testCassandra || testCassandraLocally;
+const cassandraTimeoutMs = 60000;
+
+function assertSpan(
+ span: ReadableSpan,
+ name: string,
+ query?: string,
+ status?: SpanStatus
+) {
+ const attributes = {
+ [SemanticAttributes.DB_SYSTEM]: DbSystemValues.CASSANDRA,
+ [SemanticAttributes.DB_USER]: 'cassandra',
+ };
+
+ if (query !== undefined) {
+ attributes[SemanticAttributes.DB_STATEMENT] = query;
+ }
+
+ const spanStatus =
+ status === undefined ? { code: SpanStatusCode.UNSET } : status;
+ testUtils.assertSpan(span, SpanKind.CLIENT, attributes, [], spanStatus);
+}
+
+function assertSingleSpan(name: string, query?: string, status?: SpanStatus) {
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ const [span] = spans;
+ assertSpan(span, name, query, status);
+}
+
+function assertErrorSpan(
+ name: string,
+ error: Error & { code?: number },
+ query?: string
+) {
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ const [span] = spans;
+
+ const attributes = {
+ [SemanticAttributes.DB_SYSTEM]: DbSystemValues.CASSANDRA,
+ [SemanticAttributes.DB_USER]: 'cassandra',
+ };
+
+ if (query !== undefined) {
+ attributes[SemanticAttributes.DB_STATEMENT] = query;
+ }
+
+ const events = [
+ {
+ name: 'exception',
+ attributes: {
+ [SemanticAttributes.EXCEPTION_STACKTRACE]: error.stack,
+ [SemanticAttributes.EXCEPTION_MESSAGE]: error.message,
+ [SemanticAttributes.EXCEPTION_TYPE]: String(error.code),
+ },
+ time: span.events[0].time,
+ },
+ ];
+
+ const status = {
+ code: SpanStatusCode.ERROR,
+ message: error.message,
+ };
+
+ testUtils.assertSpan(span, SpanKind.CLIENT, attributes, events, status);
+}
+
+describe('CassandraDriverInstrumentation', () => {
+ let client: CassandraDriver.Client;
+ let instrumentation: CassandraDriverInstrumentation;
+
+ before(async function () {
+ if (!shouldTest) {
+ this.skip();
+ }
+
+ // Cassandra takes a long time to boot up - 20 seconds easily.
+ this.timeout(cassandraTimeoutMs);
+
+ if (testCassandraLocally) {
+ testUtils.startDocker('cassandra');
+ }
+
+ instrumentation = new CassandraDriverInstrumentation();
+ instrumentation.setTracerProvider(provider);
+
+ const cassandra = require('cassandra-driver');
+ const endpoint = testCassandraLocally ? '127.0.0.1' : 'cassandra';
+ client = new cassandra.Client({
+ contactPoints: [endpoint],
+ localDataCenter: 'datacenter1',
+ credentials: {
+ username: 'cassandra',
+ password: 'cassandra',
+ },
+ });
+
+ // Since Cassandra boots up for a while, the connects might timeout, hence the retries.
+ for (let attempt = 0; attempt < 5; attempt++) {
+ try {
+ await client.connect();
+ break;
+ } catch (e) {}
+ }
+
+ await client.execute(
+ "CREATE KEYSPACE IF NOT EXISTS ot WITH REPLICATION = { 'class': 'SimpleStrategy', 'replication_factor': '1' }"
+ );
+ await client.execute(
+ 'CREATE TABLE IF NOT EXISTS ot.test (userid TEXT PRIMARY KEY, count int)'
+ );
+ });
+
+ after(async function () {
+ this.timeout(60000);
+ await client.shutdown();
+ if (testCassandraLocally) {
+ testUtils.cleanUpDocker('cassandra');
+ }
+ });
+
+ describe('execute', () => {
+ beforeEach(() => {
+ memoryExporter.reset();
+ });
+
+ it('creates a span for promise based execute', async () => {
+ await client.execute('select * from ot.test');
+ assertSingleSpan('cassandra-driver.execute');
+ });
+
+ it('creates a span for callback based execute', done => {
+ client.execute('select * from ot.test', () => {
+ assertSingleSpan('cassandra-driver.execute');
+ done();
+ });
+ });
+
+ it('creates an error span', async () => {
+ try {
+ await client.execute('selec * from');
+ } catch (e) {
+ assertErrorSpan('cassandra-driver.execute', e);
+ return;
+ }
+
+ assert.fail();
+ });
+
+ describe('statements', () => {
+ before(() => {
+ const config: CassandraDriverInstrumentationConfig = {
+ maxQueryLength: 25,
+ enhancedDatabaseReporting: true,
+ };
+ instrumentation.setConfig(config);
+ });
+
+ after(() => {
+ const config: CassandraDriverInstrumentationConfig = {
+ maxQueryLength: 65536,
+ enhancedDatabaseReporting: false,
+ };
+ instrumentation.setConfig(config);
+ });
+
+ it('retains statements', async () => {
+ const query = 'select * from ot.test';
+ await client.execute(query);
+ assertSingleSpan('cassandra-driver.execute', query);
+ });
+
+ it('truncates long queries', async () => {
+ const query = 'select userid, count from ot.test';
+ await client.execute(query);
+ assertSingleSpan('cassandra-driver.execute', query.substr(0, 25));
+ });
+ });
+ });
+
+ describe('batch', () => {
+ beforeEach(() => {
+ memoryExporter.reset();
+ });
+
+ const q1 = "insert into ot.test (userid, count) values ('1234', 42)";
+ const q2 = "insert into ot.test (userid, count) values ('3421', 10)";
+ const combined = `${q1}\n${q2}`;
+
+ it('creates a span for promise based batch', async () => {
+ await client.batch([q1, q2]);
+ assertSingleSpan('cassandra-driver.batch');
+ });
+
+ it('creates a span for callback based batch', done => {
+ client.batch([q1, q2], () => {
+ assertSingleSpan('cassandra-driver.batch');
+ done();
+ });
+ });
+
+ it('creates an error span', async () => {
+ const query = 'insert into foobar';
+ try {
+ await client.batch([query]);
+ } catch (e) {
+ assertErrorSpan('cassandra-driver.batch', e);
+ return;
+ }
+
+ assert.fail();
+ });
+
+ describe('statements', () => {
+ before(() => {
+ const config: CassandraDriverInstrumentationConfig = {
+ enhancedDatabaseReporting: true,
+ };
+ instrumentation.setConfig(config);
+ });
+
+ after(() => {
+ const config: CassandraDriverInstrumentationConfig = {
+ enhancedDatabaseReporting: false,
+ };
+ instrumentation.setConfig(config);
+ });
+
+ it('attaches combined statement', async () => {
+ await client.batch([q1, q2]);
+ assertSingleSpan('cassandra-driver.batch', combined);
+ });
+ });
+ });
+
+ describe('stream', () => {
+ beforeEach(() => {
+ memoryExporter.reset();
+ });
+
+ const query = 'select * from ot.test';
+
+ function assertStreamSpans() {
+ const spans = memoryExporter.getFinishedSpans();
+ // stream internally uses execute
+ assert.strictEqual(spans.length, 2);
+ assertSpan(spans[0], 'cassandra-driver.execute');
+ assertSpan(spans[1], 'cassandra-driver.stream');
+ }
+
+ it('creates a span for a stream call', done => {
+ const emitter = client.stream(query);
+ emitter.on('readable', function (this: any) {
+ while (this.read()) {}
+ });
+ emitter.on('error', e => assert.fail(e));
+ emitter.on('end', () => {
+ assertStreamSpans();
+ done();
+ });
+ });
+
+ it('creates a span for stream call with a callback', done => {
+ client.stream(query, undefined, undefined, () => {
+ assertStreamSpans();
+ done();
+ });
+ });
+ });
+});
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/tsconfig.json b/plugins/node/opentelemetry-instrumentation-cassandra/tsconfig.json
new file mode 100644
index 0000000000..28be80d266
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-cassandra/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "../../../tsconfig.base",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "src/**/*.ts",
+ "test/**/*.ts"
+ ]
+}