可觀測性

從應用程式元件獲取有關其操作、時間安排以及與應用程式程式碼關係的資訊，對於理解延遲至關重要。Spring Data Cassandra 透過 Cassandra 驅動程式提供了 Micrometer 儀器，用於在 Cassandra 互動期間收集觀測資料。一旦設定好整合，Micrometer 將為每個 Cassandra 語句建立儀表和跨度（用於分散式跟蹤）。

要啟用儀器，請將以下配置應用於您的應用程式

@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 語句執行。同時，向 `CqlSessionBuilder` 註冊 `ObservationRequestTracker.INSTANCE`。
2	包裝 CQL 會話物件以觀察響應式 Cassandra 語句執行。

ObservableCqlSessionFactoryBean 和 ObservableReactiveSessionFactoryBean 都支援配置 CassandraObservationConvention。

另請參閱 OpenTelemetry 語義約定以獲取更多參考。

約定

您可以在下面找到此專案宣告的所有 GlobalObservabilityConventions 和 ObservabilityConventions 的列表。

表 1. ObservationConvention 實現
ObservationConvention 類名	適用的 ObservationContext 類名
`org.springframework.data.cassandra.observability.DefaultCassandraObservationConvention`	`不適用`

指標

以下是本專案宣告的所有指標列表。

Cassandra 查詢觀測

為基於 Cassandra 的查詢建立 io.micrometer.observation.Observation。

指標名稱 spring.data.cassandra.query。型別 timer，基本單位 seconds。

封閉類的完全限定名稱 org.springframework.data.cassandra.observability.CassandraObservation。

表 2. 低基數鍵
名稱	描述
`db.cassandra.coordinator.dc`
`db.cassandra.coordinator.id`
`db.name`	Cassandra 鍵空間的名稱。
`db.operation`	資料庫操作。
`db.system`	資料庫系統。
`net.peer.name`	資料庫主機名稱。
`net.peer.port`	邏輯遠端埠號。
`net.sock.peer.addr`	Cassandra 對等地址。
`net.sock.peer.port`	Cassandra 對等埠。
`net.transport`	網路傳輸。
`spring.data.cassandra.methodName`	方法名稱
`spring.data.cassandra.sessionName`	Cassandra 會話

表 3. 高基數鍵
名稱	描述
`db.cassandra.consistency_level`
`db.cassandra.idempotence`
`db.cassandra.page_size`
`db.statement`	包含 Cassandra CQL 的鍵值。
`spring.data.cassandra.node[%s].error`	一個包含給定節點發生的錯誤的標籤。（由於名稱包含 `%s`，最終值將在執行時解析）

跨度

以下是本專案宣告的所有 Span 列表。

Cassandra 查詢觀測跨度

為基於 Cassandra 的查詢建立 io.micrometer.observation.Observation。

跨度名稱 spring.data.cassandra.query。

封閉類的完全限定名稱 org.springframework.data.cassandra.observability.CassandraObservation。

表 4. 標籤鍵
名稱	描述
`db.cassandra.consistency_level`
`db.cassandra.coordinator.dc`
`db.cassandra.coordinator.id`
`db.cassandra.idempotence`
`db.cassandra.page_size`
`db.name`	Cassandra 鍵空間的名稱。
`db.operation`	資料庫操作。
`db.statement`	包含 Cassandra CQL 的鍵值。
`db.system`	資料庫系統。
`net.peer.name`	資料庫主機名稱。
`net.peer.port`	邏輯遠端埠號。
`net.sock.peer.addr`	Cassandra 對等地址。
`net.sock.peer.port`	Cassandra 對等埠。
`net.transport`	網路傳輸。
`spring.data.cassandra.methodName`	方法名稱
`spring.data.cassandra.node[%s].error`	一個包含給定節點發生的錯誤的標籤。（由於名稱包含 `%s`，最終值將在執行時解析）
`spring.data.cassandra.sessionName`	Cassandra 會話