Skip to content

Latest commit

 

History

History
95 lines (74 loc) · 5.58 KB

grpc.md

File metadata and controls

95 lines (74 loc) · 5.58 KB
Raw

Semantic Conventions for gRPC

Status: Experimental

The Semantic Conventions for gRPC extend and override the RPC spans and RPC metrics Semantic Conventions that describe common RPC operations attributes in addition to the Semantic Conventions described on this page.

gRPC Attributes

rpc.system MUST be set to "grpc".

Below is a table of attributes that SHOULD be included on client and server gRPC measurements.

Attribute Type Description Examples Requirement Level Stability
rpc.grpc.status_code int The numeric status code of the gRPC request. 0; 1; 2 Required Experimental
rpc.grpc.request.metadata.<key> string[] gRPC request metadata, <key> being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [1] rpc.grpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"] Opt-In Experimental
rpc.grpc.response.metadata.<key> string[] gRPC response metadata, <key> being the normalized gRPC Metadata key (lowercase), the value being the metadata values. [2] rpc.grpc.response.metadata.my-custom-metadata-attribute=["attribute_value"] Opt-In Experimental

[1]: 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]: 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.

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 Experimental
1 CANCELLED Experimental
2 UNKNOWN Experimental
3 INVALID_ARGUMENT Experimental
4 DEADLINE_EXCEEDED Experimental
5 NOT_FOUND Experimental
6 ALREADY_EXISTS Experimental
7 PERMISSION_DENIED Experimental
8 RESOURCE_EXHAUSTED Experimental
9 FAILED_PRECONDITION Experimental
10 ABORTED Experimental
11 OUT_OF_RANGE Experimental
12 UNIMPLEMENTED Experimental
13 INTERNAL Experimental
14 UNAVAILABLE Experimental
15 DATA_LOSS Experimental
16 UNAUTHENTICATED Experimental

gRPC Status

The table below describes when the Span Status MUST be set to Error or remain unset depending on the gRPC status code and Span Kind.

gRPC Status Code SpanKind.SERVER Span Status SpanKind.CLIENT Span Status
OK unset unset
CANCELLED unset Error
UNKNOWN Error Error
INVALID_ARGUMENT unset Error
DEADLINE_EXCEEDED Error Error
NOT_FOUND unset Error
ALREADY_EXISTS unset Error
PERMISSION_DENIED unset Error
RESOURCE_EXHAUSTED unset Error
FAILED_PRECONDITION unset Error
ABORTED unset Error
OUT_OF_RANGE unset Error
UNIMPLEMENTED Error Error
INTERNAL Error Error
UNAVAILABLE Error Error
DATA_LOSS Error Error
UNAUTHENTICATED unset Error