diff --git a/src/main/asciidoc/observability/_conventions.adoc b/src/main/asciidoc/observability/_conventions.adoc new file mode 100644 index 000000000..f9dde4326 --- /dev/null +++ b/src/main/asciidoc/observability/_conventions.adoc @@ -0,0 +1,6 @@ +[[observability-conventions]] +=== Observability - Conventions + +Below you can find a list of all `GlobalObservabilityConventions` and `ObservabilityConventions` declared by this project. + + diff --git a/src/main/asciidoc/observability/_metrics.adoc b/src/main/asciidoc/observability/_metrics.adoc new file mode 100644 index 000000000..870c98962 --- /dev/null +++ b/src/main/asciidoc/observability/_metrics.adoc @@ -0,0 +1,42 @@ +[[observability-metrics]] +=== Observability - Metrics + +Below you can find a list of all metrics declared by this project. + +[[observability-metrics-redis-command-observation]] +==== Redis Command Observation + +____ +Timer created around a Redis command execution. +____ + +**Metric name** `spring.data.redis`. **Type** `timer` and **base unit** `seconds`. + +Fully qualified name of the enclosing class `org.springframework.data.redis.connection.lettuce.observability.RedisObservation`. + + + +.Low cardinality Keys +[cols="a,a"] +|=== +|Name | Description +|`db.operation`|Redis command value. +|`db.redis.database_index`|Redis database index. +|`db.system`|Database system. +|`db.user`|Redis user. +|`net.peer.name`|Name of the database host. +|`net.peer.port`|Logical remote port number. +|`net.sock.peer.addr`|Mongo peer address. +|`net.sock.peer.port`|Mongo peer port. +|`net.transport`|Network transport. +|=== + +.High cardinality Keys +[cols="a,a"] +|=== +|Name | Description +|`db.statement`|Redis statement. +|`spring.data.redis.command.error`|Redis error response. +|=== + + diff --git a/src/main/asciidoc/observability/_spans.adoc b/src/main/asciidoc/observability/_spans.adoc new file mode 100644 index 000000000..e774c9c7c --- /dev/null +++ b/src/main/asciidoc/observability/_spans.adoc @@ -0,0 +1,35 @@ +[[observability-spans]] +=== Observability - Spans + +Below you can find a list of all spans declared by this project. + +[[observability-spans-redis-command-observation]] +==== Redis Command Observation Span + +> Timer created around a Redis command execution. + +**Span name** `spring.data.redis`. + +Fully qualified name of the enclosing class `org.springframework.data.redis.connection.lettuce.observability.RedisObservation`. + + + +.Tag Keys +|=== +|Name | Description +|`db.operation`|Redis command value. +|`db.redis.database_index`|Redis database index. +|`db.statement`|Redis statement. +|`db.system`|Database system. +|`db.user`|Redis user. +|`net.peer.name`|Name of the database host. +|`net.peer.port`|Logical remote port number. +|`net.sock.peer.addr`|Mongo peer address. +|`net.sock.peer.port`|Mongo peer port. +|`net.transport`|Network transport. +|`spring.data.redis.command.error`|Redis error response. +|=== + + + +