Skip to content

Latest commit

 

History

History
133 lines (103 loc) · 13.6 KB

rpc.md

File metadata and controls

133 lines (103 loc) · 13.6 KB

RPC

Remote Procedure Call (RPC) Attributes

This document defines attributes for remote procedure calls.

Attribute Type Description Examples Stability
rpc.connect_rpc.error_code string The error codes of the Connect request. Error codes are always string values. cancelled; unknown; invalid_argument Development
rpc.connect_rpc.request.metadata.<key> string[] Connect request metadata, <key> being the normalized Connect Metadata key (lowercase), the value being the metadata values. [1] rpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"] Development
rpc.connect_rpc.response.metadata.<key> string[] Connect response metadata, <key> being the normalized Connect Metadata key (lowercase), the value being the metadata values. [2] rpc.response.metadata.my-custom-metadata-attribute=["attribute_value"] Development
rpc.grpc.request.metadata.<key> string[] gRPC request metadata, <key> being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [3] rpc.grpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"] Development
rpc.grpc.response.metadata.<key> string[] gRPC response metadata, <key> being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [4] rpc.grpc.response.metadata.my-custom-metadata-attribute=["attribute_value"] Development
rpc.grpc.status_code int The numeric status code of the gRPC request. 0; 1; 2 Development
rpc.jsonrpc.error_code int error.code property of response if it is an error response. -32700; 100 Development
rpc.jsonrpc.error_message string error.message property of response if it is an error response. Parse error; User already exists Development
rpc.jsonrpc.request_id string id property of request or response. Since protocol allows id to be int, string, null or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of null value. Omit entirely if this is a notification. 10; request-7; `` Development
rpc.jsonrpc.version string Protocol version as in jsonrpc property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted. 2.0; 1.0 Development
rpc.message.compressed_size int Compressed size of the message in bytes. Development
rpc.message.id int MUST be calculated as two different counters starting from 1 one for sent messages and one for received message. [5] Development
rpc.message.type string Whether this is a received or sent message. SENT; RECEIVED Development
rpc.message.uncompressed_size int Uncompressed size of the message in bytes. Development
rpc.method string The name of the (logical) method being called, must be equal to the $method part in the span name. [6] exampleMethod Development
rpc.service string The full (logical) name of the service being called, including its package name, if applicable. [7] myservice.EchoService Development
rpc.system string A string identifying the remoting system. See below for a list of well-known identifiers. grpc; java_rmi; dotnet_wcf Development

[1] rpc.connect_rpc.request.metadata: Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

[2] rpc.connect_rpc.response.metadata: Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

[3] rpc.grpc.request.metadata: Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

[4] rpc.grpc.response.metadata: Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

[5] rpc.message.id: This way we guarantee that the values will be consistent between different implementations.

[6] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[7] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.connect_rpc.error_code has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
aborted aborted Development
already_exists already_exists Development
cancelled cancelled Development
data_loss data_loss Development
deadline_exceeded deadline_exceeded Development
failed_precondition failed_precondition Development
internal internal Development
invalid_argument invalid_argument Development
not_found not_found Development
out_of_range out_of_range Development
permission_denied permission_denied Development
resource_exhausted resource_exhausted Development
unauthenticated unauthenticated Development
unavailable unavailable Development
unimplemented unimplemented Development
unknown unknown Development

rpc.grpc.status_code has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
0 OK Development
1 CANCELLED Development
2 UNKNOWN Development
3 INVALID_ARGUMENT Development
4 DEADLINE_EXCEEDED Development
5 NOT_FOUND Development
6 ALREADY_EXISTS Development
7 PERMISSION_DENIED Development
8 RESOURCE_EXHAUSTED Development
9 FAILED_PRECONDITION Development
10 ABORTED Development
11 OUT_OF_RANGE Development
12 UNIMPLEMENTED Development
13 INTERNAL Development
14 UNAVAILABLE Development
15 DATA_LOSS Development
16 UNAUTHENTICATED Development

rpc.message.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
RECEIVED received Development
SENT sent Development

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
apache_dubbo Apache Dubbo Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI Development

Deprecated RPC Attributes

Deprecated rpc message attributes.

Attribute Type Description Examples Stability
message.compressed_size int Deprecated, use rpc.message.compressed_size instead. Deprecated
Replaced by rpc.message.compressed_size.
message.id int Deprecated, use rpc.message.id instead. Deprecated
Replaced by rpc.message.id.
message.type string Deprecated, use rpc.message.type instead. SENT; RECEIVED Deprecated
Replaced by rpc.message.type.
message.uncompressed_size int Deprecated, use rpc.message.uncompressed_size instead. Deprecated
Replaced by rpc.message.uncompressed_size.

message.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
RECEIVED received Development
SENT sent Development