Class RpcMeasureConstants

java.lang.Object

io.opencensus.contrib.grpc.metrics.RpcMeasureConstants

public final class RpcMeasureConstants
extends Object

Constants for collecting rpc stats.

Since:

0.8

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BYTE	Unit string for byte.
private static final String	COUNT	Unit string for count.
static final TagKey	GRPC_CLIENT_METHOD	Tag key that represents a client gRPC method.
static final Measure.MeasureDouble	GRPC_CLIENT_RECEIVED_BYTES_PER_METHOD	Measure for total bytes received per method, recorded real-time as bytes are received.
static final Measure.MeasureDouble	GRPC_CLIENT_RECEIVED_BYTES_PER_RPC	Measure for total bytes received across all response messages per RPC.
static final Measure.MeasureLong	GRPC_CLIENT_RECEIVED_MESSAGES_PER_METHOD	Measure for total client received messages.
static final Measure.MeasureLong	GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC	Measure for number of response messages received per RPC.
static final Measure.MeasureLong	GRPC_CLIENT_RETRIES_PER_CALL	Measure for total number of retry or hedging attempts excluding transparent retries made during the client call.
static final Measure.MeasureDouble	GRPC_CLIENT_RETRY_DELAY_PER_CALL	Measure for total time of delay while there is no active attempt during the client call.
static final Measure.MeasureDouble	GRPC_CLIENT_ROUNDTRIP_LATENCY	Measure for gRPC client roundtrip latency in milliseconds.
static final Measure.MeasureDouble	GRPC_CLIENT_SENT_BYTES_PER_METHOD	Measure for total bytes sent per method, recorded real-time as bytes are sent.
static final Measure.MeasureDouble	GRPC_CLIENT_SENT_BYTES_PER_RPC	Measure for total bytes sent across all request messages per RPC.
static final Measure.MeasureLong	GRPC_CLIENT_SENT_MESSAGES_PER_METHOD	Measure for total client sent messages.
static final Measure.MeasureLong	GRPC_CLIENT_SENT_MESSAGES_PER_RPC	Measure for number of messages sent in the RPC.
static final Measure.MeasureDouble	GRPC_CLIENT_SERVER_LATENCY	Measure for gRPC server latency in milliseconds.
static final Measure.MeasureLong	GRPC_CLIENT_STARTED_RPCS	Measure for total number of client RPCs ever opened, including those that have not completed.
static final TagKey	GRPC_CLIENT_STATUS	Tag key that represents a client gRPC canonical status.
static final Measure.MeasureLong	GRPC_CLIENT_TRANSPARENT_RETRIES_PER_CALL	Measure for total number of transparent retries made during the client call.
static final TagKey	GRPC_SERVER_METHOD	Tag key that represents a server gRPC method.
static final Measure.MeasureDouble	GRPC_SERVER_RECEIVED_BYTES_PER_METHOD	Measure for total bytes received per method, recorded real-time as bytes are received.
static final Measure.MeasureDouble	GRPC_SERVER_RECEIVED_BYTES_PER_RPC	Measure for total bytes received across all messages per RPC.
static final Measure.MeasureLong	GRPC_SERVER_RECEIVED_MESSAGES_PER_METHOD	Measure for total server received messages.
static final Measure.MeasureLong	GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC	Measure for number of messages received in each RPC.
static final Measure.MeasureDouble	GRPC_SERVER_SENT_BYTES_PER_METHOD	Measure for total bytes sent per method, recorded real-time as bytes are sent.
static final Measure.MeasureDouble	GRPC_SERVER_SENT_BYTES_PER_RPC	Measure for total bytes sent across all response messages per RPC.
static final Measure.MeasureLong	GRPC_SERVER_SENT_MESSAGES_PER_METHOD	Measure for total server sent messages.
static final Measure.MeasureLong	GRPC_SERVER_SENT_MESSAGES_PER_RPC	Measure for number of messages sent in each RPC.
static final Measure.MeasureDouble	GRPC_SERVER_SERVER_LATENCY	Measure for gRPC server latency in milliseconds.
static final Measure.MeasureLong	GRPC_SERVER_STARTED_RPCS	Measure for total number of server RPCs ever opened, including those that have not completed.
static final TagKey	GRPC_SERVER_STATUS	Tag key that represents a server gRPC canonical status.
private static final String	MILLISECOND	Unit string for millisecond.
static final Measure.MeasureLong	RPC_CLIENT_ERROR_COUNT	Deprecated. because error counts can be computed on your metrics backend by totalling the different per-status values.
static final Measure.MeasureLong	RPC_CLIENT_FINISHED_COUNT	Deprecated. since finished count can be inferred with a Count aggregation on GRPC_CLIENT_SERVER_LATENCY.
static final Measure.MeasureDouble	RPC_CLIENT_REQUEST_BYTES	Deprecated. in favor of GRPC_CLIENT_SENT_BYTES_PER_RPC.
static final Measure.MeasureLong	RPC_CLIENT_REQUEST_COUNT	Deprecated. in favor of GRPC_CLIENT_SENT_MESSAGES_PER_RPC.
static final Measure.MeasureDouble	RPC_CLIENT_RESPONSE_BYTES	Deprecated. in favor of GRPC_CLIENT_RECEIVED_BYTES_PER_RPC.
static final Measure.MeasureLong	RPC_CLIENT_RESPONSE_COUNT	Deprecated. in favor of GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC.
static final Measure.MeasureDouble	RPC_CLIENT_ROUNDTRIP_LATENCY	Deprecated. in favor of GRPC_CLIENT_ROUNDTRIP_LATENCY.
static final Measure.MeasureDouble	RPC_CLIENT_SERVER_ELAPSED_TIME	Deprecated. in favor of GRPC_CLIENT_SERVER_LATENCY.
static final Measure.MeasureLong	RPC_CLIENT_STARTED_COUNT	Deprecated. in favor of GRPC_CLIENT_STARTED_RPCS.
static final Measure.MeasureDouble	RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES	Deprecated. in favor of GRPC_CLIENT_SENT_BYTES_PER_RPC.
static final Measure.MeasureDouble	RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES	Deprecated. in favor of GRPC_CLIENT_RECEIVED_BYTES_PER_RPC.
static final TagKey	RPC_METHOD	Deprecated. in favor of GRPC_CLIENT_METHOD and GRPC_SERVER_METHOD.
static final Measure.MeasureLong	RPC_SERVER_ERROR_COUNT	Deprecated. because error counts can be computed on your metrics backend by totalling the different per-status values.
static final Measure.MeasureLong	RPC_SERVER_FINISHED_COUNT	Deprecated. since finished count can be inferred with a Count aggregation on GRPC_SERVER_SERVER_LATENCY.
static final Measure.MeasureDouble	RPC_SERVER_REQUEST_BYTES	Deprecated. in favor of GRPC_SERVER_RECEIVED_BYTES_PER_RPC.
static final Measure.MeasureLong	RPC_SERVER_REQUEST_COUNT	Deprecated. in favor of GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC.
static final Measure.MeasureDouble	RPC_SERVER_RESPONSE_BYTES	Deprecated. in favor of GRPC_SERVER_SENT_BYTES_PER_RPC.
static final Measure.MeasureLong	RPC_SERVER_RESPONSE_COUNT	Deprecated. in favor of GRPC_SERVER_SENT_MESSAGES_PER_RPC.
static final Measure.MeasureDouble	RPC_SERVER_SERVER_ELAPSED_TIME	Deprecated. in favor of GRPC_SERVER_SERVER_LATENCY.
static final Measure.MeasureDouble	RPC_SERVER_SERVER_LATENCY	Deprecated. in favor of GRPC_SERVER_SERVER_LATENCY.
static final Measure.MeasureLong	RPC_SERVER_STARTED_COUNT	Deprecated. in favor of GRPC_SERVER_STARTED_RPCS.
static final Measure.MeasureDouble	RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES	Deprecated. in favor of GRPC_SERVER_RECEIVED_BYTES_PER_RPC.
static final Measure.MeasureDouble	RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES	Deprecated. in favor of GRPC_SERVER_SENT_BYTES_PER_RPC.
static final TagKey	RPC_STATUS	Deprecated. in favor of GRPC_CLIENT_STATUS and GRPC_SERVER_STATUS.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RpcMeasureConstants()

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RPC_STATUS

