Semantic Conventions for HBase

Status: Experimental

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

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

Attributes

Attribute	Type	Description	Examples	Requirement Level	Stability
db.collection.name	string	The HBase table name. [1]	mytable; ns:table	Conditionally Required If applicable.
db.namespace	string	The HBase namespace. [2]	mynamespace	Conditionally Required If applicable.
db.operation.name	string	The name of the operation or command being executed. [3]	findAndModify; HMSET; SELECT	Conditionally Required [4]
error.type	string	Describes a class of error the operation ended with. [5]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If and only if the operation failed.
server.port	int	Server port number. [6]	80; 8080; 443	Conditionally Required [7]
server.address	string	Name of the database host. [8]	example.com; 10.1.2.80; /tmp/my.sock	Recommended

[1]: If table name includes the namespace, the db.collection.name SHOULD be set to the full table name.

[2]: When performing table-related operations, the instrumentations SHOULD extract the namespace from the table name according to the HBase table naming conventions. If namespace is not provided, instrumentation SHOULD set db.namespace value to default.

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

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

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

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

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

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

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

• db.collection.name
• db.namespace
• db.operation.name
• server.address
• server.port

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.