diff --git a/.chloggen/copilot_add-metrics-section-to-rpc-docs.yaml b/.chloggen/copilot_add-metrics-section-to-rpc-docs.yaml new file mode 100644 index 0000000000..3940b71316 --- /dev/null +++ b/.chloggen/copilot_add-metrics-section-to-rpc-docs.yaml @@ -0,0 +1,17 @@ +# 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: Add Metrics sections to JSON-RPC, gRPC, and Connect RPC system-specific conventions + +# 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: [3319, 3320] diff --git a/docs/rpc/connect-rpc.md b/docs/rpc/connect-rpc.md index ea6e89147f..6e60abb5a0 100644 --- a/docs/rpc/connect-rpc.md +++ b/docs/rpc/connect-rpc.md @@ -6,11 +6,22 @@ linkTitle: Connect **Status**: [Development][DocumentStatus] + + +- [Spans](#spans) + - [Client](#client) + - [Server](#server) +- [Metrics](#metrics) + + + The Semantic Conventions for [Connect](https://connectrpc.com/) extend and override the [RPC spans](rpc-spans.md) and [RPC metrics](rpc-metrics.md) Semantic Conventions that describe common RPC operations attributes in addition to the Semantic Conventions described on this page. -## Client Span +## Spans + +### Client @@ -147,7 +158,7 @@ and SHOULD be provided **at span creation time** (if provided at all): -## Server Span +### Server @@ -297,4 +308,11 @@ and SHOULD be provided **at span creation time** (if provided at all): +## Metrics + +Connect RPC instrumentations SHOULD collect metrics according to the general +[Semantic Conventions for RPC Metrics](/docs/rpc/rpc-metrics.md). + +`rpc.system.name` MUST be set to `"connectrpc"`. + [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/rpc/grpc.md b/docs/rpc/grpc.md index 5bac5ac66a..a5986c1723 100644 --- a/docs/rpc/grpc.md +++ b/docs/rpc/grpc.md @@ -6,11 +6,22 @@ linkTitle: gRPC **Status**: [Development][DocumentStatus] + + +- [Spans](#spans) + - [Client](#client) + - [Server](#server) +- [Metrics](#metrics) + + + The Semantic Conventions for [gRPC](https://grpc.io/) extend and override the [RPC spans](rpc-spans.md) and [RPC metrics](rpc-metrics.md) Semantic Conventions that describe common RPC operations attributes in addition to the Semantic Conventions described on this page. -## Client Span +## Spans + +### Client @@ -148,7 +159,7 @@ and SHOULD be provided **at span creation time** (if provided at all): -## Server Span +### Server @@ -299,4 +310,11 @@ and SHOULD be provided **at span creation time** (if provided at all): +## Metrics + +gRPC instrumentations SHOULD collect metrics according to the general +[Semantic Conventions for RPC Metrics](/docs/rpc/rpc-metrics.md). + +`rpc.system.name` MUST be set to `"grpc"`. + [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/rpc/json-rpc.md b/docs/rpc/json-rpc.md index 526dff0f02..7d72eb3c7a 100644 --- a/docs/rpc/json-rpc.md +++ b/docs/rpc/json-rpc.md @@ -6,11 +6,22 @@ linkTitle: JSON-RPC **Status**: [Development][DocumentStatus] + + +- [Spans](#spans) + - [Client](#client) + - [Server](#server) +- [Metrics](#metrics) + + + The Semantic Conventions for [JSON-RPC](https://www.jsonrpc.org/) extend and override the [RPC spans](rpc-spans.md) and [RPC metrics](rpc-metrics.md) Semantic Conventions that describe common RPC operations attributes in addition to the Semantic Conventions described on this page. -## Client Span +## Spans + +### Client @@ -119,7 +130,7 @@ and SHOULD be provided **at span creation time** (if provided at all): -## Server Span +### Server @@ -234,4 +245,11 @@ and SHOULD be provided **at span creation time** (if provided at all): +## Metrics + +JSON-RPC instrumentations SHOULD collect metrics according to the general +[Semantic Conventions for RPC Metrics](/docs/rpc/rpc-metrics.md). + +`rpc.system.name` MUST be set to `"jsonrpc"`. + [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status