diff --git a/.chloggen/rpc-json_rpc_span_def.yaml b/.chloggen/rpc-json_rpc_span_def.yaml new file mode 100644 index 0000000000..dac1128cfa --- /dev/null +++ b/.chloggen/rpc-json_rpc_span_def.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: rpc + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: JSON-RPC now has its own span definition. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [2228] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/cloud-providers/aws-sdk.md b/docs/cloud-providers/aws-sdk.md index ee4219d510..d94f02d397 100644 --- a/docs/cloud-providers/aws-sdk.md +++ b/docs/cloud-providers/aws-sdk.md @@ -64,6 +64,7 @@ interesting conventions are found. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/database/dynamodb.md b/docs/database/dynamodb.md index afde9265b7..97e1cb5b6d 100644 --- a/docs/database/dynamodb.md +++ b/docs/database/dynamodb.md @@ -80,6 +80,7 @@ This span represents a `DynamoDB.BatchGetItem` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -135,6 +136,7 @@ This span represents a `DynamoDB.BatchWriteItem` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -194,6 +196,7 @@ This span represents a `DynamoDB.CreateTable` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -249,6 +252,7 @@ This span represents a `DynamoDB.DeleteItem` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -302,6 +306,7 @@ This span represents a `DynamoDB.DeleteTable` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -355,6 +360,7 @@ This span represents a `DynamoDB.DescribeTable` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -411,6 +417,7 @@ This span represents a `DynamoDB.GetItem` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -466,6 +473,7 @@ This span represents a `DynamoDB.ListTables` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -521,6 +529,7 @@ This span represents a `DynamoDB.PutItem` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -582,6 +591,7 @@ This span represents a `DynamoDB.Query` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -646,6 +656,7 @@ This span represents a `DynamoDB.Scan` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -701,6 +712,7 @@ This span represents a `DynamoDB.UpdateItem` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -759,6 +771,7 @@ This span represents a `DynamoDB.UpdateTable` call. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/object-stores/s3.md b/docs/object-stores/s3.md index 1083a4537a..0a10cc4d00 100644 --- a/docs/object-stores/s3.md +++ b/docs/object-stores/s3.md @@ -99,6 +99,7 @@ This applies in particular to the following operations: | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 3282fb21b1..b24f3dae24 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -127,6 +127,7 @@ the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | ## Deprecated RPC Attributes diff --git a/docs/rpc/json-rpc.md b/docs/rpc/json-rpc.md index 1cf36d7284..da57080c70 100644 --- a/docs/rpc/json-rpc.md +++ b/docs/rpc/json-rpc.md @@ -10,26 +10,160 @@ The Semantic Conventions for [JSON-RPC](https://www.jsonrpc.org/) extend and ove that describe common RPC operations attributes in addition to the Semantic Conventions described on this page. -## JSON-RPC Attributes +## Client Span -`rpc.system` MUST be set to `"jsonrpc"`. + + + + + + + +**Status:** ![Development](https://img.shields.io/badge/-development-blue) + +This span represents an outgoing Remote Procedure Call (RPC). + +`rpc.system` MUST be set to `"jsonrpc"` and SHOULD be provided **at span creation time.** + +**Span name:** refer to the [Span Name](./rpc-spans.md#span-name) section. + +**Span kind** MUST be `CLIENT`. + +**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document. + +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | +|---|---|---|---|---|---| +| [`rpc.method`](/docs/registry/attributes/rpc.md) | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [1] | `exampleMethod` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) | +| [`server.address`](/docs/registry/attributes/server.md) | string | RPC server [host name](https://grpc.github.io/grpc/core/md_doc_naming.html). [2] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`rpc.jsonrpc.error_code`](/docs/registry/attributes/rpc.md) | int | `error.code` property of response if it is an error response. | `-32700`; `100` | `Conditionally Required` when available | ![Development](https://img.shields.io/badge/-development-blue) | +| [`rpc.jsonrpc.version`](/docs/registry/attributes/rpc.md) | 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` | `Conditionally Required` If other than the default version (`1.0`) | ![Development](https://img.shields.io/badge/-development-blue) | +| [`server.port`](/docs/registry/attributes/server.md) | int | Server port number. [3] | `80`; `8080`; `443` | `Conditionally Required` [4] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.peer.address`](/docs/registry/attributes/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.peer.port`](/docs/registry/attributes/network.md) | int | Peer port number of the network connection. | `65123` | `Recommended` If `network.peer.address` is set. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.transport`](/docs/registry/attributes/network.md) | string | [OSI transport layer](https://wikipedia.org/wiki/Transport_layer) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [5] | `tcp`; `udp` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.type`](/docs/registry/attributes/network.md) | string | [OSI network layer](https://wikipedia.org/wiki/Network_layer) or non-OSI equivalent. [6] | `ipv4`; `ipv6` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`rpc.jsonrpc.error_message`](/docs/registry/attributes/rpc.md) | string | `error.message` property of response if it is an error response. | `Parse error`; `User already exists` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | +| [`rpc.jsonrpc.request_id`](/docs/registry/attributes/rpc.md) | 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`; `` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | + +**[1] `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). + +**[2] `server.address`:** May contain server IP address, DNS name, or local socket name. When host component is an IP address, instrumentations SHOULD NOT do a reverse proxy lookup to obtain DNS name and SHOULD set `server.address` to the IP address provided in the host component. + +**[3] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. + +**[4] `server.port`:** if the port is supported by the network transport used for communication. + +**[5] `network.transport`:** The value SHOULD be normalized to lowercase. + +Consider always setting the transport when setting a port number, since +a port number is ambiguous without knowing the transport. For example +different processes could be listening on TCP port 12345 and UDP port 12345. + +**[6] `network.type`:** The value SHOULD be normalized to lowercase. + +--- + +`network.transport` 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 | +|---|---|---| +| `pipe` | Named or anonymous pipe. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `quic` | QUIC | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `tcp` | TCP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + +--- - +`network.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 | +|---|---|---| +| `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + + + + + + +## Server Span + + +**Status:** ![Development](https://img.shields.io/badge/-development-blue) + +This span represents an incoming Remote Procedure Call (RPC). + +`rpc.system` MUST be set to `"jsonrpc"` and SHOULD be provided **at span creation time.** + +**Span name:** refer to the [Span Name](./rpc-spans.md#span-name) section. + +**Span kind** MUST be `SERVER`. + +**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document. + | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| | [`rpc.method`](/docs/registry/attributes/rpc.md) | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [1] | `exampleMethod` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) | -| [`rpc.jsonrpc.error_code`](/docs/registry/attributes/rpc.md) | int | `error.code` property of response if it is an error response. | `-32700`; `100` | `Conditionally Required` If response is not successful. | ![Development](https://img.shields.io/badge/-development-blue) | +| [`server.address`](/docs/registry/attributes/server.md) | string | RPC server [host name](https://grpc.github.io/grpc/core/md_doc_naming.html). [2] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`rpc.jsonrpc.error_code`](/docs/registry/attributes/rpc.md) | int | `error.code` property of response if it is an error response. | `-32700`; `100` | `Conditionally Required` when available | ![Development](https://img.shields.io/badge/-development-blue) | | [`rpc.jsonrpc.version`](/docs/registry/attributes/rpc.md) | 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` | `Conditionally Required` If other than the default version (`1.0`) | ![Development](https://img.shields.io/badge/-development-blue) | +| [`server.port`](/docs/registry/attributes/server.md) | int | Server port number. [3] | `80`; `8080`; `443` | `Conditionally Required` [4] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`client.address`](/docs/registry/attributes/client.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [5] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`client.port`](/docs/registry/attributes/client.md) | int | Client port number. [6] | `65123` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.peer.address`](/docs/registry/attributes/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.peer.port`](/docs/registry/attributes/network.md) | int | Peer port number of the network connection. | `65123` | `Recommended` If `network.peer.address` is set. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.transport`](/docs/registry/attributes/network.md) | string | [OSI transport layer](https://wikipedia.org/wiki/Transport_layer) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [7] | `tcp`; `udp` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`network.type`](/docs/registry/attributes/network.md) | string | [OSI network layer](https://wikipedia.org/wiki/Network_layer) or non-OSI equivalent. [8] | `ipv4`; `ipv6` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | [`rpc.jsonrpc.error_message`](/docs/registry/attributes/rpc.md) | string | `error.message` property of response if it is an error response. | `Parse error`; `User already exists` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | | [`rpc.jsonrpc.request_id`](/docs/registry/attributes/rpc.md) | 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`; `` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | -**[1] `rpc.method`:** This is always required for jsonrpc. See the note in the general RPC conventions for more information. +**[1] `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). + +**[2] `server.address`:** May contain server IP address, DNS name, or local socket name. When host component is an IP address, instrumentations SHOULD NOT do a reverse proxy lookup to obtain DNS name and SHOULD set `server.address` to the IP address provided in the host component. + +**[3] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. + +**[4] `server.port`:** if the port is supported by the network transport used for communication. + +**[5] `client.address`:** When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. + +**[6] `client.port`:** When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. + +**[7] `network.transport`:** The value SHOULD be normalized to lowercase. + +Consider always setting the transport when setting a port number, since +a port number is ambiguous without knowing the transport. For example +different processes could be listening on TCP port 12345 and UDP port 12345. + +**[8] `network.type`:** The value SHOULD be normalized to lowercase. + +--- + +`network.transport` 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 | +|---|---|---| +| `pipe` | Named or anonymous pipe. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `quic` | QUIC | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `tcp` | TCP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + +--- + +`network.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 | +|---|---|---| +| `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/rpc/rpc-metrics.md b/docs/rpc/rpc-metrics.md index 7365c66a80..67ed73c1da 100644 --- a/docs/rpc/rpc-metrics.md +++ b/docs/rpc/rpc-metrics.md @@ -379,6 +379,7 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md index 10d9d96280..a9e9b52579 100644 --- a/docs/rpc/rpc-spans.md +++ b/docs/rpc/rpc-spans.md @@ -169,6 +169,7 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | @@ -266,6 +267,7 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) | | `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) | | `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) | +| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/model/rpc/common.yaml b/model/rpc/common.yaml new file mode 100644 index 0000000000..9dbde779aa --- /dev/null +++ b/model/rpc/common.yaml @@ -0,0 +1,75 @@ +groups: + - id: rpc + type: attribute_group + brief: 'This document defines semantic conventions for remote procedure calls.' + attributes: + - ref: rpc.method + requirement_level: recommended + note: > + 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). + - ref: network.peer.address + requirement_level: recommended + - ref: network.peer.port + requirement_level: + recommended: If `network.peer.address` is set. + - ref: network.transport + requirement_level: recommended + - ref: network.type + requirement_level: recommended + - ref: server.address + requirement_level: required + brief: > + RPC server [host name](https://grpc.github.io/grpc/core/md_doc_naming.html). + note: > + May contain server IP address, DNS name, or local socket name. When host component is an IP address, + instrumentations SHOULD NOT do a reverse proxy lookup to obtain DNS name and SHOULD set + `server.address` to the IP address provided in the host component. + - ref: server.port + requirement_level: + conditionally_required: if the port is supported by the network transport used for communication. + - id: rpc_service + type: attribute_group + brief: 'This document defines semantic conventions for remote procedure calls.' + extends: rpc + attributes: + - ref: rpc.service + requirement_level: recommended + note: > + 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). + + - id: rpc.server + type: attribute_group + brief: 'This document defines semantic conventions for remote procedure calls.' + extends: rpc + attributes: + - ref: client.address + requirement_level: recommended + - ref: client.port + requirement_level: recommended + - ref: network.transport + requirement_level: recommended + - ref: network.type + requirement_level: recommended + + - id: rpc_service.server + type: attribute_group + brief: 'This document defines semantic conventions for remote procedure calls.' + extends: rpc_service + attributes: + - ref: client.address + requirement_level: recommended + - ref: client.port + requirement_level: recommended + - ref: network.transport + requirement_level: recommended + - ref: network.type + requirement_level: recommended diff --git a/model/rpc/registry.yaml b/model/rpc/registry.yaml index bfee73b9eb..ae47b96925 100644 --- a/model/rpc/registry.yaml +++ b/model/rpc/registry.yaml @@ -253,6 +253,10 @@ groups: value: 'onc_rpc' brief: '[ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531)' stability: development + - id: jsonrpc + value: 'jsonrpc' + brief: 'JSON-RPC' + stability: development stability: development - id: rpc.message.type type: diff --git a/model/rpc/spans.yaml b/model/rpc/spans.yaml index 9d4383766d..a69f039f6c 100644 --- a/model/rpc/spans.yaml +++ b/model/rpc/spans.yaml @@ -1,30 +1,4 @@ groups: - - id: rpc - type: attribute_group - brief: 'This document defines semantic conventions for remote procedure calls.' - attributes: - - ref: rpc.system - requirement_level: required - - ref: rpc.service - requirement_level: recommended - - ref: rpc.method - requirement_level: recommended - - ref: network.transport - requirement_level: recommended - - ref: network.type - requirement_level: recommended - - ref: server.address - requirement_level: required - brief: > - RPC server [host name](https://grpc.github.io/grpc/core/md_doc_naming.html). - note: > - May contain server IP address, DNS name, or local socket name. When host component is an IP address, - instrumentations SHOULD NOT do a reverse proxy lookup to obtain DNS name and SHOULD set - `server.address` to the IP address provided in the host component. - - ref: server.port - requirement_level: - conditionally_required: if the port is supported by the network transport used for communication. - - id: span.rpc.client type: span stability: development @@ -36,20 +10,17 @@ groups: **Span name:** refer to the [Span Name](#span-name) section. **Span kind** MUST be `CLIENT`. - extends: rpc + extends: rpc_service span_kind: client events: [rpc.message] attributes: - - ref: network.peer.address - requirement_level: recommended - - ref: network.peer.port - requirement_level: - recommended: If `network.peer.address` is set. + - ref: rpc.system + requirement_level: required - id: span.rpc.server type: span stability: development - extends: rpc + extends: rpc_service.server span_kind: server brief: This span represents an incoming Remote Procedure Call (RPC). events: [rpc.message] @@ -61,19 +32,8 @@ groups: **Span kind** MUST be `SERVER`. attributes: - - ref: client.address - requirement_level: recommended - - ref: client.port - requirement_level: recommended - - ref: network.peer.address - requirement_level: recommended - - ref: network.peer.port - requirement_level: - recommended: If `network.peer.address` is set. - - ref: network.transport - requirement_level: recommended - - ref: network.type - requirement_level: recommended + - ref: rpc.system + requirement_level: required - id: rpc.grpc.attributes stability: development @@ -87,11 +47,21 @@ groups: - ref: rpc.grpc.response.metadata requirement_level: opt_in - - id: rpc.jsonrpc.attributes - type: attribute_group + - id: span.rpc.jsonrpc.client + type: span stability: development - brief: 'Tech-specific attributes for [JSON RPC](https://www.jsonrpc.org/).' + brief: This span represents an outgoing Remote Procedure Call (RPC). + note: | + `rpc.system` MUST be set to `"jsonrpc"` and SHOULD be provided **at span creation time.** + + **Span name:** refer to the [Span Name](./rpc-spans.md#span-name) section. + + **Span kind** MUST be `CLIENT`. + extends: rpc + span_kind: client attributes: + - ref: rpc.method + requirement_level: required - ref: rpc.jsonrpc.version requirement_level: conditionally_required: If other than the default version (`1.0`) @@ -99,14 +69,35 @@ groups: requirement_level: recommended - ref: rpc.jsonrpc.error_code requirement_level: - conditionally_required: If response is not successful. + conditionally_required: when available - ref: rpc.jsonrpc.error_message requirement_level: recommended + + - id: span.rpc.jsonrpc.server + type: span + stability: development + extends: rpc.server + span_kind: server + brief: This span represents an incoming Remote Procedure Call (RPC). + note: | + `rpc.system` MUST be set to `"jsonrpc"` and SHOULD be provided **at span creation time.** + + **Span name:** refer to the [Span Name](./rpc-spans.md#span-name) section. + + **Span kind** MUST be `SERVER`. + attributes: - ref: rpc.method requirement_level: required - note: > - This is always required for jsonrpc. See the note in the general - RPC conventions for more information. + - ref: rpc.jsonrpc.version + requirement_level: + conditionally_required: If other than the default version (`1.0`) + - ref: rpc.jsonrpc.request_id + requirement_level: recommended + - ref: rpc.jsonrpc.error_code + requirement_level: + conditionally_required: when available + - ref: rpc.jsonrpc.error_message + requirement_level: recommended - id: event.rpc.message type: event