aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/java/com/google/instrumentation/stats/RpcConstants.java
blob: c6d47ea7e19c241a18af4000e27fa29fb2384f43 (plain)
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
/*
 * Copyright 2016, Google Inc.
 * 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 com.google.instrumentation.stats;

import com.google.instrumentation.common.Duration;
import com.google.instrumentation.stats.MeasurementDescriptor.BasicUnit;
import com.google.instrumentation.stats.MeasurementDescriptor.MeasurementUnit;
import com.google.instrumentation.stats.ViewDescriptor.DistributionViewDescriptor;
import com.google.instrumentation.stats.ViewDescriptor.IntervalViewDescriptor;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * Constants for collecting rpc stats.
 */
public final class RpcConstants {
  // Rpc tag keys.
  public static final TagKey RPC_STATUS = TagKey.create("OpStatus");
  public static final TagKey RPC_CLIENT_METHOD = TagKey.create("method");
  public static final TagKey RPC_SERVER_METHOD = TagKey.create("method");

  // Constants used to define the following MeasurementDescriptors.
  private static final List<BasicUnit> bytes = Arrays.asList(BasicUnit.BYTES);
  private static final List<BasicUnit> scalar = Arrays.asList(BasicUnit.SCALAR);
  private static final List<BasicUnit> seconds = Arrays.asList(BasicUnit.SECONDS);

  // Census defined rpc client {@link MeasurementDescriptor}s.
  public static final MeasurementDescriptor RPC_CLIENT_ERROR_COUNT =
      MeasurementDescriptor.create(
          "/rpc/client/error_count",
          "RPC Errors",
          MeasurementUnit.create(0, scalar));
  public static final MeasurementDescriptor RPC_CLIENT_REQUEST_BYTES =
      MeasurementDescriptor.create(
          "/rpc/client/request_bytes",
          "Request bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_CLIENT_RESPONSE_BYTES =
      MeasurementDescriptor.create(
          "/rpc/client/response_bytes",
          "Response bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_CLIENT_ROUNDTRIP_LATENCY =
      MeasurementDescriptor.create(
          "/rpc/client/roundtrip_latency",
          "RPC roundtrip latency msec",
          MeasurementUnit.create(-3, seconds));
  public static final MeasurementDescriptor RPC_CLIENT_SERVER_ELAPSED_TIME =
      MeasurementDescriptor.create(
          "/rpc/client/server_elapsed_time",
          "Server elapsed time in msecs",
          MeasurementUnit.create(-3, seconds));
  public static final MeasurementDescriptor RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES =
      MeasurementDescriptor.create(
          "/rpc/client/uncompressed_request_bytes",
          "Uncompressed Request bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES =
      MeasurementDescriptor.create(
          "/rpc/client/uncompressed_response_bytes",
          "Uncompressed Response bytes",
          MeasurementUnit.create(0, bytes));

  // Census defined rpc server {@link MeasurementDescriptor}s.
  public static final MeasurementDescriptor RPC_SERVER_ERROR_COUNT =
      MeasurementDescriptor.create(
          "/rpc/server/error_count",
          "RPC Errors",
          MeasurementUnit.create(0, scalar));
  public static final MeasurementDescriptor RPC_SERVER_REQUEST_BYTES =
      MeasurementDescriptor.create(
          "/rpc/server/request_bytes",
          "Request bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_SERVER_RESPONSE_BYTES =
      MeasurementDescriptor.create(
          "/rpc/server/response_bytes",
          "Response bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_SERVER_SERVER_ELAPSED_TIME =
      MeasurementDescriptor.create(
          "/rpc/server/server_elapsed_time",
          "Server elapsed time in msecs",
          MeasurementUnit.create(-3, seconds));
  public static final MeasurementDescriptor RPC_SERVER_SERVER_LATENCY =
      MeasurementDescriptor.create(
          "/rpc/server/server_latency",
          "Latency in msecs",
          MeasurementUnit.create(-3, seconds));
  public static final MeasurementDescriptor RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES =
      MeasurementDescriptor.create(
          "/rpc/server/uncompressed_request_bytes",
          "Uncompressed Request bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES =
      MeasurementDescriptor.create(
          "/rpc/server/uncompressed_response_bytes",
          "Uncompressed Response bytes",
          MeasurementUnit.create(0, bytes));
  public static final MeasurementDescriptor RPC_SERVER_STARTED_COUNT =
      MeasurementDescriptor.create(
          "/rpc/server/started_count",
          "Number of RPCs started",
          MeasurementUnit.create(0, scalar));
  public static final MeasurementDescriptor RPC_SERVER_FINISHED_COUNT =
      MeasurementDescriptor.create(
          "/rpc/server/finished_count",
          "Number of RPCs finished",
          MeasurementUnit.create(0, scalar));

  // Common histogram bucket boundaries for bytes received/sets DistributionViewDescriptors.
  static final List<Double> RPC_BYTES_BUCKET_BOUNDARIES = Collections.unmodifiableList(
      Arrays.asList(0.0, 1024.0, 2048.0, 4096.0, 16384.0, 65536.0, 262144.0, 1048576.0, 4194304.0,
          16777216.0, 67108864.0, 268435456.0, 1073741824.0, 4294967296.0));

  // Common histogram bucket boundaries for latency and elapsed-time DistributionViewDescriptors.
  static final List<Double> RPC_MILLIS_BUCKET_BOUNDARIES = Collections.unmodifiableList(
      Arrays.asList(0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 8.0, 10.0, 13.0, 16.0, 20.0, 25.0, 30.0,
          40.0, 50.0, 65.0, 80.0, 100.0, 130.0, 160.0, 200.0, 250.0, 300.0, 400.0, 500.0, 650.0,
          800.0, 1000.0, 2000.0, 5000.0, 10000.0, 20000.0, 50000.0, 100000.0));

  // Census defined rpc client {@link ViewDescriptor}s.
  public static final DistributionViewDescriptor RPC_CLIENT_ERROR_COUNT_VIEW =
      DistributionViewDescriptor.create(
          "rpc client error_count",
          "RPC Errors",
          RPC_CLIENT_ERROR_COUNT,
          DistributionAggregationDescriptor.create(),
          Arrays.asList(RPC_STATUS, RPC_CLIENT_METHOD));
  public static final DistributionViewDescriptor RPC_CLIENT_ROUNDTRIP_LATENCY_VIEW =
      DistributionViewDescriptor.create(
          "rpc client roundtrip_latency",
          "Latency in msecs",
          RPC_CLIENT_ROUNDTRIP_LATENCY,
          DistributionAggregationDescriptor.create(RPC_MILLIS_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_CLIENT_METHOD));
  public static final DistributionViewDescriptor RPC_CLIENT_SERVER_ELAPSED_TIME_VIEW =
      DistributionViewDescriptor.create(
          "rpc client server_elapsed_time",
          "Server elapsed time in msecs",
          RPC_CLIENT_SERVER_ELAPSED_TIME,
          DistributionAggregationDescriptor.create(RPC_MILLIS_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_CLIENT_METHOD));
  public static final DistributionViewDescriptor RPC_CLIENT_REQUEST_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc client request_bytes",
          "Request bytes",
          RPC_CLIENT_REQUEST_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_CLIENT_METHOD));
  public static final DistributionViewDescriptor RPC_CLIENT_RESPONSE_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc client response_bytes",
          "Response bytes",
          RPC_CLIENT_RESPONSE_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_CLIENT_METHOD));
  public static final DistributionViewDescriptor RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc client uncompressed_request_bytes",
          "Uncompressed Request bytes",
          RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_CLIENT_METHOD));
  public static final DistributionViewDescriptor RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc client uncompressed_response_bytes",
          "Uncompressed Response bytes",
          RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_CLIENT_METHOD));


  // Census defined rpc server {@link ViewDescriptor}s.
  public static final DistributionViewDescriptor RPC_SERVER_ERROR_COUNT_VIEW =
      DistributionViewDescriptor.create(
          "rpc server error_count",
          "RPC Errors",
          RPC_SERVER_ERROR_COUNT,
          DistributionAggregationDescriptor.create(),
          Arrays.asList(RPC_STATUS, RPC_SERVER_METHOD));
  public static final DistributionViewDescriptor RPC_SERVER_SERVER_LATENCY_VIEW =
      DistributionViewDescriptor.create(
          "rpc server server_latency",
          "Latency in msecs",
          RPC_SERVER_SERVER_LATENCY,
          DistributionAggregationDescriptor.create(RPC_MILLIS_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_SERVER_METHOD));
  public static final DistributionViewDescriptor RPC_SERVER_SERVER_ELAPSED_TIME_VIEW =
      DistributionViewDescriptor.create(
          "rpc server elapsed_time",
          "Server elapsed time in msecs",
          RPC_SERVER_SERVER_ELAPSED_TIME,
          DistributionAggregationDescriptor.create(RPC_MILLIS_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_SERVER_METHOD));
  public static final DistributionViewDescriptor RPC_SERVER_REQUEST_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc server request_bytes",
          "Request bytes",
          RPC_SERVER_REQUEST_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_SERVER_METHOD));
  public static final DistributionViewDescriptor RPC_SERVER_RESPONSE_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc server response_bytes",
          "Response bytes",
          RPC_SERVER_RESPONSE_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_SERVER_METHOD));
  public static final DistributionViewDescriptor RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc server uncompressed_request_bytes",
          "Uncompressed Request bytes",
          RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_SERVER_METHOD));
  public static final DistributionViewDescriptor RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES_VIEW =
      DistributionViewDescriptor.create(
          "rpc server uncompressed_response_bytes",
          "Uncompressed Response bytes",
          RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES,
          DistributionAggregationDescriptor.create(RPC_BYTES_BUCKET_BOUNDARIES),
          Arrays.asList(RPC_SERVER_METHOD));

  // Interval Stats
  static final Duration MINUTE = Duration.create(60, 0);
  static final Duration HOUR = Duration.create(60 * 60, 0);

  // Census defined rpc client {@link IntervalViewDescriptor}s.
  public static final IntervalViewDescriptor RPC_CLIENT_ROUNDTRIP_LATENCY_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client roundtrip_latency",
          "Minute and Hour stats for latency in msecs",
          RPC_CLIENT_ROUNDTRIP_LATENCY,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  public static final IntervalViewDescriptor RPC_CLIENT_REQUEST_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client request_bytes",
          "Minute and Hour stats for request size in bytes",
          RPC_CLIENT_REQUEST_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  public static final IntervalViewDescriptor RPC_CLIENT_RESPONSE_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client response_bytes",
          "Minute and Hour stats for response size in bytes",
          RPC_CLIENT_RESPONSE_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  public static final IntervalViewDescriptor RPC_CLIENT_ERROR_COUNT_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client error_count",
          "Minute and Hour stats for rpc errors",
          RPC_CLIENT_ERROR_COUNT,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  public static final IntervalViewDescriptor RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client uncompressed_request_bytes",
          "Minute and Hour stats for uncompressed request size in bytes",
          RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  public static final IntervalViewDescriptor RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client uncompressed_response_bytes",
          "Minute and Hour stats for uncompressed response size in bytes",
          RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  public static final IntervalViewDescriptor RPC_CLIENT_SERVER_ELAPSED_TIME_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc client server_elapsed_time",
          "Minute and Hour stats for server elapsed time in msecs",
          RPC_CLIENT_SERVER_ELAPSED_TIME,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_CLIENT_METHOD));

  // Census defined rpc server {@link IntervalViewDescriptor}s.
  public static final IntervalViewDescriptor RPC_SERVER_SERVER_LATENCY_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server server_latency",
          "Minute and Hour stats for server latency in msecs",
          RPC_SERVER_SERVER_LATENCY,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  public static final IntervalViewDescriptor RPC_SERVER_REQUEST_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server request_bytes",
          "Minute and Hour stats for request size in bytes",
          RPC_SERVER_REQUEST_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  public static final IntervalViewDescriptor RPC_SERVER_RESPONSE_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server response_bytes",
          "Minute and Hour stats for response size in bytes",
          RPC_SERVER_RESPONSE_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  public static final IntervalViewDescriptor RPC_SERVER_ERROR_COUNT_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server error_count",
          "Minute and Hour stats for rpc errors",
          RPC_SERVER_ERROR_COUNT,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  public static final IntervalViewDescriptor RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server uncompressed_request_bytes",
          "Minute and Hour stats for uncompressed request size in bytes",
          RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  public static final IntervalViewDescriptor RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server uncompressed_response_bytes",
          "Minute and Hour stats for uncompressed response size in bytes",
          RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  public static final IntervalViewDescriptor RPC_SERVER_SERVER_ELAPSED_TIME_INTERVAL_VIEW =
      IntervalViewDescriptor.create(
          "rpc server server_elapsed_time",
          "Minute and Hour stats for server elapsed time in msecs",
          RPC_SERVER_SERVER_ELAPSED_TIME,
          IntervalAggregationDescriptor.create(Arrays.asList(MINUTE, HOUR)),
          Arrays.asList(RPC_SERVER_METHOD));

  // Visible for testing
  RpcConstants() {
    throw new AssertionError();
  }
}