Skip to content

Latest commit

 

History

History
116 lines (83 loc) · 10.7 KB

cassandra.md

File metadata and controls

116 lines (83 loc) · 10.7 KB
Raw

Semantic Conventions for Cassandra

Status: Experimental

The Semantic Conventions for Cassandra extend and override the Database Semantic Conventions.

db.system MUST be set to "cassandra" and SHOULD be provided at span creation time.

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] Experimental
db.namespace string The Cassandra keyspace name. [3] mykeyspace Conditionally Required If available. Experimental
db.operation.name string The name of the operation or command being executed. [4] findAndModify; HMSET; SELECT Conditionally Required [5] Experimental
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. Stable
server.port int Server port number. [7] 80; 8080; 443 Conditionally Required [8] Stable
db.cassandra.consistency_level string The consistency level of the query. Based on consistency values from CQL. all; each_quorum; quorum 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.query.text string The database query being executed. [9] SELECT * FROM wuser_table where username = ?; SET mykey "WuValue" Recommended [10] Experimental
network.peer.address string Peer address of the database node where the operation was performed. [11] 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
server.address string Name of the database host. [12] example.com; 10.1.2.80; /tmp/my.sock Recommended Stable
db.query.parameter.<key> string A query parameter used in db.query.text, with <key> being the parameter name, and the attribute value being a string representation of the parameter value. [13] someval; 55 Opt-In Experimental

[1]: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. If the collection name is parsed from the query text, it SHOULD be the first collection name found in the query and it SHOULD match the value provided in the query text including any schema and database name prefix. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used, otherwise db.collection.name SHOULD NOT be captured.

[2]: If readily available. The collection name MAY be parsed from the query text, in which case 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. If the operation name is parsed from the query text, it SHOULD be the first operation name found in the query. For batch operations, if the individual operations are known to have the same operation name then that operation name SHOULD be used prepended by BATCH , otherwise db.operation.name SHOULD be BATCH or some other database system specific term if more applicable.

[5]: If readily available. The operation name MAY be parsed from the query text, in which case 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]: For sanitization see Sanitization of db.query.text. For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator ; or some other database system specific separator if more applicable. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.

[10]: SHOULD be collected by default only if there is sanitization that excludes sensitive information. See Sanitization of db.query.text.

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

[12]: 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.

[13]: 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.

The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):

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 Experimental
any any Experimental
each_quorum each_quorum Experimental
local_one local_one Experimental
local_quorum local_quorum Experimental
local_serial local_serial Experimental
one one Experimental
quorum quorum Experimental
serial serial Experimental
three three Experimental
two two Experimental

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. Stable