Add table for well-known rpc.system values (#2377)
This commit is contained in:
parent
2b026d81db
commit
3aa566575f
|
|
@ -5,10 +5,20 @@ groups:
|
||||||
events: [rpc.message]
|
events: [rpc.message]
|
||||||
attributes:
|
attributes:
|
||||||
- id: system
|
- id: system
|
||||||
type: string
|
|
||||||
required: always
|
required: always
|
||||||
brief: 'A string identifying the remoting system.'
|
brief: 'A string identifying the remoting system. See below for a list of well-known identifiers.'
|
||||||
examples: ["grpc", "java_rmi", "wcf"]
|
type:
|
||||||
|
allow_custom_values: true
|
||||||
|
members:
|
||||||
|
- id: grpc
|
||||||
|
value: 'grpc'
|
||||||
|
brief: 'gRPC'
|
||||||
|
- id: java_rmi
|
||||||
|
value: 'java_rmi'
|
||||||
|
brief: 'Java RMI'
|
||||||
|
- id: dotnet_wcf
|
||||||
|
value: 'dotnet_wcf'
|
||||||
|
brief: '.NET WCF'
|
||||||
- id: service
|
- id: service
|
||||||
type: string
|
type: string
|
||||||
required:
|
required:
|
||||||
|
|
|
||||||
|
|
@ -60,7 +60,7 @@ or not they should be on the server, client or both.
|
||||||
<!-- semconv rpc -->
|
<!-- semconv rpc -->
|
||||||
| Attribute | Type | Description | Examples | Required |
|
| Attribute | Type | Description | Examples | Required |
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
| [`rpc.system`](../../trace/semantic_conventions/rpc.md) | string | A string identifying the remoting system. | `grpc`; `java_rmi`; `wcf` | Yes |
|
| [`rpc.system`](../../trace/semantic_conventions/rpc.md) | string | A string identifying the remoting system. See below for a list of well-known identifiers. | `grpc` | Yes |
|
||||||
| [`rpc.service`](../../trace/semantic_conventions/rpc.md) | string | The full (logical) name of the service being called, including its package name, if applicable. [1] | `myservice.EchoService` | No, but recommended |
|
| [`rpc.service`](../../trace/semantic_conventions/rpc.md) | string | The full (logical) name of the service being called, including its package name, if applicable. [1] | `myservice.EchoService` | No, but recommended |
|
||||||
| [`rpc.method`](../../trace/semantic_conventions/rpc.md) | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [2] | `exampleMethod` | No, but recommended |
|
| [`rpc.method`](../../trace/semantic_conventions/rpc.md) | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [2] | `exampleMethod` | No, but recommended |
|
||||||
| [`net.peer.ip`](../../trace/semantic_conventions/span-general.md) | string | Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6) | `127.0.0.1` | See below |
|
| [`net.peer.ip`](../../trace/semantic_conventions/span-general.md) | string | Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6) | `127.0.0.1` | See below |
|
||||||
|
|
@ -76,6 +76,14 @@ or not they should be on the server, client or both.
|
||||||
|
|
||||||
* [`net.peer.ip`](../../trace/semantic_conventions/span-general.md)
|
* [`net.peer.ip`](../../trace/semantic_conventions/span-general.md)
|
||||||
* [`net.peer.name`](../../trace/semantic_conventions/span-general.md)
|
* [`net.peer.name`](../../trace/semantic_conventions/span-general.md)
|
||||||
|
|
||||||
|
`rpc.system` MUST be one of the following or, if none of the listed values apply, a custom value:
|
||||||
|
|
||||||
|
| Value | Description |
|
||||||
|
|---|---|
|
||||||
|
| `grpc` | gRPC |
|
||||||
|
| `java_rmi` | Java RMI |
|
||||||
|
| `dotnet_wcf` | .NET WCF |
|
||||||
<!-- endsemconv -->
|
<!-- endsemconv -->
|
||||||
|
|
||||||
To avoid high cardinality, implementations should prefer the most stable of `net.peer.name` or
|
To avoid high cardinality, implementations should prefer the most stable of `net.peer.name` or
|
||||||
|
|
|
||||||
|
|
@ -56,7 +56,7 @@ Examples of span names:
|
||||||
<!-- semconv rpc -->
|
<!-- semconv rpc -->
|
||||||
| Attribute | Type | Description | Examples | Required |
|
| Attribute | Type | Description | Examples | Required |
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
| `rpc.system` | string | A string identifying the remoting system. | `grpc`; `java_rmi`; `wcf` | Yes |
|
| `rpc.system` | string | A string identifying the remoting system. See below for a list of well-known identifiers. | `grpc` | Yes |
|
||||||
| `rpc.service` | string | The full (logical) name of the service being called, including its package name, if applicable. [1] | `myservice.EchoService` | No, but recommended |
|
| `rpc.service` | string | The full (logical) name of the service being called, including its package name, if applicable. [1] | `myservice.EchoService` | No, but recommended |
|
||||||
| `rpc.method` | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [2] | `exampleMethod` | No, but recommended |
|
| `rpc.method` | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [2] | `exampleMethod` | No, but recommended |
|
||||||
| [`net.peer.ip`](span-general.md) | string | Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6) | `127.0.0.1` | See below |
|
| [`net.peer.ip`](span-general.md) | string | Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6) | `127.0.0.1` | See below |
|
||||||
|
|
@ -72,6 +72,14 @@ Examples of span names:
|
||||||
|
|
||||||
* [`net.peer.ip`](span-general.md)
|
* [`net.peer.ip`](span-general.md)
|
||||||
* [`net.peer.name`](span-general.md)
|
* [`net.peer.name`](span-general.md)
|
||||||
|
|
||||||
|
`rpc.system` MUST be one of the following or, if none of the listed values apply, a custom value:
|
||||||
|
|
||||||
|
| Value | Description |
|
||||||
|
|---|---|
|
||||||
|
| `grpc` | gRPC |
|
||||||
|
| `java_rmi` | Java RMI |
|
||||||
|
| `dotnet_wcf` | .NET WCF |
|
||||||
<!-- endsemconv -->
|
<!-- endsemconv -->
|
||||||
|
|
||||||
For client-side spans `net.peer.port` is required if the connection is IP-based and the port is available (it describes the server port they are connecting to).
|
For client-side spans `net.peer.port` is required if the connection is IP-based and the port is available (it describes the server port they are connecting to).
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue