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

Commit 375907a

Browse files
songy23songy23
authored
Add started_rpcs measures and views to RPC constants. (#1230)
* Add started_rpcs measures and views to RPC constants. * Add this change to CHANGELOG. * Remove tag key status from started_rpcs views. * Count measures should be MeasureLong.
1 parent ff7a991 commit 375907a

File tree

6 files changed

+60
-1
lines changed

6 files changed

+60
-1
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- Add an util artifact `opencensus-contrib-appengine-standard-util` to interact with the AppEngine
1111
CloudTraceContext.
1212
- Add support for Span kinds. (fix [#1054](https://github.com/census-instrumentation/opencensus-java/issues/1054)).
13+
- Add client/server started_rpcs measures and views to RPC constants.
1314

1415
## 0.13.2 - 2018-05-08
1516
- Map http attributes to Stackdriver format (fix [#1153](https://github.com/census-instrumentation/opencensus-java/issues/1153)).

‎contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcMeasureConstants.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ public final class RpcMeasureConstants {
191191
* {@link Measure} for number of started client RPCs.
192192
*
193193
* @since 0.8
194+
* @deprecated in favor of {@link #GRPC_CLIENT_STARTED_RPCS}.
194195
*/
195196
@Deprecated
196197
public static final MeasureLong RPC_CLIENT_STARTED_COUNT =
@@ -294,6 +295,16 @@ public final class RpcMeasureConstants {
294295
Measure.MeasureDouble.create(
295296
"grpc.io/client/server_latency", "Server latency in msecs", MILLISECOND);
296297

298+
/**
299+
* {@link Measure} for total number of client RPCs ever opened, including those that have not
300+
* completed.
301+
*
302+
* @since 0.14
303+
*/
304+
public static final MeasureLong GRPC_CLIENT_STARTED_RPCS =
305+
Measure.MeasureLong.create(
306+
"grpc.io/client/started_rpcs", "Number of started client RPCs.", COUNT);
307+
297308
// RPC server Measures.
298309

299310
/**
@@ -375,6 +386,7 @@ public final class RpcMeasureConstants {
375386
* {@link Measure} for number of started server RPCs.
376387
*
377388
* @since 0.8
389+
* @deprecated in favor of {@link #GRPC_SERVER_STARTED_RPCS}.
378390
*/
379391
@Deprecated
380392
public static final MeasureLong RPC_SERVER_STARTED_COUNT =
@@ -469,5 +481,15 @@ public final class RpcMeasureConstants {
469481
+ "or terminal error.",
470482
MILLISECOND);
471483

484+
/**
485+
* {@link Measure} for total number of server RPCs ever opened, including those that have not
486+
* completed.
487+
*
488+
* @since 0.14
489+
*/
490+
public static final MeasureLong GRPC_SERVER_STARTED_RPCS =
491+
Measure.MeasureLong.create(
492+
"grpc.io/server/started_rpcs", "Number of started server RPCs.", COUNT);
493+
472494
private RpcMeasureConstants() {}
473495
}

‎contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcViewConstants.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,15 @@
2323
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_CLIENT_SENT_BYTES_PER_RPC;
2424
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_CLIENT_SENT_MESSAGES_PER_RPC;
2525
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_CLIENT_SERVER_LATENCY;
26+
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_CLIENT_STARTED_RPCS;
2627
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_CLIENT_STATUS;
2728
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_METHOD;
2829
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_RECEIVED_BYTES_PER_RPC;
2930
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC;
3031
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_SENT_BYTES_PER_RPC;
3132
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_SENT_MESSAGES_PER_RPC;
3233
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_SERVER_LATENCY;
34+
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_STARTED_RPCS;
3335
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.GRPC_SERVER_STATUS;
3436
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.RPC_CLIENT_ERROR_COUNT;
3537
import static io.opencensus.contrib.grpc.metrics.RpcMeasureConstants.RPC_CLIENT_FINISHED_COUNT;
@@ -302,6 +304,7 @@ public final class RpcViewConstants {
302304
* Cumulative {@link View} for started client RPCs.
303305
*
304306
* @since 0.12
307+
* @deprecated in favor of {@link #GRPC_CLIENT_STARTED_RPC_VIEW}.
305308
*/
306309
@Deprecated
307310
public static final View RPC_CLIENT_STARTED_COUNT_CUMULATIVE_VIEW =
@@ -424,6 +427,19 @@ public final class RpcViewConstants {
424427
COUNT,
425428
Arrays.asList(GRPC_CLIENT_METHOD, GRPC_CLIENT_STATUS));
426429

430+
/**
431+
* {@link View} for started client RPCs.
432+
*
433+
* @since 0.14
434+
*/
435+
public static final View GRPC_CLIENT_STARTED_RPC_VIEW =
436+
View.create(
437+
View.Name.create("grpc.io/client/started_rpcs"),
438+
"Number of started client RPCs",
439+
GRPC_CLIENT_STARTED_RPCS,
440+
COUNT,
441+
Arrays.asList(GRPC_CLIENT_METHOD));
442+
427443
// Rpc server cumulative views.
428444

429445
/**
@@ -574,6 +590,7 @@ public final class RpcViewConstants {
574590
* Cumulative {@link View} for started server RPCs.
575591
*
576592
* @since 0.12
593+
* @deprecated in favor of {@link #GRPC_SERVER_STARTED_RPC_VIEW}.
577594
*/
578595
@Deprecated
579596
public static final View RPC_SERVER_STARTED_COUNT_CUMULATIVE_VIEW =
@@ -683,6 +700,19 @@ public final class RpcViewConstants {
683700
COUNT,
684701
Arrays.asList(GRPC_SERVER_METHOD, GRPC_SERVER_STATUS));
685702

703+
/**
704+
* {@link View} for started server RPCs.
705+
*
706+
* @since 0.14
707+
*/
708+
public static final View GRPC_SERVER_STARTED_RPC_VIEW =
709+
View.create(
710+
View.Name.create("grpc.io/server/started_rpcs"),
711+
"Number of started server RPCs",
712+
GRPC_SERVER_STARTED_RPCS,
713+
COUNT,
714+
Arrays.asList(GRPC_SERVER_METHOD));
715+
686716
// Interval Stats
687717

688718
// RPC client interval views.

‎contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcViews.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,14 @@ public final class RpcViews {
6565
RpcViewConstants.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC_VIEW,
6666
RpcViewConstants.GRPC_CLIENT_SERVER_LATENCY_VIEW,
6767
RpcViewConstants.GRPC_CLIENT_COMPLETED_RPC_VIEW,
68+
RpcViewConstants.GRPC_CLIENT_STARTED_RPC_VIEW,
6869
RpcViewConstants.GRPC_SERVER_SERVER_LATENCY_VIEW,
6970
RpcViewConstants.GRPC_SERVER_SENT_BYTES_PER_RPC_VIEW,
7071
RpcViewConstants.GRPC_SERVER_RECEIVED_BYTES_PER_RPC_VIEW,
7172
RpcViewConstants.GRPC_SERVER_SENT_MESSAGES_PER_RPC_VIEW,
7273
RpcViewConstants.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC_VIEW,
73-
RpcViewConstants.GRPC_SERVER_COMPLETED_RPC_VIEW);
74+
RpcViewConstants.GRPC_SERVER_COMPLETED_RPC_VIEW,
75+
RpcViewConstants.GRPC_SERVER_STARTED_RPC_VIEW);
7476

7577
@VisibleForTesting
7678
static final ImmutableSet<View> RPC_INTERVAL_VIEWS_SET =

‎contrib/grpc_metrics/src/test/java/io/opencensus/contrib/grpc/metrics/RpcMeasureConstantsTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ public void testConstants() {
5454
assertThat(RpcMeasureConstants.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC).isNotNull();
5555
assertThat(RpcMeasureConstants.GRPC_CLIENT_SERVER_LATENCY).isNotNull();
5656
assertThat(RpcMeasureConstants.GRPC_CLIENT_ROUNDTRIP_LATENCY).isNotNull();
57+
assertThat(RpcMeasureConstants.GRPC_CLIENT_STARTED_RPCS).isNotNull();
5758

5859
// Test server measurement descriptors.
5960
assertThat(RpcMeasureConstants.RPC_SERVER_ERROR_COUNT).isNotNull();
@@ -72,5 +73,6 @@ public void testConstants() {
7273
assertThat(RpcMeasureConstants.GRPC_SERVER_RECEIVED_BYTES_PER_RPC).isNotNull();
7374
assertThat(RpcMeasureConstants.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC).isNotNull();
7475
assertThat(RpcMeasureConstants.GRPC_SERVER_SERVER_LATENCY).isNotNull();
76+
assertThat(RpcMeasureConstants.GRPC_SERVER_STARTED_RPCS).isNotNull();
7577
}
7678
}

‎contrib/grpc_metrics/src/test/java/io/opencensus/contrib/grpc/metrics/RpcViewConstantsTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ public void testConstants() {
108108
assertThat(RpcViewConstants.GRPC_CLIENT_SENT_MESSAGES_PER_RPC_VIEW).isNotNull();
109109
assertThat(RpcViewConstants.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC_VIEW).isNotNull();
110110
assertThat(RpcViewConstants.GRPC_CLIENT_SERVER_LATENCY_VIEW).isNotNull();
111+
assertThat(RpcViewConstants.GRPC_CLIENT_STARTED_RPC_VIEW).isNotNull();
111112

112113
// Test server distribution view descriptors.
113114
assertThat(RpcViewConstants.RPC_SERVER_ERROR_COUNT_VIEW).isNotNull();
@@ -124,6 +125,7 @@ public void testConstants() {
124125
assertThat(RpcViewConstants.GRPC_SERVER_SENT_MESSAGES_PER_RPC_VIEW).isNotNull();
125126
assertThat(RpcViewConstants.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC_VIEW).isNotNull();
126127
assertThat(RpcViewConstants.GRPC_SERVER_SERVER_LATENCY_VIEW).isNotNull();
128+
assertThat(RpcViewConstants.GRPC_SERVER_STARTED_RPC_VIEW).isNotNull();
127129

128130
// Test client interval view descriptors.
129131
assertThat(RpcViewConstants.RPC_CLIENT_ERROR_COUNT_MINUTE_VIEW).isNotNull();

0 commit comments

Comments
 (0)