如何在SpringBoot中实现Cassandra Java Driver可观测性埋点？

一、启用内置Metrics埋点 #

Cassandra Java Driver自带Metrics支持，可通过SpringBoot配置快速开启，同时支持对接Dropwizard或Micrometer（适配Spring生态）。

1. 依赖配置 #

如果使用Micrometer（推荐，适配Spring Boot Actuator），引入以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
<dependency>
    <groupId>com.datastax.oss</groupId>
    <artifactId>java-driver-metrics-micrometer</artifactId>
    <version>${cassandra-driver.version}</version>
</dependency>

若使用Dropwizard Metrics，引入：

<dependency>
    <groupId>io.dropwizard.metrics</groupId>
    <artifactId>metrics-core</artifactId>
</dependency>
<dependency>
    <groupId>com.datastax.oss</groupId>
    <artifactId>java-driver-metrics-dropwizard</artifactId>
    <version>${cassandra-driver.version}</version>
</dependency>

2. 配置文件开启 #

在application.yaml中添加Metrics启用配置：

spring:
  data:
    cassandra:
      contact-points: 127.0.0.1:9042
      local-datacenter: datacenter1
      request:
        metrics:
          enabled: true

如需指定Metrics实现类，可补充Driver原生配置：

datastax-java-driver:
  metrics:
    enabled: true
    factory.class: com.datastax.oss.driver.internal.metrics.micrometer.MicrometerMetricsFactory

二、自定义请求埋点（基于RequestTracker） #

如果需要更灵活的埋点逻辑（比如自定义指标、业务关联埋点），可以实现Driver的RequestTracker接口，拦截请求生命周期。

1. 自定义RequestTracker实现 #

import com.datastax.oss.driver.api.core.context.DriverContext;
import com.datastax.oss.driver.api.core.request.Request;
import com.datastax.oss.driver.api.core.request.RequestTracker;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Component;

import java.util.concurrent.CompletionStage;

@Component
public class CustomCassandraTracker implements RequestTracker {

    private final Counter totalRequests;
    private final Counter errorRequests;

    public CustomCassandraTracker(MeterRegistry meterRegistry) {
        this.totalRequests = meterRegistry.counter("cassandra.requests.total");
        this.errorRequests = meterRegistry.counter("cassandra.requests.errors.total");
    }

    @Override
    public void onRequestStart(Request request, DriverContext context) {
        // 请求开始时计数
        totalRequests.increment();
    }

    @Override
    public void onRequestSuccess(Request request, DriverContext context, long latencyNanos) {
        // 记录成功请求的延迟（单位转换为毫秒）
        context.getMetrics().sessionMetric("requests.latency.success", request.getClass())
                .record(latencyNanos / 1_000_000);
    }

    @Override
    public void onRequestError(Request request, DriverContext context, Throwable error, long latencyNanos) {
        // 错误请求计数 + 记录错误类型
        errorRequests.increment();
        context.getMetrics().sessionCounter("requests.errors.type", error.getClass().getSimpleName())
                .increment();
    }

    @Override
    public CompletionStage<Void> onRequestCompletion(Request request, DriverContext context) {
        return RequestTracker.super.onRequestCompletion(request, context);
    }
}

2. 注册自定义Tracker到CqlSession #

创建配置类，将自定义Tracker注入到CqlSession构建器中：

import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.config.DriverConfigLoader;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class CassandraConfig {

    @Bean
    public CqlSession cqlSession(DriverConfigLoader driverConfigLoader, CustomCassandraTracker tracker) {
        return CqlSession.builder()
                .withConfigLoader(driverConfigLoader)
                .addRequestTracker(tracker)
                .build();
    }
}

三、参考内容 #

• Cassandra Java Driver官方文档：详细说明Metrics模块的配置参数、内置指标（请求数、延迟、连接池状态等），以及自定义Metrics扩展方式
• Spring Data Cassandra官方文档：介绍SpringBoot环境下Cassandra Driver与Micrometer、Actuator的整合方案，包含配置示例和指标暴露方法

内容的提问来源于stack exchange，提问作者enthusiast