Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move RPC streaming notes from metric brief section to notes section #275

Merged
merged 6 commits into from
Sep 11, 2023
Merged

Move RPC streaming notes from metric brief section to notes section #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ef58a16
Move streaming note to notes section
trask Aug 21, 2023
7842437
nonbreaking
trask Aug 21, 2023
5060375
Merge branch 'main' into better-description
trask Aug 22, 2023
7ae89e4
Merge branch 'main' into better-description
trask Sep 2, 2023
ceccf4b
Merge branch 'main' into better-description
joaopgrassi Sep 11, 2023
5a3db70
Merge branch 'main' into better-description
joaopgrassi Sep 11, 2023
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ release.
([#276](https://github.com/open-telemetry/semantic-conventions/pull/276))
- Add host cpu resource attributes.
([#209](https://github.com/open-telemetry/semantic-conventions/pull/209))
- Moved RPC streaming notes from metric brief section to notes section.
([#275](https://github.com/open-telemetry/semantic-conventions/pull/275))

## v1.21.0 (2023-07-13)

Expand Down
48 changes: 38 additions & 10 deletions docs/rpc/rpc-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,12 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.server.duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.server.duration` | Histogram | `ms` | Measures the duration of inbound RPC. **Streaming**: N/A. [1] |
| `rpc.server.duration` | Histogram | `ms` | Measures the duration of inbound RPC. [1] |

**[1]:** While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.

**Streaming**: N/A.
<!-- endsemconv -->

#### Metric: `rpc.server.request.size`
Expand All @@ -93,7 +95,9 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.server.request.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.server.request.size` | Histogram | `By` | Measures the size of RPC request messages (uncompressed). **Streaming**: Recorded per message in a streaming batch |
| `rpc.server.request.size` | Histogram | `By` | Measures the size of RPC request messages (uncompressed). [1] |

**[1]:** **Streaming**: Recorded per message in a streaming batch
<!-- endsemconv -->

#### Metric: `rpc.server.response.size`
Expand All @@ -103,7 +107,9 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.server.response.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.server.response.size` | Histogram | `By` | Measures the size of RPC response messages (uncompressed). **Streaming**: Recorded per response in a streaming batch |
| `rpc.server.response.size` | Histogram | `By` | Measures the size of RPC response messages (uncompressed). [1] |

**[1]:** **Streaming**: Recorded per response in a streaming batch
<!-- endsemconv -->

#### Metric: `rpc.server.requests_per_rpc`
Expand All @@ -113,7 +119,11 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.server.requests_per_rpc(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.server.requests_per_rpc` | Histogram | `{count}` | Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs. **Streaming**: This metric is required for server and client streaming RPCs |
| `rpc.server.requests_per_rpc` | Histogram | `{count}` | Measures the number of messages received per RPC. [1] |

**[1]:** Should be 1 for all non-streaming RPCs.

**Streaming** : This metric is required for server and client streaming RPCs
<!-- endsemconv -->

#### Metric: `rpc.server.responses_per_rpc`
Expand All @@ -123,7 +133,11 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.server.responses_per_rpc(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.server.responses_per_rpc` | Histogram | `{count}` | Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs. **Streaming**: This metric is required for server and client streaming RPCs |
| `rpc.server.responses_per_rpc` | Histogram | `{count}` | Measures the number of messages sent per RPC. [1] |

**[1]:** Should be 1 for all non-streaming RPCs.

**Streaming**: This metric is required for server and client streaming RPCs
<!-- endsemconv -->

### RPC Client
Expand All @@ -138,10 +152,12 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.client.duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.client.duration` | Histogram | `ms` | Measures the duration of outbound RPC **Streaming**: N/A. [1] |
| `rpc.client.duration` | Histogram | `ms` | Measures the duration of outbound RPC. [1] |

**[1]:** While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.

**Streaming**: N/A.
<!-- endsemconv -->

#### Metric: `rpc.client.request.size`
Expand All @@ -151,7 +167,9 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.client.request.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.client.request.size` | Histogram | `By` | Measures the size of RPC request messages (uncompressed). **Streaming**: Recorded per message in a streaming batch |
| `rpc.client.request.size` | Histogram | `By` | Measures the size of RPC request messages (uncompressed). [1] |

**[1]:** **Streaming**: Recorded per message in a streaming batch
<!-- endsemconv -->

#### Metric: `rpc.client.response.size`
Expand All @@ -161,7 +179,9 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.client.response.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.client.response.size` | Histogram | `By` | Measures the size of RPC response messages (uncompressed). **Streaming**: Recorded per response in a streaming batch |
| `rpc.client.response.size` | Histogram | `By` | Measures the size of RPC response messages (uncompressed). [1] |

**[1]:** **Streaming**: Recorded per response in a streaming batch
<!-- endsemconv -->

#### Metric: `rpc.client.requests_per_rpc`
Expand All @@ -171,7 +191,11 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.client.requests_per_rpc(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.client.requests_per_rpc` | Histogram | `{count}` | Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs. **Streaming**: This metric is required for server and client streaming RPCs |
| `rpc.client.requests_per_rpc` | Histogram | `{count}` | Measures the number of messages received per RPC. [1] |

**[1]:** Should be 1 for all non-streaming RPCs.

**Streaming**: This metric is required for server and client streaming RPCs
<!-- endsemconv -->

#### Metric: `rpc.client.responses_per_rpc`
Expand All @@ -181,7 +205,11 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.rpc.client.responses_per_rpc(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `rpc.client.responses_per_rpc` | Histogram | `{count}` | Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs. **Streaming**: This metric is required for server and client streaming RPCs |
| `rpc.client.responses_per_rpc` | Histogram | `{count}` | Measures the number of messages sent per RPC. [1] |

**[1]:** Should be 1 for all non-streaming RPCs.

**Streaming**: This metric is required for server and client streaming RPCs
<!-- endsemconv -->

## Attributes
Expand Down
68 changes: 38 additions & 30 deletions model/metrics/rpc-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,96 +20,104 @@ groups:
- id: metric.rpc.server.duration
type: metric
metric_name: rpc.server.duration
brief: >
Measures the duration of inbound RPC.
**Streaming**: N/A.
brief: Measures the duration of inbound RPC.
instrument: histogram
unit: "ms"
note: |
While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.

**Streaming**: N/A.

- id: metric.rpc.server.request.size
type: metric
metric_name: rpc.server.request.size
brief: >
Measures the size of RPC request messages (uncompressed).
**Streaming**: Recorded per message in a streaming batch
brief: Measures the size of RPC request messages (uncompressed).
instrument: histogram
unit: "By"
note: |
**Streaming**: Recorded per message in a streaming batch

- id: metric.rpc.server.response.size
type: metric
metric_name: rpc.server.response.size
brief: >
Measures the size of RPC response messages (uncompressed).
**Streaming**: Recorded per response in a streaming batch
brief: Measures the size of RPC response messages (uncompressed).
instrument: histogram
unit: "By"
note: |
**Streaming**: Recorded per response in a streaming batch

- id: metric.rpc.server.requests_per_rpc
type: metric
metric_name: rpc.server.requests_per_rpc
brief: >
Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs
brief: Measures the number of messages received per RPC.
instrument: histogram
unit: "{count}"
note: |
Should be 1 for all non-streaming RPCs.

**Streaming** : This metric is required for server and client streaming RPCs

- id: metric.rpc.server.responses_per_rpc
type: metric
metric_name: rpc.server.responses_per_rpc
brief: >
Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs
brief: Measures the number of messages sent per RPC.
instrument: histogram
unit: "{count}"
note: |
Should be 1 for all non-streaming RPCs.

**Streaming**: This metric is required for server and client streaming RPCs

# RPC Client metrics
- id: metric.rpc.client.duration
type: metric
metric_name: rpc.client.duration
brief: >
Measures the duration of outbound RPC
**Streaming**: N/A.
brief: Measures the duration of outbound RPC.
instrument: histogram
unit: "ms"
note: |
While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.

**Streaming**: N/A.

- id: metric.rpc.client.request.size
type: metric
metric_name: rpc.client.request.size
brief: >
Measures the size of RPC request messages (uncompressed).
**Streaming**: Recorded per message in a streaming batch
brief: Measures the size of RPC request messages (uncompressed).
instrument: histogram
unit: "By"
note: |
**Streaming**: Recorded per message in a streaming batch

- id: metric.rpc.client.response.size
type: metric
metric_name: rpc.client.response.size
brief: >
Measures the size of RPC response messages (uncompressed).
**Streaming**: Recorded per response in a streaming batch
brief: Measures the size of RPC response messages (uncompressed).
instrument: histogram
unit: "By"
note: |
**Streaming**: Recorded per response in a streaming batch

- id: metric.rpc.client.requests_per_rpc
type: metric
metric_name: rpc.client.requests_per_rpc
brief: >
Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs
brief: Measures the number of messages received per RPC.
instrument: histogram
unit: "{count}"
note: |
Should be 1 for all non-streaming RPCs.

**Streaming**: This metric is required for server and client streaming RPCs

- id: metric.rpc.client.responses_per_rpc
type: metric
metric_name: rpc.client.responses_per_rpc
brief: >
Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs
brief: Measures the number of messages sent per RPC.
instrument: histogram
unit: "{count}"
note: |
Should be 1 for all non-streaming RPCs.

**Streaming**: This metric is required for server and client streaming RPCs
Loading