View Source OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for RPC metrics.
Summary
Functions
Measures the duration of outbound RPC.
Measures the size of RPC request messages (uncompressed).
Measures the number of messages received per RPC.
Measures the size of RPC response messages (uncompressed).
Measures the number of messages sent per RPC.
Measures the duration of inbound RPC.
Measures the size of RPC request messages (uncompressed).
Measures the number of messages received per RPC.
Measures the size of RPC response messages (uncompressed).
Measures the number of messages sent per RPC.
Functions
@spec rpc_client_duration() :: :"rpc.client.duration"
Measures the duration of outbound RPC.
Instrument: histogram
Unit: ms
Notes
While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.
Streaming: N/A.
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_client_duration()
:"rpc.client.duration"?RPC_CLIENT_DURATION.
'rpc.client.duration'@spec rpc_client_request_size() :: :"rpc.client.request.size"
Measures the size of RPC request messages (uncompressed).
Instrument: histogram
Unit: By
Notes
Streaming: Recorded per message in a streaming batch
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_client_request_size()
:"rpc.client.request.size"?RPC_CLIENT_REQUEST_SIZE.
'rpc.client.request.size'@spec rpc_client_requests_per_rpc() :: :"rpc.client.requests_per_rpc"
Measures the number of messages received per RPC.
Instrument: histogram
Unit: {count}
Notes
Should be 1 for all non-streaming RPCs.
Streaming: This metric is required for server and client streaming RPCs
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_client_requests_per_rpc()
:"rpc.client.requests_per_rpc"?RPC_CLIENT_REQUESTS_PER_RPC.
'rpc.client.requests_per_rpc'@spec rpc_client_response_size() :: :"rpc.client.response.size"
Measures the size of RPC response messages (uncompressed).
Instrument: histogram
Unit: By
Notes
Streaming: Recorded per response in a streaming batch
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_client_response_size()
:"rpc.client.response.size"?RPC_CLIENT_RESPONSE_SIZE.
'rpc.client.response.size'@spec rpc_client_responses_per_rpc() :: :"rpc.client.responses_per_rpc"
Measures the number of messages sent per RPC.
Instrument: histogram
Unit: {count}
Notes
Should be 1 for all non-streaming RPCs.
Streaming: This metric is required for server and client streaming RPCs
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_client_responses_per_rpc()
:"rpc.client.responses_per_rpc"?RPC_CLIENT_RESPONSES_PER_RPC.
'rpc.client.responses_per_rpc'@spec rpc_server_duration() :: :"rpc.server.duration"
Measures the duration of inbound RPC.
Instrument: histogram
Unit: ms
Notes
While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.
Streaming: N/A.
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_server_duration()
:"rpc.server.duration"?RPC_SERVER_DURATION.
'rpc.server.duration'@spec rpc_server_request_size() :: :"rpc.server.request.size"
Measures the size of RPC request messages (uncompressed).
Instrument: histogram
Unit: By
Notes
Streaming: Recorded per message in a streaming batch
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_server_request_size()
:"rpc.server.request.size"?RPC_SERVER_REQUEST_SIZE.
'rpc.server.request.size'@spec rpc_server_requests_per_rpc() :: :"rpc.server.requests_per_rpc"
Measures the number of messages received per RPC.
Instrument: histogram
Unit: {count}
Notes
Should be 1 for all non-streaming RPCs.
Streaming : This metric is required for server and client streaming RPCs
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_server_requests_per_rpc()
:"rpc.server.requests_per_rpc"?RPC_SERVER_REQUESTS_PER_RPC.
'rpc.server.requests_per_rpc'@spec rpc_server_response_size() :: :"rpc.server.response.size"
Measures the size of RPC response messages (uncompressed).
Instrument: histogram
Unit: By
Notes
Streaming: Recorded per response in a streaming batch
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_server_response_size()
:"rpc.server.response.size"?RPC_SERVER_RESPONSE_SIZE.
'rpc.server.response.size'@spec rpc_server_responses_per_rpc() :: :"rpc.server.responses_per_rpc"
Measures the number of messages sent per RPC.
Instrument: histogram
Unit: {count}
Notes
Should be 1 for all non-streaming RPCs.
Streaming: This metric is required for server and client streaming RPCs
iex> OpenTelemetry.SemConv.Incubating.Metrics.RPCMetrics.rpc_server_responses_per_rpc()
:"rpc.server.responses_per_rpc"?RPC_SERVER_RESPONSES_PER_RPC.
'rpc.server.responses_per_rpc'