👁 Image
OpenTelemetry.Instrumentation.Cassandra 1.0.0-beta.6

Cassandra Instrumentation for OpenTelemetry

👁 NuGet version badge
👁 NuGet download count badge
👁 codecov.io

This is an Instrumentation Library, which instruments CassandraCSharpDriver and collects telemetry about cassandra metrics.

Steps to enable OpenTelemetry.Instrumentation.Cassandra

Step 1: Install Package

Add a reference to the OpenTelemetry.Instrumentation.Cassandra package. Also, add any other instrumentations & exporters you will need.

dotnet add package OpenTelemetry.Instrumentation.Cassandra

Step 2: Enable Cassandra Instrumentation at application startup

Cassandra instrumentation must be enabled at application startup.

The following example demonstrates adding Cassandra instrumentation to a console application. This example also sets up the OpenTelemetry Console exporter, which requires adding the package OpenTelemetry.Exporter.Console to the application.

using OpenTelemetry.Trace;

public class Program
{
 public static void Main(string[] args)
 {
 using var metricProvider = Sdk.CreateMeterProviderBuilder()
 .AddCassandraInstrumentation()
 .AddConsoleExporter()
 .Build();

 var cluster = new Builder()
 .WithConnectionString(yourCassandraConnectionString)
 .WithOpenTelemetryMetrics()
 .Build();
 }
}

For an ASP.NET Core application, adding instrumentation is typically done in the ConfigureServices of your Startup class. Refer to documentation for OpenTelemetry.Instrumentation.AspNetCore.

For an ASP.NET application, adding instrumentation is typically done in the Global.asax.cs. Refer to documentation for OpenTelemetry.Instrumentation.AspNet.

Configuration options

You are able to configure your own cassandra driver metrics options in WithOpenTelemetryMetrics the by default configuration includes all the metrics that the driver can provide.

var options = new DriverMetricsOptions();

options.SetEnabledNodeMetrics(new[] {NodeMetric.Gauges.InFlight});

var cluster = new Builder()
 .WithConnectionString(yourCassandraConnectionString)
 .WithOpenTelemetryMetrics(options)
 .Build();

List of metrics produced

References

• OpenTelemetry Project

• OpenTelemetry semantic conventions for Cassandra

• Cassandra C# Driver