forked from census-instrumentation/opencensus-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client_metrics.go
297 lines (279 loc) · 10.3 KB
/
client_metrics.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
// Copyright 2017, OpenCensus Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package grpcstats
import (
"log"
"go.opencensus.io/stats"
"go.opencensus.io/tag"
)
// The following variables are measures and views made available for gRPC clients.
// Client connection needs to use a ClientStatsHandler in order to enable collection.
var (
// Available client measures
RPCClientErrorCount *stats.MeasureInt64
RPCClientRoundTripLatency *stats.MeasureFloat64
RPCClientRequestBytes *stats.MeasureInt64
RPCClientResponseBytes *stats.MeasureInt64
RPCClientStartedCount *stats.MeasureInt64
RPCClientFinishedCount *stats.MeasureInt64
RPCClientRequestCount *stats.MeasureInt64
RPCClientResponseCount *stats.MeasureInt64
// Predefined client views
RPCClientErrorCountView *stats.View
RPCClientRoundTripLatencyView *stats.View
RPCClientRequestBytesView *stats.View
RPCClientResponseBytesView *stats.View
RPCClientRequestCountView *stats.View
RPCClientResponseCountView *stats.View
RPCClientRoundTripLatencyMinuteView *stats.View
RPCClientRequestBytesMinuteView *stats.View
RPCClientResponseBytesMinuteView *stats.View
RPCClientErrorCountMinuteView *stats.View
RPCClientStartedCountMinuteView *stats.View
RPCClientFinishedCountMinuteView *stats.View
RPCClientRequestCountMinuteView *stats.View
RPCClientResponseCountMinuteView *stats.View
RPCClientRoundTripLatencyHourView *stats.View
RPCClientRequestBytesHourView *stats.View
RPCClientResponseBytesHourView *stats.View
RPCClientErrorCountHourView *stats.View
RPCClientStartedCountHourView *stats.View
RPCClientFinishedCountHourView *stats.View
RPCClientRequestCountHourView *stats.View
RPCClientResponseCountHourView *stats.View
)
// TODO(acetechnologist): This is temporary and will need to be replaced by a
// mechanism to load these defaults from a common repository/config shared by
// all supported languages. Likely a serialized protobuf of these defaults.
func defaultClientMeasures() {
var err error
// Creating client measures
if RPCClientErrorCount, err = stats.NewMeasureInt64("grpc.io/client/error_count", "RPC Errors", unitCount); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/error_count: %v", err)
}
if RPCClientRoundTripLatency, err = stats.NewMeasureFloat64("grpc.io/client/roundtrip_latency", "RPC roundtrip latency in msecs", unitMillisecond); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/roundtrip_latency: %v", err)
}
if RPCClientRequestBytes, err = stats.NewMeasureInt64("grpc.io/client/request_bytes", "Request bytes", unitByte); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/request_bytes: %v", err)
}
if RPCClientResponseBytes, err = stats.NewMeasureInt64("grpc.io/client/response_bytes", "Response bytes", unitByte); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/response_bytes: %v", err)
}
if RPCClientStartedCount, err = stats.NewMeasureInt64("grpc.io/client/started_count", "Number of client RPCs (streams) started", unitCount); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/started_count: %v", err)
}
if RPCClientFinishedCount, err = stats.NewMeasureInt64("grpc.io/client/finished_count", "Number of client RPCs (streams) finished", unitCount); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/finished_count: %v", err)
}
if RPCClientRequestCount, err = stats.NewMeasureInt64("grpc.io/client/request_count", "Number of client RPC request messages", unitCount); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/request_count: %v", err)
}
if RPCClientResponseCount, err = stats.NewMeasureInt64("grpc.io/client/response_count", "Number of client RPC response messages", unitCount); err != nil {
log.Fatalf("Cannot create measure grpc.io/client/response_count: %v", err)
}
}
func defaultClientViews() {
RPCClientErrorCountView, _ = stats.NewView(
"grpc.io/client/error_count/cumulative",
"RPC Errors",
[]tag.Key{keyStatus, keyMethod},
RPCClientErrorCount,
aggMean,
windowCumulative)
RPCClientRoundTripLatencyView, _ = stats.NewView(
"grpc.io/client/roundtrip_latency/cumulative",
"Latency in msecs",
[]tag.Key{keyMethod},
RPCClientRoundTripLatency,
aggDistMillis,
windowCumulative)
RPCClientRequestBytesView, _ = stats.NewView(
"grpc.io/client/request_bytes/cumulative",
"Request bytes",
[]tag.Key{keyMethod},
RPCClientRequestBytes,
aggDistBytes,
windowCumulative)
RPCClientResponseBytesView, _ = stats.NewView(
"grpc.io/client/response_bytes/cumulative",
"Response bytes",
[]tag.Key{keyMethod},
RPCClientResponseBytes,
aggDistBytes,
windowCumulative)
RPCClientRequestCountView, _ = stats.NewView(
"grpc.io/client/request_count/cumulative",
"Count of request messages per client RPC",
[]tag.Key{keyMethod},
RPCClientRequestCount,
aggDistCounts,
windowCumulative)
RPCClientResponseCountView, _ = stats.NewView(
"grpc.io/client/response_count/cumulative",
"Count of response messages per client RPC",
[]tag.Key{keyMethod},
RPCClientResponseCount,
aggDistCounts,
windowCumulative)
clientViews = append(clientViews,
RPCClientErrorCountView,
RPCClientRoundTripLatencyView,
RPCClientRequestBytesView,
RPCClientResponseBytesView,
RPCClientRequestCountView,
RPCClientResponseCountView,
)
// TODO(jbd): Add roundtrip_latency, uncompressed_request_bytes, uncompressed_response_bytes, request_count, response_count.
RPCClientRoundTripLatencyMinuteView, _ = stats.NewView(
"grpc.io/client/roundtrip_latency/minute",
"Minute stats for latency in msecs",
[]tag.Key{keyMethod},
RPCClientRoundTripLatency,
aggMean,
windowSlidingMinute)
RPCClientRequestBytesMinuteView, _ = stats.NewView(
"grpc.io/client/request_bytes/minute",
"Minute stats for request size in bytes",
[]tag.Key{keyMethod},
RPCClientRequestBytes,
aggMean,
windowSlidingMinute)
RPCClientResponseBytesMinuteView, _ = stats.NewView(
"grpc.io/client/response_bytes/minute",
"Minute stats for response size in bytes",
[]tag.Key{keyMethod},
RPCClientResponseBytes,
aggMean,
windowSlidingMinute)
RPCClientErrorCountMinuteView, _ = stats.NewView(
"grpc.io/client/error_count/minute",
"Minute stats for rpc errors",
[]tag.Key{keyMethod},
RPCClientErrorCount,
aggMean,
windowSlidingMinute)
RPCClientStartedCountMinuteView, _ = stats.NewView(
"grpc.io/client/started_count/minute",
"Minute stats on the number of client RPCs started",
[]tag.Key{keyMethod},
RPCClientStartedCount,
aggMean,
windowSlidingMinute)
RPCClientFinishedCountMinuteView, _ = stats.NewView(
"grpc.io/client/finished_count/minute",
"Minute stats on the number of client RPCs finished",
[]tag.Key{keyMethod},
RPCClientFinishedCount,
aggMean,
windowSlidingMinute)
RPCClientRequestCountMinuteView, _ = stats.NewView(
"grpc.io/client/request_count/minute",
"Minute stats on the count of request messages per client RPC",
[]tag.Key{keyMethod},
RPCClientRequestCount,
aggMean,
windowSlidingMinute)
RPCClientResponseCountMinuteView, _ = stats.NewView(
"grpc.io/client/response_count/minute",
"Minute stats on the count of response messages per client RPC",
[]tag.Key{keyMethod},
RPCClientResponseCount,
aggMean,
windowSlidingMinute)
clientViews = append(clientViews,
RPCClientRoundTripLatencyMinuteView,
RPCClientRequestBytesMinuteView,
RPCClientResponseBytesMinuteView,
RPCClientErrorCountMinuteView,
RPCClientStartedCountMinuteView,
RPCClientFinishedCountMinuteView,
RPCClientRequestCountMinuteView,
RPCClientResponseCountMinuteView,
)
RPCClientRoundTripLatencyHourView, _ = stats.NewView(
"grpc.io/client/roundtrip_latency/hour",
"Hour stats for latency in msecs",
[]tag.Key{keyMethod},
RPCClientRoundTripLatency,
aggMean,
windowSlidingHour)
RPCClientRequestBytesHourView, _ = stats.NewView(
"grpc.io/client/request_bytes/hour",
"Hour stats for request size in bytes",
[]tag.Key{keyMethod},
RPCClientRequestBytes,
aggMean,
windowSlidingHour)
RPCClientResponseBytesHourView, _ = stats.NewView(
"grpc.io/client/response_bytes/hour",
"Hour stats for response size in bytes",
[]tag.Key{keyMethod},
RPCClientResponseBytes,
aggMean,
windowSlidingHour)
RPCClientErrorCountHourView, _ = stats.NewView(
"grpc.io/client/error_count/hour",
"Hour stats for rpc errors",
[]tag.Key{keyMethod},
RPCClientErrorCount,
aggMean,
windowSlidingHour)
RPCClientStartedCountHourView, _ = stats.NewView(
"grpc.io/client/started_count/hour",
"Hour stats on the number of client RPCs started",
[]tag.Key{keyMethod},
RPCClientStartedCount,
aggMean,
windowSlidingHour)
RPCClientFinishedCountHourView, _ = stats.NewView(
"grpc.io/client/finished_count/hour",
"Hour stats on the number of client RPCs finished",
[]tag.Key{keyMethod},
RPCClientFinishedCount,
aggMean,
windowSlidingHour)
RPCClientRequestCountHourView, _ = stats.NewView(
"grpc.io/client/request_count/hour",
"Hour stats on the count of request messages per client RPC",
[]tag.Key{keyMethod},
RPCClientRequestCount,
aggMean,
windowSlidingHour)
RPCClientResponseCountHourView, _ = stats.NewView(
"grpc.io/client/response_count/hour",
"Hour stats on the count of response messages per client RPC",
[]tag.Key{keyMethod},
RPCClientResponseCount,
aggMean,
windowSlidingHour)
clientViews = append(clientViews,
RPCClientRoundTripLatencyHourView,
RPCClientRequestBytesHourView,
RPCClientResponseBytesHourView,
RPCClientErrorCountHourView,
RPCClientStartedCountHourView,
RPCClientFinishedCountHourView,
RPCClientRequestCountHourView,
RPCClientResponseCountHourView,
)
}
// initClient registers the default metrics (measures and views)
// for a GRPC client.
func initClient() {
defaultClientMeasures()
defaultClientViews()
}
var clientViews []*stats.View