Skip to content

Commit 77a7a13

Browse files
committed
Add missing documentation fragments.
Closes spring-projects#2463
1 parent fca600c commit 77a7a13

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[[observability-conventions]]
2+
=== Observability - Conventions
3+
4+
Below you can find a list of all `GlobalObservabilityConventions` and `ObservabilityConventions` declared by this project.
5+
6+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[[observability-metrics]]
2+
=== Observability - Metrics
3+
4+
Below you can find a list of all metrics declared by this project.
5+
6+
[[observability-metrics-redis-command-observation]]
7+
==== Redis Command Observation
8+
9+
____
10+
Timer created around a Redis command execution.
11+
____
12+
13+
**Metric name** `spring.data.redis`. **Type** `timer` and **base unit** `seconds`.
14+
15+
Fully qualified name of the enclosing class `org.springframework.data.redis.connection.lettuce.observability.RedisObservation`.
16+
17+
18+
19+
.Low cardinality Keys
20+
[cols="a,a"]
21+
|===
22+
|Name | Description
23+
|`db.operation`|Redis command value.
24+
|`db.redis.database_index`|Redis database index.
25+
|`db.system`|Database system.
26+
|`db.user`|Redis user.
27+
|`net.peer.name`|Name of the database host.
28+
|`net.peer.port`|Logical remote port number.
29+
|`net.sock.peer.addr`|Mongo peer address.
30+
|`net.sock.peer.port`|Mongo peer port.
31+
|`net.transport`|Network transport.
32+
|===
33+
34+
.High cardinality Keys
35+
[cols="a,a"]
36+
|===
37+
|Name | Description
38+
|`db.statement`|Redis statement.
39+
|`spring.data.redis.command.error`|Redis error response.
40+
|===
41+
42+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[[observability-spans]]
2+
=== Observability - Spans
3+
4+
Below you can find a list of all spans declared by this project.
5+
6+
[[observability-spans-redis-command-observation]]
7+
==== Redis Command Observation Span
8+
9+
> Timer created around a Redis command execution.
10+
11+
**Span name** `spring.data.redis`.
12+
13+
Fully qualified name of the enclosing class `org.springframework.data.redis.connection.lettuce.observability.RedisObservation`.
14+
15+
16+
17+
.Tag Keys
18+
|===
19+
|Name | Description
20+
|`db.operation`|Redis command value.
21+
|`db.redis.database_index`|Redis database index.
22+
|`db.statement`|Redis statement.
23+
|`db.system`|Database system.
24+
|`db.user`|Redis user.
25+
|`net.peer.name`|Name of the database host.
26+
|`net.peer.port`|Logical remote port number.
27+
|`net.sock.peer.addr`|Mongo peer address.
28+
|`net.sock.peer.port`|Mongo peer port.
29+
|`net.transport`|Network transport.
30+
|`spring.data.redis.command.error`|Redis error response.
31+
|===
32+
33+
34+
35+

0 commit comments

Comments
 (0)