@Deprecated
public static final TagKey RPC_STATUS

Deprecated.

in favor of GRPC_CLIENT_STATUS and GRPC_SERVER_STATUS.

Tag key that represents a gRPC canonical status. Refer to https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.

Since:

0.8

RPC_METHOD

@Deprecated
public static final TagKey RPC_METHOD

Deprecated.

in favor of GRPC_CLIENT_METHOD and GRPC_SERVER_METHOD.

Tag key that represents a gRPC method.

Since:

0.8

GRPC_CLIENT_STATUS

public static final TagKey GRPC_CLIENT_STATUS

Tag key that represents a client gRPC canonical status. Refer to https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.

GRPC_CLIENT_STATUS is set when an outgoing request finishes and is only available around metrics recorded at the end of the outgoing request.

Since:

0.13

GRPC_SERVER_STATUS

public static final TagKey GRPC_SERVER_STATUS

Tag key that represents a server gRPC canonical status. Refer to https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.

GRPC_SERVER_STATUS is set when an incoming request finishes and is only available around metrics recorded at the end of the incoming request.

Since:

0.13

GRPC_CLIENT_METHOD

public static final TagKey GRPC_CLIENT_METHOD

Tag key that represents a client gRPC method.

GRPC_CLIENT_METHOD is set when an outgoing request starts and is available in all the recorded metrics.

