doc: add rueidis otel metrics (#434)

redis · Dec 26, 2023 · a85dd76 · a85dd76
1 parent b611f0c
commit a85dd76
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/rueidisotel/README.md b/rueidisotel/README.md
@@ -1,7 +1,14 @@
-# OpenTelemetry Tracing
+# OpenTelemetry Tracing & Connection Metrics
 
 Use `rueidisotel.WithClient` to create a client with OpenTelemetry Tracing enabled.
 
+Use `rueidisotel.NewClient` to create a client with OpenTelemetry Tracing and Connection Metrics enabled.
+default metrics are:
+- `rueidis_dial_attempt`: number of dial attempts
+- `rueidis_dial_success`: number of successful dials
+- `rueidis_dial_conns`: number of connections
+- `rueidis_dial_latency`: dial latency in seconds
+
 ```golang
 package main