README.md

OpenTelemetry instrumentation for cassandra-driver

This module provides automatic instrumentation for injection of trace context to cassandra-driver.

Installation

npm install --save @opentelemetry/instrumentation-cassandra-driver

Usage

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: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.