Since:

0.13

GRPC_SERVER_METHOD

public static final TagKey GRPC_SERVER_METHOD

Tag key that represents a server gRPC method.

GRPC_SERVER_METHOD is set when an incoming request starts and is available in the context for the entire RPC call handling.

Since:

0.13

BYTE

private static final String BYTE

Unit string for byte.

Since:

0.8

See Also:

• Constant Field Values

COUNT

private static final String COUNT

Unit string for count.

Since:

0.8

See Also:

• Constant Field Values

MILLISECOND

private static final String MILLISECOND

Unit string for millisecond.

Since:

0.8

See Also:

• Constant Field Values

GRPC_CLIENT_SENT_BYTES_PER_RPC

public static final Measure.MeasureDouble GRPC_CLIENT_SENT_BYTES_PER_RPC

Measure for total bytes sent across all request messages per RPC.

Since:

0.13

GRPC_CLIENT_RECEIVED_BYTES_PER_RPC

public static final Measure.MeasureDouble GRPC_CLIENT_RECEIVED_BYTES_PER_RPC

Measure for total bytes received across all response messages per RPC.

Since:

0.13

GRPC_CLIENT_SENT_BYTES_PER_METHOD

public static final Measure.MeasureDouble GRPC_CLIENT_SENT_BYTES_PER_METHOD

Measure for total bytes sent per method, recorded real-time as bytes are sent.

Since:

0.18

GRPC_CLIENT_RECEIVED_BYTES_PER_METHOD

public static final Measure.MeasureDouble GRPC_CLIENT_RECEIVED_BYTES_PER_METHOD

Measure for total bytes received per method, recorded real-time as bytes are received.

Since:

0.18

GRPC_CLIENT_SENT_MESSAGES_PER_METHOD

public static final Measure.MeasureLong GRPC_CLIENT_SENT_MESSAGES_PER_METHOD

Measure for total client sent messages.

Since:

0.18

GRPC_CLIENT_RECEIVED_MESSAGES_PER_METHOD

public static final Measure.MeasureLong GRPC_CLIENT_RECEIVED_MESSAGES_PER_METHOD

Measure for total client received messages.

Since:

0.18

GRPC_CLIENT_ROUNDTRIP_LATENCY

public static final Measure.MeasureDouble GRPC_CLIENT_ROUNDTRIP_LATENCY

Measure for gRPC client roundtrip latency in milliseconds.

Since:

0.13

GRPC_CLIENT_SENT_MESSAGES_PER_RPC

public static final Measure.MeasureLong GRPC_CLIENT_SENT_MESSAGES_PER_RPC

Measure for number of messages sent in the RPC.

Since:

0.13

GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC

public static final Measure.MeasureLong GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC

Measure for number of response messages received per RPC.

Since:

0.13

GRPC_CLIENT_SERVER_LATENCY

public static final Measure.MeasureDouble GRPC_CLIENT_SERVER_LATENCY

Measure for gRPC server latency in milliseconds.

Since:

0.13

GRPC_CLIENT_STARTED_RPCS

public static final Measure.MeasureLong GRPC_CLIENT_STARTED_RPCS

Measure for total number of client RPCs ever opened, including those that have not completed.

Since:

0.14

GRPC_CLIENT_RETRIES_PER_CALL

public static final Measure.MeasureLong GRPC_CLIENT_RETRIES_PER_CALL

