Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit b3cb170

Browse files
author
Ramon Nogueira
authored
Fix some small issues with gRPC measures and views (#93)
Detected some small issues with gRPC measures and views while implementing them in Go. Mostly, we used "send" instead of "sent" inconsistently.
1 parent 3f59ff9 commit b3cb170

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

stats/gRPC.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ Client stats are recorded at the end of each outbound RPC.
3131

3232
| Measure name | Unit | Description |
3333
|------------------------------------------|------|-----------------------------------------------------------------------------------------------|
34-
| grpc.io/client/sent_messages_per_rpc | 1 | Number of messages sent in the RPC (always `1` for non-streaming RPCs). |
35-
| grpc.io/client/sent_bytes_per_rpc | By | Total bytes sent across all request messages per RPC. |
36-
| grpc.io/client/received_messages_per_rpc | 1 | Number of response messages received per RPC (always `1` for non-streaming RPCs). |
37-
| grpc.io/client/received_bytes_per_rpc | By | Total bytes received across all response messages per RPC. |
34+
| grpc.io/client/sent_messages_per_rpc | 1 | Number of messages sent in the RPC (always 1 for non-streaming RPCs). |
35+
| grpc.io/client/sent_bytes_per_rpc | By | Total bytes sent across all request messages per RPC. |
36+
| grpc.io/client/received_messages_per_rpc | 1 | Number of response messages received per RPC (always 1 for non-streaming RPCs). |
37+
| grpc.io/client/received_bytes_per_rpc | By | Total bytes received across all response messages per RPC. |
3838
| grpc.io/client/roundtrip_latency | ms | Time between first byte of request sent to last byte of response received, or terminal error. |
3939
| grpc.io/client/server_latency | ms | Propagated from the server and should have the same value as "grpc.io/server/latency". |
4040

@@ -55,16 +55,16 @@ The following set of views are considered minimum required to monitor client-sid
5555
|---------------------------------------|------------------------|--------------|------------------------------|
5656
| grpc.io/client/sent_bytes_per_rpc | sent_bytes_per_rpc | distribution | client_method |
5757
| grpc.io/client/received_bytes_per_rpc | received_bytes_per_rpc | distribution | client_method |
58-
| grpc.io/client/roundtrip_latency | latency | distribution | client_method |
59-
| grpc.io/client/completed_rpcs | latency | count | client_method, client_status |
58+
| grpc.io/client/roundtrip_latency | roundtrip_latency | distribution | client_method |
59+
| grpc.io/client/completed_rpcs | roundtrip_latency | count | client_method, client_status |
6060

6161
### Extra views
6262

6363
The following set of views are considered useful but not mandatory to monitor client side performance:
6464

6565
| View name | Measure suffix | Aggregation | Tags suffix |
6666
|------------------------------------------|---------------------------|--------------|---------------|
67-
| grpc.io/client/send_messages_per_rpc | send_messages_per_rpc | distribution | client_method |
67+
| grpc.io/client/sent_messages_per_rpc | sent_messages_per_rpc | distribution | client_method |
6868
| grpc.io/client/received_messages_per_rpc | received_messages_per_rpc | distribution | client_method |
6969
| grpc.io/client/server_latency | server_latency | distribution | client_method |
7070

@@ -74,10 +74,10 @@ Server stats are recorded at the end of processing each RPC.
7474

7575
| Measure name | Unit | Description |
7676
|------------------------------------------|------|-----------------------------------------------------------------------------------------------|
77-
| grpc.io/server/received_messages_per_rpc | 1 | Number of messages received in each RPC. Has value `1` for non-streaming RPCs. |
77+
| grpc.io/server/received_messages_per_rpc | 1 | Number of messages received in each RPC. Has value 1 for non-streaming RPCs. |
7878
| grpc.io/server/received_bytes_per_rpc | By | Total bytes received across all messages per RPC. |
79-
| grpc.io/server/send_messages_per_rpc | 1 | Number of messages sent in each RPC. Has value `1` for non-streaming RPCs. |
80-
| grpc.io/server/send_bytes_per_rpc | By | Total bytes sent in across all response messages per RPC. |
79+
| grpc.io/server/sent_messages_per_rpc | 1 | Number of messages sent in each RPC. Has value 1 for non-streaming RPCs. |
80+
| grpc.io/server/sent_bytes_per_rpc | By | Total bytes sent in across all response messages per RPC. |
8181
| grpc.io/server/server_latency | ms | Time between first byte of request received to last byte of response sent, or terminal error. |
8282

8383
### Tags
@@ -99,7 +99,7 @@ The following set of views are considered minimum required to monitor server sid
9999
| View name | Measure suffix | Aggregation | Tags suffix |
100100
|---------------------------------------|------------------------|--------------|------------------------------|
101101
| grpc.io/server/received_bytes_per_rpc | received_bytes_per_rpc | distribution | server_method |
102-
| grpc.io/server/send_bytes_per_rpc | send_bytes_per_rpc | distribution | server_method |
102+
| grpc.io/server/sent_bytes_per_rpc | sent_bytes_per_rpc | distribution | server_method |
103103
| grpc.io/server/server_latency | server_latency | distribution | server_method |
104104
| grpc.io/server/completed_rpcs | server_latency | count | server_method, server_status |
105105

@@ -110,16 +110,16 @@ The following set of views are considered useful but not mandatory to monitor se
110110
| View name | Measure suffix | Aggregation | Tags suffix |
111111
|------------------------------------------|---------------------------|--------------|---------------|
112112
| grpc.io/server/received_messages_per_rpc | received_messages_per_rpc | distribution | server_method |
113-
| grpc.io/server/send_messages_per_rpc | response_messages_count | distribution | server_method |
113+
| grpc.io/server/sent_messages_per_rpc | sent_messages_per_rpc | distribution | server_method |
114114

115115
## FAQ
116116

117117
### Why different tag name for server/client method?
118118
This way users can configure views to correlate incoming with outgoing requests. A view example:
119119

120-
| View name | Measure suffix | Aggregation | Tags suffix |
121-
|-----------------------------------------|----------------|--------------|------------------------------|
122-
| grpc.io/client/latency_by_server_method | latency | distribution | client_method, server_method |
120+
| View name | Measure | Aggregation | Tags suffix |
121+
|-----------------------------------------|----------------------------------|--------------|------------------------------|
122+
| grpc.io/client/latency_by_server_method | grpc.io/client/roundtrip_latency | distribution | client_method, server_method |
123123

124124
### How is the server latency on the client recorded (grcp.io/client/server_latency)?
125125
This is TBD, eventually a designated gRPC metadata key will be specified for this purpose.

0 commit comments

Comments
 (0)