semantic-conventions/semantic_conventions/trace/rpc.yaml

81 lines
2.5 KiB
YAML

groups:
- id: rpc
prefix: rpc
brief: 'This document defines semantic conventions for remote procedure calls.'
attributes:
- id: system
type: string
required: always
brief: 'A string identifying the remoting system.'
examples: ["grpc", "java_rmi", "wcf"]
- id: service
type: string
required:
conditional: "No, but recommended"
brief: 'The full name of the service being called, including its package name, if applicable.'
examples: "myservice.EchoService"
- id: method
type: string
required:
conditional: "No, but recommended"
brief: 'The name of the method being called, must be equal to the $method part in the span name.'
examples: "exampleMethod"
- ref: net.peer.ip
- ref: net.peer.name
- ref: net.peer.port
required:
conditional: "See below"
- ref: net.transport
required:
conditional: "See below"
constraints:
- any_of:
- net.peer.ip
- net.peer.name
- include: network
- id: rpc.grpc
prefix: rpc.grpc
extends: rpc
brief: 'Tech-specific attributes for gRPC.'
attributes:
- id: status_code
type:
members:
- id: OK
value: 0
- id: CANCELLED
value: 1
- id: UNKNOWN
value: 2
- id: INVALID_ARGUMENT
value: 3
- id: DEADLINE_EXCEEDED
value: 4
- id: NOT_FOUND
value: 5
- id: ALREADY_EXISTS
value: 6
- id: PERMISSION_DENIED
value: 7
- id: RESOURCE_EXHAUSTED
value: 8
- id: FAILED_PRECONDITION
value: 9
- id: ABORTED
value: 10
- id: OUT_OF_RANGE
value: 11
- id: UNIMPLEMENTED
value: 12
- id: INTERNAL
value: 13
- id: UNAVAILABLE
value: 14
- id: DATA_LOSS
value: 15
- id: UNAUTHENTICATED
value: 16
required: always
brief: "The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request."
examples: [0, 1, 16]