Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 7.3 KB

redis.md

File metadata and controls

93 lines (64 loc) · 7.3 KB
Raw

Semantic Conventions for Redis

Status: Experimental

The Semantic Conventions for Redis 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 "redis".

Attributes

Attribute Type Description Examples Requirement Level Stability
db.namespace string The index of the database being accessed as used in the SELECT command. [1] 0; 1; 15 Conditionally Required If and only if it can be captured reliably. Experimental
db.operation.name string The name of the operation or command being executed. [2] findAndModify; HMSET; SELECT Conditionally Required [3] Experimental
error.type string Describes a class of error the operation ended with. [4] timeout; java.net.UnknownHostException; server_certificate_invalid; 500 Conditionally Required If and only if the operation failed. Stable
server.port int Server port number. [5] 80; 8080; 443 Conditionally Required [6] Stable
db.query.text string The full syntax of the Redis CLI command. [7] HMSET myhash field1 'Hello' field2 'World' Recommended [8] Experimental
network.peer.address string Peer address of the database node where the operation was performed. [9] 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. [10] 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. [11] someval; 55 Opt-In Experimental

[1]: The database index for current connection can be changed by the application dynamically. Instrumentations MAY use the initial database index provided in the connection string and keep track of the currently selected database to capture the db.namespace. Instrumentations SHOULD NOT set this attribute if capturing it would require additional network calls to Redis. For commands that switch the database, this SHOULD be set to the target database (even if the command fails).

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

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

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

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

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

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

[8]: 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. Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see db.query.parameter.<key>).

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

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

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

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

Example

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

Key Value
Span name "HMSET 15"
db.system "redis"
network.peer.address "/tmp/redis.sock"
network.transport "unix"
db.namespace "15"
db.query.text "HMSET myhash field1 'Hello' field2 'World"
db.operation.name "HMSET"