OpenTelemetry | ScyllaDB Docs

OpenTelemetry¶

The driver provides support for session and node level traces using OpenTelemetry instrumentation.

Including OpenTelemetry instrumentation in your code¶

Add the package Cassandra.OpenTelemetry to the project and add the extension method WithOpenTelemetryInstrumentation() when building your cluster:

var cluster = Cluster.Builder()
    .AddContactPoint(Program.ContactPoint)
    .WithOpenTelemetryInstrumentation()
    .Build();

Once you have your .NET application instrumentation configured, Cassandra activities can be captured by adding the source CassandraActivitySourceHelper.ActivitySourceName in the tracer provider builder:

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource(CassandraActivitySourceHelper.ActivitySourceName)
    ...

You can also find an example in the driver’s Github repository of how to implement distributed tracing with OpenTelemetry and the DataStax C# driver in an ASP.NET Core project.

Attributes¶

The table below displays the list of included attributes in this feature:

Attribute	Description	Output Values
db.namespace	The keyspace name.	keyspace in use
db.operation.name	The type name of the operation being executed.	`Session_Request({RequestType})` for session level calls and `Node_Request({RequestType})` for node level calls
db.query.text	The database statement being executed. Included as optional configuration.	e.g.: `SELECT * FROM system.local`
db.system	An identifier for the database management system (DBMS) product being used.	`cassandra`
server.address	The host node.	e.g.: `127.0.0.1`
server.port	Port number.	e.g.: `9042`

Note that in some cases the driver does not know which keyspace a request is targeting because the driver doesn’t parse CQL query strings.

The console log below displays an example of a full Cassandra activity:

Activity.TraceId:            710e1a99afec9bcd056c9fe825bcbb3c
Activity.SpanId:             bd42cfc78b552cd1
Activity.TraceFlags:         Recorded
Activity.ActivitySourceName: Cassandra.OpenTelemetry
Activity.ActivitySourceVersion: 1.0.0.0
Activity.DisplayName:        Session_Request(SimpleStatement) system
Activity.Kind:               Client
Activity.StartTime:          2024-09-13T14:08:36.9762191Z
Activity.Duration:           00:00:00.0416284
Activity.Tags:
    db.system: cassandra
    db.operation.name: Session_Request(SimpleStatement)
    db.namespace: system
    db.query.text: SELECT * FROM local
Resource associated with Activity:
    service.name: CassandraDemo
    service.version: 1.0.0
    service.instance.id: 5a5d88b9-cc86-4f8a-a206-9b4f507630b9
    telemetry.sdk.name: opentelemetry
    telemetry.sdk.language: dotnet
    telemetry.sdk.version: 1.8.0

Advanced Configuration¶

The instrumentation can be configured to extend the default behavior by using CassandraInstrumentationOptions.

Include Statement as an attribute¶

As mentioned above, the attribute db.query.text is not included by default in the activity. To change it, set the CassandraInstrumentationOptions property IncludeDatabaseStatement as true when building the cluster:

var cluster = Cluster.Builder()
    .AddContactPoint(Program.ContactPoint)
    .AddOpenTelemetryInstrumentation(options => options.IncludeDatabaseStatement = true)
    .Build();

Batch Statement size¶

By default, the OpenTelemetry extension only uses up to 5 child statements of a BatchStatement to generate the db.query.text tag. If you want to change this number, set the CassandraInstrumentationOptions property BatchChildStatementLimit:

var cluster = Cluster.Builder()
    .AddContactPoint(Program.ContactPoint)
    .AddOpenTelemetryInstrumentation(options => options.BatchChildStatementLimit = 10)
    .Build();

Was this page helpful?