semantic-conventions/docs/database/cassandra.md

5.0 KiB

Semantic Conventions for Cassandra

Status: Experimental

The Semantic Conventions for Cassandra extend and override the Database Semantic Conventions that describe common database operations attributes in addition to the Semantic Conventions described on this page.

db.system MUST be set to "cassandra".

Attributes

Attribute Type Description Examples Requirement Level Stability
db.name string The keyspace name in Cassandra. [1] mykeyspace Conditionally Required If applicable. Experimental
db.cassandra.consistency_level string The consistency level of the query. Based on consistency values from CQL. all Recommended Experimental
db.cassandra.coordinator.dc string The data center of the coordinating node for a query. us-west-2 Recommended Experimental
db.cassandra.coordinator.id string The ID of the coordinating node for a query. be13faa2-8574-4d71-926d-27f16cf8a7af Recommended Experimental
db.cassandra.idempotence boolean Whether or not the query is idempotent. Recommended Experimental
db.cassandra.page_size int The fetch size used for paging, i.e. how many rows will be returned at once. 5000 Recommended Experimental
db.cassandra.speculative_execution_count int The number of times a query was speculatively executed. Not set or 0 if the query was not executed speculatively. 0; 2 Recommended Experimental
db.cassandra.table string The name of the primary Cassandra table that the operation is acting upon, including the keyspace name (if applicable). [2] mytable Recommended Experimental
network.peer.address string Peer address of the database node where the operation was performed. [3] 10.1.2.80; /tmp/my.sock Recommended Stable
network.peer.port int Peer port number of the network connection. 65123 Recommended if and only if network.peer.address is set. Stable

[1]: For Cassandra the db.name should be set to the Cassandra keyspace name.

[2]: This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of db.query.text just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.

[3]: If a database operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.

db.cassandra.consistency_level MUST be one of the following:

Value Description Stability
all all Experimental
each_quorum each_quorum Experimental
quorum quorum Experimental
local_quorum local_quorum Experimental
one one Experimental
two two Experimental
three three Experimental
local_one local_one Experimental
any any Experimental
serial serial Experimental
local_serial local_serial Experimental