Skip to content

Commit

Permalink
Change client.port from recommended to opt-in on HTTP server spans
Browse files Browse the repository at this point in the history
  • Loading branch information
trask committed Oct 29, 2023
1 parent a3bec5e commit 7e1f585
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ release.
([#409](https://github.com/open-telemetry/semantic-conventions/pull/409))
- Remove `url.path` default value.
([#462](https://github.com/open-telemetry/semantic-conventions/pull/462))
- Change `client.port` from recommended to opt-in on HTTP server spans
([#999](https://github.com/open-telemetry/semantic-conventions/pull/999))

### Features

Expand Down
2 changes: 1 addition & 1 deletion docs/http/http-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ For an HTTP server span, `SpanKind` MUST be `Server`.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`client.address`](../general/attributes.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `83.164.160.102` | Recommended |
| [`client.port`](../general/attributes.md) | int | The port of the original client behind all proxies, if known (e.g. from [Forwarded](https://developer.mozilla.org/docs/Web/HTTP/Headers/Forwarded) or a similar header). Otherwise, the immediate client peer port. [2] | `65123` | Recommended |
| [`client.port`](../general/attributes.md) | int | The port of the original client behind all proxies, if known (e.g. from [Forwarded](https://developer.mozilla.org/docs/Web/HTTP/Headers/Forwarded) or a similar header). Otherwise, the immediate client peer port. [2] | `65123` | Opt-In |
| [`http.route`](../attributes-registry/http.md) | string | The matched route, that is, the path template in the format used by the respective server framework. [3] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: If and only if it's available |
| [`network.local.address`](../attributes-registry/network.md) | string | Local socket address. Useful in case of a multi-IP host. | `10.1.2.80`; `/tmp/my.sock` | Opt-In |
| [`network.local.port`](../attributes-registry/network.md) | int | Local socket port. Useful in case of a multi-port host. | `65123` | Opt-In |
Expand Down
1 change: 1 addition & 0 deletions model/trace/http.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ groups:
Otherwise, the immediate client peer address.
examples: ['83.164.160.102']
- ref: client.port
requirement_level: opt_in
brief: >
The port of the original client behind all proxies, if
known (e.g. from [Forwarded](https://developer.mozilla.org/docs/Web/HTTP/Headers/Forwarded) or a similar header).
Expand Down

0 comments on commit 7e1f585

Please sign in to comment.