Semantic Conventions for CouchDB

Status: Experimental

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

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

Attributes

Attribute	Type	Description	Examples	Requirement Level	Stability
db.namespace	string	The name of the database, fully qualified within the server address and port.	customers; test.users	Conditionally Required If available.
db.operation.name	string	The HTTP method + the target REST route. [1]	GET /{db}/{docid}	Conditionally Required [2]
error.type	string	Describes a class of error the operation ended with. [3]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If and only if the operation failed.
server.port	int	Server port number. [4]	80; 8080; 443	Conditionally Required [5]
server.address	string	Name of the database host. [6]	example.com; 10.1.2.80; /tmp/my.sock	Recommended

[1]: In CouchDB, db.operation.name should be set to the HTTP method + the target REST route according to the API reference documentation. For example, when retrieving a document, db.operation.name would be set to (literally, i.e., without replacing the placeholders with concrete values): GET /{db}/{docid}.

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

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

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

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

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