对于最新的稳定版本,请使用 Spring Data Cassandra 5.0.4spring-doc.cadn.net.cn

可观测性

从应用程序组件获取有关其操作、耗时以及与应用程序代码关联的洞察信息,对于理解延迟至关重要。 Spring Data Cassandra 通过 Cassandra 驱动程序内置了 Micrometer 仪器化功能,用于在与 Cassandra 交互过程中收集观测数据。 一旦完成集成设置,Micrometer 将为每个 Cassandra 语句创建指标(meters)和跨度(spans,用于分布式追踪)。spring-doc.cadn.net.cn

要启用该检测功能,请将以下配置应用到您的应用程序中:spring-doc.cadn.net.cn

@Configuration
class ObservabilityConfiguration {

  @Bean
  public ObservableCqlSessionFactoryBean observableCqlSession(CqlSessionBuilder builder,
                                                              ObservationRegistry registry) {
    return new ObservableCqlSessionFactoryBean(builder, registry); (1)
  }

  @Bean
  public ObservableReactiveSessionFactoryBean observableReactiveSession(CqlSession session,
                                                              ObservationRegistry registry) {
    return new ObservableReactiveSessionFactoryBean(session, registry); (2)
  }
}
1 包装 CQL 会话对象以观察 Cassandra 语句的执行。 同时,将 ObservationRequestTracker.INSTANCE 注册到 CqlSessionBuilder 中。
2 包装一个 CQL 会话对象,用于观察响应式 Cassandra 语句的执行。

另请参阅OpenTelemetry 语义约定以获取更多参考信息。spring-doc.cadn.net.cn

约定

以下列出了本项目声明的所有 GlobalObservabilityConventionsObservabilityConventionsspring-doc.cadn.net.cn

表1. ObservationConvention 实现

ObservationConvention 类名spring-doc.cadn.net.cn

适用的 ObservationContext 类名spring-doc.cadn.net.cn

org.springframework.data.cassandra.observability.DefaultCassandraObservationConventionspring-doc.cadn.net.cn

n/aspring-doc.cadn.net.cn

指标

以下列出了本项目声明的所有指标。spring-doc.cadn.net.cn

Cassandra 查询观测

为基于 Cassandra 的查询创建一个 io.micrometer.observation.Observationspring-doc.cadn.net.cn

指标名称 spring.data.cassandra.query类型 timer基本单位 secondsspring-doc.cadn.net.cn

封闭类 org.springframework.data.cassandra.observability.CassandraObservation 的全限定名。spring-doc.cadn.net.cn

表2. 低基数键

db.cassandra.coordinator.dcspring-doc.cadn.net.cn

db.cassandra.coordinator.idspring-doc.cadn.net.cn

Cassandra keyspace 的名称。spring-doc.cadn.net.cn

数据库操作。spring-doc.cadn.net.cn

数据库系统。spring-doc.cadn.net.cn

net.peer.namespring-doc.cadn.net.cn

数据库主机的名称。spring-doc.cadn.net.cn

net.peer.portspring-doc.cadn.net.cn

逻辑远程端口号。spring-doc.cadn.net.cn

net.sock.peer.addrspring-doc.cadn.net.cn

Cassandra 对等节点地址。spring-doc.cadn.net.cn

net.sock.peer.portspring-doc.cadn.net.cn

Cassandra 对等端口。spring-doc.cadn.net.cn

net.transportspring-doc.cadn.net.cn

网络传输。spring-doc.cadn.net.cn

spring.data.cassandra.methodNamespring-doc.cadn.net.cn

spring.data.cassandra.sessionNamespring-doc.cadn.net.cn

Cassandra 会话spring-doc.cadn.net.cn

表3. 高基数键

db.cassandra.consistency_levelspring-doc.cadn.net.cn

db.cassandra.idempotencespring-doc.cadn.net.cn

db.cassandra.page_sizespring-doc.cadn.net.cn

一个包含 Cassandra CQL 的键值对。spring-doc.cadn.net.cn

spring.data.cassandra.node[%s].errorspring-doc.cadn.net.cn

一个包含给定节点所发生错误的标签。(由于名称中包含%s,最终值将在运行时解析)spring-doc.cadn.net.cn

跨度

以下列出了本项目声明的所有 span。spring-doc.cadn.net.cn

Cassandra 查询观测跨度

为基于 Cassandra 的查询创建一个 io.micrometer.observation.Observationspring-doc.cadn.net.cn

Span 名称 spring.data.cassandra.queryspring-doc.cadn.net.cn

封闭类 org.springframework.data.cassandra.observability.CassandraObservation 的全限定名。spring-doc.cadn.net.cn

表4. 标签键

姓名spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

db.cassandra.consistency_levelspring-doc.cadn.net.cn

db.cassandra.coordinator.dcspring-doc.cadn.net.cn

db.cassandra.coordinator.idspring-doc.cadn.net.cn

db.cassandra.idempotencespring-doc.cadn.net.cn

db.cassandra.page_sizespring-doc.cadn.net.cn

db.namespring-doc.cadn.net.cn

Cassandra keyspace 的名称。spring-doc.cadn.net.cn

db.operationspring-doc.cadn.net.cn

数据库操作。spring-doc.cadn.net.cn

db.statementspring-doc.cadn.net.cn

一个包含 Cassandra CQL 的键值对。spring-doc.cadn.net.cn

db.systemspring-doc.cadn.net.cn

数据库系统。spring-doc.cadn.net.cn

net.peer.namespring-doc.cadn.net.cn

数据库主机的名称。spring-doc.cadn.net.cn

net.peer.portspring-doc.cadn.net.cn

逻辑远程端口号。spring-doc.cadn.net.cn

net.sock.peer.addrspring-doc.cadn.net.cn

Cassandra 对等节点地址。spring-doc.cadn.net.cn

net.sock.peer.portspring-doc.cadn.net.cn

Cassandra 对等端口。spring-doc.cadn.net.cn

net.transportspring-doc.cadn.net.cn

网络传输。spring-doc.cadn.net.cn

spring.data.cassandra.methodNamespring-doc.cadn.net.cn

方法名称spring-doc.cadn.net.cn

spring.data.cassandra.node[%s].errorspring-doc.cadn.net.cn

一个包含给定节点所发生错误的标签。(由于名称中包含%s,最终值将在运行时解析)spring-doc.cadn.net.cn

spring.data.cassandra.sessionNamespring-doc.cadn.net.cn

Cassandra 会话spring-doc.cadn.net.cn