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.

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

Simplify HTTP metric briefs #276

Merged
merged 2 commits into from
Aug 22, 2023
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ release.
([#60](https://github.com/open-telemetry/semantic-conventions/pull/60))
- BREAKING: Remove pluralization from JVM metric namespaces.
([#252](https://github.com/open-telemetry/semantic-conventions/pull/252))
- Simplify HTTP metric briefs.
([#276](https://github.com/open-telemetry/semantic-conventions/pull/276))

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

Expand Down
16 changes: 12 additions & 4 deletions docs/http/http-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,9 @@ This metric is optional.
<!-- semconv metric.http.server.request.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.server.request.size` | Histogram | `By` | Measures the size of HTTP request messages (compressed). |
| `http.server.request.size` | Histogram | `By` | Measures the size of HTTP request messages. [1] |

**[1]:** Size as measured over the wire (compressed size if messages are compressed).
<!-- endsemconv -->

<!-- semconv metric.http.server.request.size(full) -->
Expand Down Expand Up @@ -291,7 +293,9 @@ This metric is optional.
<!-- semconv metric.http.server.response.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.server.response.size` | Histogram | `By` | Measures the size of HTTP response messages (compressed). |
| `http.server.response.size` | Histogram | `By` | Measures the size of HTTP response messages. [1] |

**[1]:** Size as measured over the wire (compressed size if messages are compressed).
<!-- endsemconv -->

<!-- semconv metric.http.server.response.size(full) -->
Expand Down Expand Up @@ -447,7 +451,9 @@ This metric is optional.
<!-- semconv metric.http.client.request.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.client.request.size` | Histogram | `By` | Measures the size of HTTP request messages (compressed). |
| `http.client.request.size` | Histogram | `By` | Measures the size of HTTP request messages. [1] |

**[1]:** Size as measured over the wire (compressed size if messages are compressed).
<!-- endsemconv -->

<!-- semconv metric.http.client.request.size(full) -->
Expand Down Expand Up @@ -518,7 +524,9 @@ This metric is optional.
<!-- semconv metric.http.client.response.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.client.response.size` | Histogram | `By` | Measures the size of HTTP response messages (compressed). |
| `http.client.response.size` | Histogram | `By` | Measures the size of HTTP response messages. [1] |

**[1]:** Size as measured over the wire (compressed size if messages are compressed).
<!-- endsemconv -->

<!-- semconv metric.http.client.response.size(full) -->
Expand Down
12 changes: 8 additions & 4 deletions model/metrics/http.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,19 @@ groups:
- id: metric.http.server.request.size
type: metric
metric_name: http.server.request.size
brief: "Measures the size of HTTP request messages (compressed)."
brief: "Measures the size of HTTP request messages."
instrument: histogram
unit: "By"
note: Size as measured over the wire (compressed size if messages are compressed).
extends: metric_attributes.http.server

- id: metric.http.server.response.size
type: metric
metric_name: http.server.response.size
brief: "Measures the size of HTTP response messages (compressed)."
brief: "Measures the size of HTTP response messages."
instrument: histogram
unit: "By"
note: Size as measured over the wire (compressed size if messages are compressed).
extends: metric_attributes.http.server

- id: metric.http.client.request.duration
Expand All @@ -121,15 +123,17 @@ groups:
- id: metric.http.client.request.size
type: metric
metric_name: http.client.request.size
brief: "Measures the size of HTTP request messages (compressed)."
brief: "Measures the size of HTTP request messages."
instrument: histogram
unit: "By"
note: Size as measured over the wire (compressed size if messages are compressed).
extends: metric_attributes.http.client

- id: metric.http.client.response.size
type: metric
metric_name: http.client.response.size
brief: "Measures the size of HTTP response messages (compressed)."
brief: "Measures the size of HTTP response messages."
instrument: histogram
unit: "By"
note: Size as measured over the wire (compressed size if messages are compressed).
extends: metric_attributes.http.client