Measure for total number of retry or hedging attempts excluding transparent retries made during the client call.

Since:

0.31.0

GRPC_CLIENT_TRANSPARENT_RETRIES_PER_CALL

public static final Measure.MeasureLong GRPC_CLIENT_TRANSPARENT_RETRIES_PER_CALL

Measure for total number of transparent retries made during the client call.

Since:

0.28

GRPC_CLIENT_RETRY_DELAY_PER_CALL

public static final Measure.MeasureDouble GRPC_CLIENT_RETRY_DELAY_PER_CALL

Measure for total time of delay while there is no active attempt during the client call.

Since:

0.28

RPC_CLIENT_ERROR_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_CLIENT_ERROR_COUNT

Deprecated.

because error counts can be computed on your metrics backend by totalling the different per-status values.

Measure for gRPC client error counts.

Since:

0.8

RPC_CLIENT_REQUEST_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_CLIENT_REQUEST_BYTES

Deprecated.

in favor of GRPC_CLIENT_SENT_BYTES_PER_RPC.

Measure for gRPC client request bytes.

Since:

0.8

RPC_CLIENT_RESPONSE_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_CLIENT_RESPONSE_BYTES

Deprecated.

in favor of GRPC_CLIENT_RECEIVED_BYTES_PER_RPC.

Measure for gRPC client response bytes.

Since:

0.8

RPC_CLIENT_ROUNDTRIP_LATENCY

@Deprecated
public static final Measure.MeasureDouble RPC_CLIENT_ROUNDTRIP_LATENCY

Deprecated.

in favor of GRPC_CLIENT_ROUNDTRIP_LATENCY.

Measure for gRPC client roundtrip latency in milliseconds.

Since:

0.8

RPC_CLIENT_SERVER_ELAPSED_TIME

@Deprecated
public static final Measure.MeasureDouble RPC_CLIENT_SERVER_ELAPSED_TIME

Deprecated.

in favor of GRPC_CLIENT_SERVER_LATENCY.

Measure for gRPC client server elapsed time in milliseconds.

Since:

0.8

RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_CLIENT_UNCOMPRESSED_REQUEST_BYTES

Deprecated.

in favor of GRPC_CLIENT_SENT_BYTES_PER_RPC.

Measure for gRPC client uncompressed request bytes.

Since:

0.8

RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_CLIENT_UNCOMPRESSED_RESPONSE_BYTES

Deprecated.

in favor of GRPC_CLIENT_RECEIVED_BYTES_PER_RPC.

Measure for gRPC client uncompressed response bytes.

Since:

0.8

RPC_CLIENT_STARTED_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_CLIENT_STARTED_COUNT

Deprecated.

in favor of GRPC_CLIENT_STARTED_RPCS.

Measure for number of started client RPCs.

Since:

0.8

RPC_CLIENT_FINISHED_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_CLIENT_FINISHED_COUNT

Deprecated.

since finished count can be inferred with a Count aggregation on GRPC_CLIENT_SERVER_LATENCY.

Measure for number of finished client RPCs.

Since:

0.8

RPC_CLIENT_REQUEST_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_CLIENT_REQUEST_COUNT

Deprecated.

in favor of GRPC_CLIENT_SENT_MESSAGES_PER_RPC.

Measure for client RPC request message counts.

Since:

0.8

RPC_CLIENT_RESPONSE_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_CLIENT_RESPONSE_COUNT

Deprecated.

in favor of GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC.

Measure for client RPC response message counts.

Since:

0.8

GRPC_SERVER_SENT_BYTES_PER_RPC

public static final Measure.MeasureDouble GRPC_SERVER_SENT_BYTES_PER_RPC

Measure for total bytes sent across all response messages per RPC.

Since:

0.13

GRPC_SERVER_RECEIVED_BYTES_PER_RPC

public static final Measure.MeasureDouble GRPC_SERVER_RECEIVED_BYTES_PER_RPC

Measure for total bytes received across all messages per RPC.

Since:

0.13

GRPC_SERVER_SENT_BYTES_PER_METHOD

public static final Measure.MeasureDouble GRPC_SERVER_SENT_BYTES_PER_METHOD

Measure for total bytes sent per method, recorded real-time as bytes are sent.

Since:

0.18

GRPC_SERVER_RECEIVED_BYTES_PER_METHOD

