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

Improve HTTP metric briefs #366

Merged
merged 4 commits into from
Oct 6, 2023
Merged

Improve HTTP metric briefs #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26c8e10
Improve HTTP metric briefs
trask Oct 3, 2023
f1bed12
changelog
trask Oct 3, 2023
a83da27
tables
trask Oct 3, 2023
65b6250
Merge branch 'main' into http-metric-briefs
joaopgrassi Oct 6, 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 @@ -132,6 +132,8 @@ release.
- BREAKING: Rename `telemetry.auto.version` resource attribute to `telemetry.distro.version`
and add `telemetry.distro.name` resource attribute
([#178](https://github.com/open-telemetry/semantic-conventions/pull/178))
- Improve HTTP metric briefs.
([#366](https://github.com/open-telemetry/semantic-conventions/pull/366))

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

Expand Down
14 changes: 7 additions & 7 deletions docs/http/http-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
<!-- semconv metric.http.server.request.duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.server.request.duration` | Histogram | `s` | Measures the duration of inbound HTTP requests. |
| `http.server.request.duration` | Histogram | `s` | Duration of HTTP server requests. |
<!-- endsemconv -->

<!-- semconv metric.http.server.request.duration(full) -->
Expand Down Expand Up @@ -172,7 +172,7 @@ This metric is optional.
<!-- semconv metric.http.server.active_requests(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.server.active_requests` | UpDownCounter | `{request}` | Measures the number of concurrent HTTP requests that are currently in-flight. |
| `http.server.active_requests` | UpDownCounter | `{request}` | Number of active HTTP server requests. |
<!-- endsemconv -->

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

**[1]:** The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
<!-- endsemconv -->
Expand Down Expand Up @@ -344,7 +344,7 @@ This metric is optional.
<!-- semconv metric.http.server.response.body.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.server.response.body.size` | Histogram | `By` | Measures the size of HTTP response messages. [1] |
| `http.server.response.body.size` | Histogram | `By` | Size of HTTP server response bodies. [1] |

**[1]:** The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
<!-- endsemconv -->
Expand Down Expand Up @@ -456,7 +456,7 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
<!-- semconv metric.http.client.request.duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.client.request.duration` | Histogram | `s` | Measures the duration of outbound HTTP requests. |
| `http.client.request.duration` | Histogram | `s` | Duration of HTTP client requests. |
<!-- endsemconv -->

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

**[1]:** The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
<!-- endsemconv -->
Expand Down Expand Up @@ -644,7 +644,7 @@ This metric is optional.
<!-- semconv metric.http.client.response.body.size(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `http.client.response.body.size` | Histogram | `By` | Measures the size of HTTP response messages. [1] |
| `http.client.response.body.size` | Histogram | `By` | Size of HTTP client response bodies. [1] |

**[1]:** The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
<!-- endsemconv -->
Expand Down
14 changes: 7 additions & 7 deletions model/metrics/http.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@ groups:
- id: metric.http.server.request.duration
type: metric
metric_name: http.server.request.duration
brief: "Measures the duration of inbound HTTP requests."
brief: "Duration of HTTP server requests."
instrument: histogram
unit: "s"
extends: metric_attributes.http.server

- id: metric.http.server.active_requests
type: metric
metric_name: http.server.active_requests
brief: "Measures the number of concurrent HTTP requests that are currently in-flight."
brief: "Number of active HTTP server requests."
instrument: updowncounter
unit: "{request}"
attributes:
Expand Down Expand Up @@ -138,7 +138,7 @@ groups:
- id: metric.http.server.request.body.size
type: metric
metric_name: http.server.request.body.size
brief: "Measures the size of HTTP request messages."
brief: "Size of HTTP server request bodies."
instrument: histogram
unit: "By"
note: >
Expand All @@ -150,7 +150,7 @@ groups:
- id: metric.http.server.response.body.size
type: metric
metric_name: http.server.response.body.size
brief: "Measures the size of HTTP response messages."
brief: "Size of HTTP server response bodies."
instrument: histogram
unit: "By"
note: >
Expand All @@ -162,15 +162,15 @@ groups:
- id: metric.http.client.request.duration
type: metric
metric_name: http.client.request.duration
brief: "Measures the duration of outbound HTTP requests."
brief: "Duration of HTTP client requests."
instrument: histogram
unit: "s"
extends: metric_attributes.http.client

- id: metric.http.client.request.body.size
type: metric
metric_name: http.client.request.body.size
brief: "Measures the size of HTTP request messages."
brief: "Size of HTTP client request bodies."
instrument: histogram
unit: "By"
note: >
Expand All @@ -182,7 +182,7 @@ groups:
- id: metric.http.client.response.body.size
type: metric
metric_name: http.client.response.body.size
brief: "Measures the size of HTTP response messages."
brief: "Size of HTTP client response bodies."
instrument: histogram
unit: "By"
note: >
Expand Down
Loading