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

Add cardinality warning about two opt-in HTTP metric attributes #401

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Add cardinality warning about two opt-in HTTP metric attributes #401

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86cbed1
Add cardinality warning about two opt-in attributes
trask Oct 12, 2023
d9a1fda
Merge branch 'main' into opt-in-warn
joaopgrassi Oct 13, 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ release.

### Fixes

- Add cardinality warning about two opt-in HTTP metric attributes
([#401](https://github.com/open-telemetry/semantic-conventions/pull/401))

## v1.22.0 (2023-10-12)

- Remove experimental Kafka metrics ([#338](https://github.com/open-telemetry/semantic-conventions/pull/338))
Expand Down
6 changes: 6 additions & 0 deletions docs/http/http-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,13 +208,19 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original

SHOULD NOT be set if only IP address is available and capturing name would require a reverse DNS lookup.

Warning: since this attribute may be based on the `Host` header, opting in to it may allow an attacker
to trigger cardinality limits, degrading the usefulness of the metric.

**[3]:** Determined by using the first of the following that applies

- Port identifier of the [primary server host](/docs/http/http-spans.md#http-server-definitions) of the matched virtual host.
- Port identifier of the [request target](https://www.rfc-editor.org/rfc/rfc9110.html#target.resource)
if it's sent in absolute-form.
- Port identifier of the `Host` header

Warning: since this attribute may be based on the `Host` header, opting in to it may allow an attacker
to trigger cardinality limits, degrading the usefulness of the metric.

`http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

| Value | Description |
Expand Down
6 changes: 6 additions & 0 deletions model/metrics/http.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ groups:

SHOULD NOT be set if only IP address is available and capturing name would require a reverse DNS lookup.

Warning: since this attribute may be based on the `Host` header, opting in to it may allow an attacker
to trigger cardinality limits, degrading the usefulness of the metric.

- ref: server.port
requirement_level: opt_in
brief: >
Expand All @@ -64,6 +67,9 @@ groups:
if it's sent in absolute-form.
- Port identifier of the `Host` header

Warning: since this attribute may be based on the `Host` header, opting in to it may allow an attacker
to trigger cardinality limits, degrading the usefulness of the metric.

- id: metric.http.server.request.body.size
type: metric
metric_name: http.server.request.body.size
Expand Down
Loading