Semantic Conventions for Redis

Status: Experimental

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

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

Span name

Redis spans SHOULD follow the general database span name convention, except that db.namespace SHOULD NOT be used in the span name since it is a numeric value that ends up looking confusing.

Attributes

Attribute	Type	Description	Examples	Requirement Level	Stability
db.namespace	string	The [database index] associated with the connection, represented as a string. [1]	0; 1; 15	Conditionally Required If and only if it can be captured reliably.
db.operation.name	string	The name of the operation or command being executed. [2]	findAndModify; HMSET; SELECT	Conditionally Required [3]
db.response.status_code	string	The Redis simple error prefix. [4]	ERR; WRONGTYPE; CLUSTERDOWN	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.operation.batch.size	int	The number of queries included in a batch operation. [9]	2; 3; 4	Recommended
db.query.text	string	The full syntax of the Redis CLI command. [10]	HMSET myhash field1 'Hello' field2 'World'	Recommended [11]
network.peer.address	string	Peer address of the database node where the operation was performed. [12]	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. [13]	example.com; 10.1.2.80; /tmp/my.sock	Recommended
db.operation.parameter.<key>	string	A database operation parameter, with <key> being the parameter name, and the attribute value being a string representation of the parameter value. [14]	someval; 55	Opt-In

[1] db.namespace: A connection’s currently associated database index may change during its lifetime, e.g. from executing SELECT <index>.

If instrumentation is unable to capture the connection’s currently associated database index on each query without triggering an additional query to be executed, then it is RECOMMENDED to fallback and use the database index provided when the connection was established.

Instrumentation SHOULD document if db.namespace reflects the database index provided when the connection was established.

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

The operation name SHOULD NOT be extracted from db.query.text, unless the query format is known to only ever have a single operation name present.

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.

This attribute has stability level RELEASE CANDIDATE.

[3] db.operation.name: If readily available and if there is a single operation name that describes the database call. The operation name MAY be parsed from the query text, in which case it SHOULD be the single operation name found in the query.

[4] db.response.status_code: The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. Semantic conventions for individual database systems SHOULD document what db.response.status_code means in the context of that system. This attribute has stability level RELEASE CANDIDATE.

[5] db.response.status_code: If the operation failed and status code is available.

[6] error.type: The error.type SHOULD match the db.response.status_code returned by the database or the client library, or the canonical name of exception that occurred. When using canonical exception type name, instrumentation SHOULD do the best effort to report the most relevant type. For example, if the original exception is wrapped into a generic one, the original exception SHOULD be preferred. Instrumentations SHOULD document how error.type is populated.

[7] server.port: 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] server.port: If using a port other than the default port for this DBMS and if server.address is set.

[9] db.operation.batch.size: Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1. This attribute has stability level RELEASE CANDIDATE.

[10] db.query.text: For Redis, the value provided for db.query.text SHOULD correspond to the syntax of the Redis CLI. If, for example, the HMSET command is invoked, "HMSET myhash field1 'Hello' field2 'World'" would be a suitable value for db.query.text.

[11] db.query.text: Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See Sanitization of db.query.text. Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see db.operation.parameter.<key>).

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

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

[14] db.operation.parameter: If a parameter has no name and instead is referenced only by index, then <key> SHOULD be the 0-based index. If db.query.text is also captured, then db.operation.parameter.<key> SHOULD match up with the parameterized placeholders present in db.query.text. This attribute has stability level RELEASE CANDIDATE.

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
• db.query.text
• 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.

Example

In this example, Redis is connected using a unix domain socket and therefore the connection string is left out.