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

Commit b163c41

Browse files
author
Bogdan Drutu
authored
Update to not use suffix and always use full name to avoid confusion. (#112)
1 parent 33b9a1a commit b163c41

2 files changed

Lines changed: 38 additions & 38 deletions

File tree

‎stats/HTTP.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Client stats are recorded for each individual HTTP request, including for each i
3434

3535
All client metrics should be tagged with the following.
3636

37-
| Tag suffix | Description |
37+
| Tag name | Description |
3838
|--------------------|----------------------------------------------------------------------------------------------------------|
3939
| http_client_method | HTTP method, capitalized (i.e. GET, POST, PUT, DELETE, etc.) |
4040
| http_client_path | URL path (not including query string) |
@@ -51,12 +51,12 @@ stats recorded at the end of request processing.
5151

5252
The following set of views are considered minimum required to monitor client side performance:
5353

54-
| View name | Measure suffix | Aggregation | Tags suffix |
55-
|---------------------------------------------|-------------------|--------------|-------------------------------------------|
56-
| opencensus.io/http/client/sent_bytes | sent_bytes | distribution | client_method, client_path |
57-
| opencensus.io/http/client/received_bytes | received_bytes | distribution | client_method, client_path |
58-
| opencensus.io/http/client/roundtrip_latency | roundtrip_latency | distribution | client_method, client_path |
59-
| opencensus.io/http/client/completed_count | roundtrip_latency | count | client_method, client_path, client_status |
54+
| View name | Measure | Aggregation | Tags |
55+
|---------------------------------------------|---------------------------------------------|--------------|----------------------------------------------------------|
56+
| opencensus.io/http/client/sent_bytes | opencensus.io/http/client/sent_bytes | distribution | http_client_method, http_client_path |
57+
| opencensus.io/http/client/received_bytes | opencensus.io/http/client/received_bytes | distribution | http_client_method, http_client_path |
58+
| opencensus.io/http/client/roundtrip_latency | opencensus.io/http/client/roundtrip_latency | distribution | http_client_method, http_client_path |
59+
| opencensus.io/http/client/completed_count | opencensus.io/http/client/roundtrip_latency | count | http_client_method, http_client_path, http_client_status |
6060

6161
## Server
6262

@@ -76,7 +76,7 @@ Server stats are recorded for each individual HTTP request, including for each r
7676

7777
All server metrics should be tagged with the following.
7878

79-
| Tag suffix | Description |
79+
| Tag name | Description |
8080
|--------------------|---------------------------------------------------------------------|
8181
| http_server_method | HTTP method, capitalized (i.e. GET, POST, PUT, DELETE, etc.) |
8282
| http_server_path | URL path (not including query string) |
@@ -92,9 +92,9 @@ recorded at the end of request processing.
9292

9393
The following set of views are considered minimum required to monitor server side performance:
9494

95-
| View name | Measure suffix | Aggregation | Tags suffix |
96-
|-------------------------------------------|----------------|--------------|-------------------------------------------|
97-
| opencensus.io/http/server/received_bytes | received_bytes | distribution | server_method, server_path |
98-
| opencensus.io/http/server/sent_bytes | sent_bytes | distribution | server_method, server_path |
99-
| opencensus.io/http/server/server_latency | server_latency | distribution | server_method, server_path |
100-
| opencensus.io/http/server/completed_count | server_latency | count | server_method, server_path, server_status |
95+
| View name | Measure | Aggregation | Tags |
96+
|-------------------------------------------|------------------------------------------|--------------|----------------------------------------------------------|
97+
| opencensus.io/http/server/received_bytes | opencensus.io/http/server/received_bytes | distribution | http_server_method, http_server_path |
98+
| opencensus.io/http/server/sent_bytes | opencensus.io/http/server/sent_bytes | distribution | http_server_method, http_server_path |
99+
| opencensus.io/http/server/server_latency | opencensus.io/http/server/server_latency | distribution | http_server_method, http_server_path |
100+
| opencensus.io/http/server/completed_count | opencensus.io/http/server/server_latency | count | http_server_method, http_server_path, http_server_status |

‎stats/gRPC.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,22 @@ https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
5858

5959
The following set of views are considered minimum required to monitor client-side performance:
6060

61-
| View name | Measure suffix | Aggregation | Tags suffix |
62-
|---------------------------------------|------------------------|--------------|------------------------------|
63-
| grpc.io/client/sent_bytes_per_rpc | sent_bytes_per_rpc | distribution | client_method |
64-
| grpc.io/client/received_bytes_per_rpc | received_bytes_per_rpc | distribution | client_method |
65-
| grpc.io/client/roundtrip_latency | roundtrip_latency | distribution | client_method |
66-
| grpc.io/client/completed_rpcs | roundtrip_latency | count | client_method, client_status |
61+
| View name | Measure | Aggregation | Tags |
62+
|---------------------------------------|---------------------------------------|--------------|----------------------------------------|
63+
| grpc.io/client/sent_bytes_per_rpc | grpc.io/client/sent_bytes_per_rpc | distribution | grpc_client_method |
64+
| grpc.io/client/received_bytes_per_rpc | grpc.io/client/received_bytes_per_rpc | distribution | grpc_client_method |
65+
| grpc.io/client/roundtrip_latency | grpc.io/client/roundtrip_latency | distribution | grpc_client_method |
66+
| grpc.io/client/completed_rpcs | grpc.io/client/roundtrip_latency | count | grpc_client_method, grpc_client_status |
6767

6868
### Extra views
6969

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

72-
| View name | Measure suffix | Aggregation | Tags suffix |
73-
|------------------------------------------|---------------------------|--------------|---------------|
74-
| grpc.io/client/sent_messages_per_rpc | sent_messages_per_rpc | distribution | client_method |
75-
| grpc.io/client/received_messages_per_rpc | received_messages_per_rpc | distribution | client_method |
76-
| grpc.io/client/server_latency | server_latency | distribution | client_method |
72+
| View name | Measure | Aggregation | Tags |
73+
|------------------------------------------|------------------------------------------|--------------|--------------------|
74+
| grpc.io/client/sent_messages_per_rpc | grpc.io/client/sent_messages_per_rpc | distribution | grpc_client_method |
75+
| grpc.io/client/received_messages_per_rpc | grpc.io/client/received_messages_per_rpc | distribution | grpc_client_method |
76+
| grpc.io/client/server_latency | grpc.io/client/server_latency | distribution | grpc_client_method |
7777

7878
## Server
7979

@@ -108,30 +108,30 @@ https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
108108

109109
The following set of views are considered minimum required to monitor server side performance:
110110

111-
| View name | Measure suffix | Aggregation | Tags suffix |
112-
|---------------------------------------|------------------------|--------------|------------------------------|
113-
| grpc.io/server/received_bytes_per_rpc | received_bytes_per_rpc | distribution | server_method |
114-
| grpc.io/server/sent_bytes_per_rpc | sent_bytes_per_rpc | distribution | server_method |
115-
| grpc.io/server/server_latency | server_latency | distribution | server_method |
116-
| grpc.io/server/completed_rpcs | server_latency | count | server_method, server_status |
111+
| View name | Measure | Aggregation | Tags |
112+
|---------------------------------------|---------------------------------------|--------------|----------------------------------------|
113+
| grpc.io/server/received_bytes_per_rpc | grpc.io/server/received_bytes_per_rpc | distribution | grpc_server_method |
114+
| grpc.io/server/sent_bytes_per_rpc | grpc.io/server/sent_bytes_per_rpc | distribution | grpc_server_method |
115+
| grpc.io/server/server_latency | grpc.io/server/server_latency | distribution | grpc_server_method |
116+
| grpc.io/server/completed_rpcs | grpc.io/server/server_latency | count | grpc_server_method, grpc_server_status |
117117

118118
### Extra views
119119

120120
The following set of views are considered useful but not mandatory to monitor server side performance:
121121

122-
| View name | Measure suffix | Aggregation | Tags suffix |
123-
|------------------------------------------|---------------------------|--------------|---------------|
124-
| grpc.io/server/received_messages_per_rpc | received_messages_per_rpc | distribution | server_method |
125-
| grpc.io/server/sent_messages_per_rpc | sent_messages_per_rpc | distribution | server_method |
122+
| View name | Measure | Aggregation | Tag |
123+
|------------------------------------------|------------------------------------------|--------------|--------------------|
124+
| grpc.io/server/received_messages_per_rpc | grpc.io/server/received_messages_per_rpc | distribution | grpc_server_method |
125+
| grpc.io/server/sent_messages_per_rpc | grpc.io/server/sent_messages_per_rpc | distribution | grpc_server_method |
126126

127127
## FAQ
128128

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

132-
| View name | Measure | Aggregation | Tags suffix |
133-
|-----------------------------------------|----------------------------------|--------------|------------------------------|
134-
| grpc.io/client/latency_by_server_method | grpc.io/client/roundtrip_latency | distribution | client_method, server_method |
132+
| View name | Measure | Aggregation | Tag |
133+
|-----------------------------------------|----------------------------------|--------------|----------------------------------------|
134+
| grpc.io/client/latency_by_server_method | grpc.io/client/roundtrip_latency | distribution | grpc_client_method, grpc_server_method |
135135

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

0 commit comments

Comments
 (0)