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.collection.name	string	The name of the Cassandra table that the operation is acting upon. [1]	public.users; customers	Conditionally Required [2]
db.namespace	string	The Cassandra keyspace name. [3]	mykeyspace	Conditionally Required If available.
db.operation.name	string	The name of the operation or command being executed. [4]	findAndModify; HMSET; SELECT	Conditionally Required [5]
error.type	string	Describes a class of error the operation ended with. [6]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If and only if the operation failed.
server.port	int	Server port number. [7]	80; 8080; 443	Conditionally Required [8]
db.cassandra.consistency_level	string	The consistency level of the query. Based on consistency values from CQL.	all; each_quorum; quorum	Recommended
db.cassandra.coordinator.dc	string	The data center of the coordinating node for a query.	us-west-2	Recommended
db.cassandra.coordinator.id	string	The ID of the coordinating node for a query.	be13faa2-8574-4d71-926d-27f16cf8a7af	Recommended
db.cassandra.idempotence	boolean	Whether or not the query is idempotent.		Recommended
db.cassandra.page_size	int	The fetch size used for paging, i.e. how many rows will be returned at once.	5000	Recommended
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
db.query.text	string	The database query being executed.	SELECT * FROM wuser_table where username = ?; SET mykey "WuValue"	Recommended [9]
network.peer.address	string	Peer address of the database node where the operation was performed. [10]	10.1.2.80; /tmp/my.sock	Recommended
network.peer.port	int	Peer port number of the network connection.	65123	Recommended if and only if network.peer.address is set.
server.address	string	Name of the database host. [11]	example.com; 10.1.2.80; /tmp/my.sock	Recommended
db.query.parameter.<key>	string	The query parameters used in db.query.text, with <key> being the parameter name, and the attribute value being the parameter value. [12]	someval; 55	Opt-In

[1]: If the collection name is parsed from the query, it SHOULD match the value provided in the query and may be qualified with the schema and database name. It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

[2]: If readily available. Otherwise, if the instrumentation library parses db.query.text to capture db.collection.name, then it SHOULD be the first collection name found in the query.

[3]: For commands that switch the keyspace, this SHOULD be set to the target keyspace (even if the command fails).

[4]: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

[5]: If readily available. Otherwise, if the instrumentation library parses db.query.text to capture db.operation.name, then it SHOULD be the first operation name found in the query.

[6]: The error.type SHOULD match the error code returned by the database or the client library, the canonical name of exception that occurred, or another low-cardinality error identifier. Instrumentations SHOULD document the list of errors they report.

[7]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.

[8]: If using a port other than the default port for this DBMS and if server.address is set.

[9]: SHOULD be collected by default only if there is sanitization that excludes sensitive information.

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

[11]: When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it’s available.

[12]: Query parameters should only be captured when db.query.text is parameterized with placeholders. If a parameter has no name and instead is referenced only by index, then <key> SHOULD be the 0-based index.

db.cassandra.consistency_level has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn’t define a custom value.