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.redis.database_index | int | The index of the database being accessed as used in the SELECT command, provided as an integer. To be used instead of the generic db.name attribute. | 0 ; 1 ; 15 | Conditionally Required If other than the default database (0 ). | |
db.statement | string | The full syntax of the Redis CLI command. [1] | HMSET myhash field1 'Hello' field2 'World' | Recommended [2] | |
network.peer.address | string | Peer address of the database node where the operation was performed. [3] | 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. |
[1]: For Redis, the value provided for db.statement
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.statement
.
[2]: Should be collected by default only if there is sanitization that excludes sensitive information.
[3]: If a database operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
Example
In this example, Redis is connected using a unix domain socket and therefore the connection string is left out.
Furthermore, db.name
is not specified as there is no database name in Redis and db.redis.database_index
is set instead.
Key | Value |
---|---|
Span name | "HMSET myhash" |
db.system | "redis" |
db.user | not set |
network.peer.address | "/tmp/redis.sock" |
network.transport | "unix" |
db.name | not set |
db.statement | "HMSET myhash field1 'Hello' field2 'World" |
db.operation | not set |
db.redis.database_index | 15 |