Skip to content

Commit dd87a1b

Browse files
authored
Update metrics list (#1048)
* update metrics list with A66 metrics
1 parent a2e9520 commit dd87a1b

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/en/actuator.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,50 @@ Once the dependencies are added grpc-spring-boot-starter will automatically conf
7373
- `methodType`: The type of the requested grpc method.
7474
- `statusCode`: Response `Status.Code`
7575

76+
## gRPC A66 Metrics
77+
78+
In addition to above listed metrics, once the dependencies are added grpc-spring-boot-starter will automatically configure to gather [gRPC A66](https://github.com/grpc/proposal/blob/master/A66-otel-stats.md) metrics.
79+
80+
### Client Metrics
81+
82+
### Counter
83+
84+
- `grpc.client.attempt.started`: The total number of RPC attempts started, including those that have not completed.
85+
- Tags: `grpc.method`
86+
87+
### Distribution
88+
89+
- `grpc.client.attempt.sent_total_compressed_message_size`: Total bytes (compressed but not encrypted) sent across all request messages (metadata excluded) per RPC attempt.
90+
- Tags: `grpc.method`, `grpc.status`
91+
- `grpc.client.attempt.rcvd_total_compressed_message_size`: Total bytes (compressed but not encrypted) received across all response messages (metadata excluded) per RPC attempt.
92+
- Tags: `grpc.method`, `grpc.status`
93+
94+
### Timer
95+
96+
- `grpc.client.attempt.duration`: The total time taken to complete an RPC attempt including the time it takes to pick a sub channel.
97+
- Tags: `grpc.method`, `grpc.status`
98+
- `grpc.client.call.duration`: The total time taken by gRPC library to complete an RPC from the application’s perspective.
99+
- Tags: `grpc.method`, `grpc.status`
100+
101+
### Server Metrics
102+
103+
### Counter
104+
105+
- `grpc.server.call.started`: The total number of RPCs started, including those that have not completed.
106+
- Tags: `grpc.method`
107+
108+
### Distribution
109+
110+
- `grpc.server.call.sent_total_compressed_message_size`: Total bytes (compressed but not encrypted) sent across all response messages (metadata excluded) per RPC.
111+
- Tags: `grpc.method`, `grpc.status`
112+
- `grpc.server.call.rcvd_total_compressed_message_size`: Total bytes (compressed but not encrypted) received across all request messages (metadata excluded) per RPC.
113+
- Tags: `grpc.method`, `grpc.status`
114+
115+
### Timer
116+
117+
- `grpc.server.call.duration`: The total time an RPC takes from the server transport’s perspective.
118+
- Tags: `grpc.method`, `grpc.status`
119+
76120
### Viewing the metrics
77121

78122
You can view the grpc metrics along with your other metrics at `/actuator/metrics` (requires a web-server) or via JMX.
@@ -150,6 +194,8 @@ net.devh.boot.grpc.client.autoconfigure.GrpcClientMetricAutoConfiguration,\
150194
net.devh.boot.grpc.server.autoconfigure.GrpcServerMetricAutoConfiguration
151195
````
152196

197+
You can opt out from collecting gRPC A66 metrics using `grpc.metricsA66Enabled=false`.
198+
153199
----------
154200

155201
[<- Back to Index](index.md)

0 commit comments

Comments
 (0)