public static final Measure.MeasureDouble GRPC_SERVER_RECEIVED_BYTES_PER_METHOD

Measure for total bytes received per method, recorded real-time as bytes are received.

Since:

0.18

GRPC_SERVER_SENT_MESSAGES_PER_METHOD

public static final Measure.MeasureLong GRPC_SERVER_SENT_MESSAGES_PER_METHOD

Measure for total server sent messages.

Since:

0.18

GRPC_SERVER_RECEIVED_MESSAGES_PER_METHOD

public static final Measure.MeasureLong GRPC_SERVER_RECEIVED_MESSAGES_PER_METHOD

Measure for total server received messages.

Since:

0.18

GRPC_SERVER_SENT_MESSAGES_PER_RPC

public static final Measure.MeasureLong GRPC_SERVER_SENT_MESSAGES_PER_RPC

Measure for number of messages sent in each RPC.

Since:

0.13

GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC

public static final Measure.MeasureLong GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC

Measure for number of messages received in each RPC.

Since:

0.13

GRPC_SERVER_SERVER_LATENCY

public static final Measure.MeasureDouble GRPC_SERVER_SERVER_LATENCY

Measure for gRPC server latency in milliseconds.

Since:

0.13

GRPC_SERVER_STARTED_RPCS

public static final Measure.MeasureLong GRPC_SERVER_STARTED_RPCS

Measure for total number of server RPCs ever opened, including those that have not completed.

Since:

0.14

RPC_SERVER_ERROR_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_SERVER_ERROR_COUNT

Deprecated.

because error counts can be computed on your metrics backend by totalling the different per-status values.

Measure for gRPC server error counts.

Since:

0.8

RPC_SERVER_REQUEST_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_SERVER_REQUEST_BYTES

Deprecated.

in favor of GRPC_SERVER_RECEIVED_BYTES_PER_RPC.

Measure for gRPC server request bytes.

Since:

0.8

RPC_SERVER_RESPONSE_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_SERVER_RESPONSE_BYTES

Deprecated.

in favor of GRPC_SERVER_SENT_BYTES_PER_RPC.

Measure for gRPC server response bytes.

Since:

0.8

RPC_SERVER_SERVER_ELAPSED_TIME

@Deprecated
public static final Measure.MeasureDouble RPC_SERVER_SERVER_ELAPSED_TIME

Deprecated.

in favor of GRPC_SERVER_SERVER_LATENCY.

Measure for gRPC server elapsed time in milliseconds.

Since:

0.8

RPC_SERVER_SERVER_LATENCY

@Deprecated
public static final Measure.MeasureDouble RPC_SERVER_SERVER_LATENCY

Deprecated.

in favor of GRPC_SERVER_SERVER_LATENCY.

Measure for gRPC server latency in milliseconds.

Since:

0.8

RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_SERVER_UNCOMPRESSED_REQUEST_BYTES

Deprecated.

in favor of GRPC_SERVER_RECEIVED_BYTES_PER_RPC.

Measure for gRPC server uncompressed request bytes.

Since:

0.8

RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES

@Deprecated
public static final Measure.MeasureDouble RPC_SERVER_UNCOMPRESSED_RESPONSE_BYTES

Deprecated.

in favor of GRPC_SERVER_SENT_BYTES_PER_RPC.

Measure for gRPC server uncompressed response bytes.

Since:

0.8

RPC_SERVER_STARTED_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_SERVER_STARTED_COUNT

Deprecated.

in favor of GRPC_SERVER_STARTED_RPCS.

Measure for number of started server RPCs.

Since:

0.8

RPC_SERVER_FINISHED_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_SERVER_FINISHED_COUNT

Deprecated.

since finished count can be inferred with a Count aggregation on GRPC_SERVER_SERVER_LATENCY.

Measure for number of finished server RPCs.

Since:

0.8

RPC_SERVER_REQUEST_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_SERVER_REQUEST_COUNT

Deprecated.

in favor of GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC.

Measure for server RPC request message counts.

Since:

0.8

RPC_SERVER_RESPONSE_COUNT

@Deprecated
public static final Measure.MeasureLong RPC_SERVER_RESPONSE_COUNT

Deprecated.

in favor of GRPC_SERVER_SENT_MESSAGES_PER_RPC.

Measure for server RPC response message counts.

Since:

0.8

Constructor Details

RpcMeasureConstants

private RpcMeasureConstants()