Skip to content

Commit e566f2d

Browse files
authored
[OTel Metrics] Update based on A96: OTel Metrics for Retries (#1450)
Reviewer comment
1 parent f02d127 commit e566f2d

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

content/en/docs/guides/opentelemetry-metrics.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ instruments are created using this meter. Users should employ the
3131
More and more gRPC components are being instrumented for observability.
3232
Currently, we have the following components instrumented -
3333

34-
* Per-call (stable, on by default) : Observe RPCs themselves (for example,
35-
latency.)
36-
* Client Per-Call : Observe a client call
37-
* Client Per-Attempt : Observe attempts for a client call, since a call
38-
can have multiple attempts due to retry or hedging.
34+
* Per-call : Observe RPCs themselves (for example, latency.)
35+
* Client Per-Call (stable, on by default) : Observe a client call
36+
* Client Per-Attempt (stable, on by default) : Observe attempts for a
37+
client call, since a call can have multiple attempts due to retry or
38+
hedging.
39+
* Client Per-Call Retry (experimental) : Observe retry, transparent retry
40+
and hedging,
3941
* Server : Observe a call received at the server.
4042
* LB Policy : Observe various load-balancing policies
4143
* Weighted Round Robin (experimental)
@@ -68,6 +70,17 @@ grpc.client.attempt.<br>rcvd_total_compressed_message_size | Histogram | By
6870

6971
Refer [A66: OpenTelemetry Metrics] for details.
7072

73+
#### Client Per-Call Retry Instruments
74+
75+
Name | Type | Unit | Labels (required) | Description
76+
------------------------------------ | --------- | ------------------- | ------------------------ | -----------
77+
grpc.client.call.retries | Histogram | {retry} | grpc.method, grpc.target | Number of retries during the client call. If there were no retries, 0 is not reported.
78+
grpc.client.call.transparent_retries | Histogram | {transparent_retry} | grpc.method, grpc.target | Number of transparent retries during the client call. If there were no transparent retries, 0 is not reported.
79+
grpc.client.call.hedges | Histogram | {hedge} | grpc.method, grpc.target | Number of hedges during the client call. If there were no hedges, 0 is not reported.
80+
grpc.client.call.retry_delay | Histogram | s | grpc.method, grpc.target | Total time of delay while there is no active attempt during the client call.
81+
82+
Refer [A96: OTel Metrics for Retries] for details.
83+
7184
#### Server Instruments
7285

7386
Name | Type | Unit | Labels (required) | Description
@@ -167,6 +180,7 @@ Python | [Python Example]
167180
* [A66: OpenTelemetry Metrics]
168181
* [A78: gRPC OTel Metrics for WRR, Pick First, and XdsClient]
169182
* [A79: Non-per-call Metrics Architecture]
183+
* [A96: OTel Metrics for Retries]
170184

171185
[sunsetted]: https://opentelemetry.io/blog/2023/sunsetting-opencensus/
172186
[MeterProvider]: https://opentelemetry.io/docs/specs/otel/metrics/api/#meterprovider
@@ -181,3 +195,4 @@ Python | [Python Example]
181195
[A78: gRPC OTel Metrics for WRR, Pick First, and XdsClient]: https://github.com/grpc/proposal/blob/master/A78-grpc-metrics-wrr-pf-xds.md
182196
[A79: Non-per-call Metrics Architecture]: https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#a79-non-per-call-metrics-architecture
183197
[A89: Backend Service Metric Label]: https://github.com/grpc/proposal/blob/master/A89-backend-service-metric-label.md
198+
[A96: OTel Metrics for Retries]: https://github.com/grpc/proposal/blob/master/A96-otel-metrics-for-retries.md

0 commit comments

Comments
 (0)