Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .chloggen/copilot_add-metrics-section-to-rpc-docs.yaml
Original file line number Diff line number Diff line change
@@ -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]
22 changes: 20 additions & 2 deletions docs/rpc/connect-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,22 @@ linkTitle: Connect

**Status**: [Development][DocumentStatus]

<!-- toc -->

- [Spans](#spans)
- [Client](#client)
- [Server](#server)
- [Metrics](#metrics)

<!-- tocstop -->

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

<!-- semconv span.rpc.connect_rpc.call.client -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
Expand Down Expand Up @@ -147,7 +158,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## Server Span
### Server

<!-- semconv span.rpc.connect_rpc.call.server -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
Expand Down Expand Up @@ -297,4 +308,11 @@ and SHOULD be provided **at span creation time** (if provided at all):
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## 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
22 changes: 20 additions & 2 deletions docs/rpc/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,22 @@ linkTitle: gRPC

**Status**: [Development][DocumentStatus]

<!-- toc -->

- [Spans](#spans)
- [Client](#client)
- [Server](#server)
- [Metrics](#metrics)

<!-- tocstop -->

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

<!-- semconv span.rpc.grpc.call.client -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
Expand Down Expand Up @@ -148,7 +159,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## Server Span
### Server

<!-- semconv span.rpc.grpc.call.server -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
Expand Down Expand Up @@ -299,4 +310,11 @@ and SHOULD be provided **at span creation time** (if provided at all):
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## 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
22 changes: 20 additions & 2 deletions docs/rpc/json-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,22 @@ linkTitle: JSON-RPC

**Status**: [Development][DocumentStatus]

<!-- toc -->

- [Spans](#spans)
- [Client](#client)
- [Server](#server)
- [Metrics](#metrics)

<!-- tocstop -->

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

<!-- semconv span.rpc.jsonrpc.call.client -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
Expand Down Expand Up @@ -119,7 +130,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## Server Span
### Server

<!-- semconv span.rpc.jsonrpc.call.server -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
Expand Down Expand Up @@ -234,4 +245,11 @@ and SHOULD be provided **at span creation time** (if provided at all):
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## 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
Loading