# @opentelemetry/instrumentation-cassandra-driver
> OpenTelemetry instrumentation for `cassandra-driver` database client library for Apache Cassandra
Latest version **0.68.0** (published 2026-10-06) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install @opentelemetry/instrumentation-cassandra-driver
pnpm add @opentelemetry/instrumentation-cassandra-driver
yarn add @opentelemetry/instrumentation-cassandra-driver
bun add @opentelemetry/instrumentation-cassandra-driver
```
## Health
**Score 70/100 (B)** — status: active.
Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.
Warnings: low downloads; no esm support; pre 1.0.
## Facts
| | |
|---|---|
| Version | 0.68.0 |
| Published | 2026-10-06 |
| First published | 2021-07-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^18.19.0 \|\| >=20.6.0 |
| Dependencies | 2 |
| Unpacked size | 56.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 931 |
| Author | OpenTelemetry Authors |
| Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba |
| Keywords | cassandra-driver, instrumentation, logging, nodejs, opentelemetry, profiling, tracing |
## Links
- npm: https://www.npmjs.com/package/@opentelemetry/instrumentation-cassandra-driver
- Repository: https://github.com/open-telemetry/opentelemetry-js-contrib
- Homepage: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-cassandra-driver#readme
- Issues: https://github.com/open-telemetry/opentelemetry-js-contrib/issues
- npm.io page: https://npm.io/package/@opentelemetry/instrumentation-cassandra-driver
## Dependencies (2)
- [@opentelemetry/instrumentation](https://npm.io/package/@opentelemetry/instrumentation.md) ^0.223.0
- [@opentelemetry/semantic-conventions](https://npm.io/package/@opentelemetry/semantic-conventions.md) ^1.37.0
## Alternatives
- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads
## Recent versions
- 0.68.0 (latest) — 2026-10-06
- 0.67.0 — 2026-08-31
- 0.66.0 — 2026-07-23
- 0.65.0 — 2026-07-03
- 0.64.0 — 2026-06-11
- 0.63.0 — 2026-05-13
- 0.62.0 — 2026-05-06
- 0.61.0 — 2026-04-29
- 0.60.0 — 2026-04-17
- 0.59.0 — 2026-03-26
- 0.58.0 — 2026-03-04
- 0.57.0 — 2026-02-17
- 0.56.0 — 2026-01-22
- 0.55.0 — 2026-01-15
- 0.54.1 — 2025-12-17
- … 45 more at https://npm.io/package/@opentelemetry/instrumentation-cassandra-driver/versions
## README
# OpenTelemetry instrumentation for cassandra-driver
[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]
This module provides automatic instrumentation for the injection of trace context to [`cassandra-driver`](https://www.npmjs.com/package/cassandra-driver).
If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](https://www.npmjs.com/package/@opentelemetry/sdk-node) for the most seamless instrumentation experience.
Compatible with OpenTelemetry JS API and SDK `1.0+`.
## Installation
```bash
npm install --save @opentelemetry/instrumentation-cassandra-driver
```
### Supported Versions
- [`cassandra-driver`](https://www.npmjs.com/package/cassandra-driver) versions `>=4.4.0 <5`
## Usage
```js
const { NodeSDK } = require('@opentelemetry/sdk-node');
const { CassandraDriverInstrumentation } = require('@opentelemetry/instrumentation-cassandra-driver');
const sdk = new NodeSDK({
instrumentations: [
new CassandraDriverInstrumentation(),
],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });
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 (?)`. |
| `responseHook` | `CassandraDriverResponseCustomAttributeFunction` | `undefined` | Hook for adding custom attributes before response is handled |
| `maxQueryLength` | `number` | `65536` | If `enhancedDatabaseReporting` is enabled, limits the attached query strings to this length. |
## Semantic Conventions
This instrumentation creates spans with attributes from the stable [OpenTelemetry semantic conventions for database client calls](https://opentelemetry.io/docs/specs/semconv/database/database-spans/).
The `instrumentation-cassandra-driver` versions 0.65.0 and later emit the stable v1.33.0+ semantic conventions.
| Attribute | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `db.system.name` | Database system identifier (`cassandra`). |
| `db.query.text` | The database query being executed. Only set when `enhancedDatabaseReporting` is enabled. |
| `db.namespace` | The keyspace being accessed. |
| `server.address` | Remote hostname or similar. |
| `server.port` | Remote port number. |
## 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
[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-cassandra-driver
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-cassandra-driver.svg
---
_Source: https://npm.io/package/@opentelemetry/instrumentation-cassandra-driver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._