open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use deprecated property instead of stability level (#588)

This commit is contained in:
Liudmila Molkova 2023-12-13 11:13:20 -08:00 committed by GitHub
parent c190a04754
commit bef6b4b39f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 46 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -57,6 +57,8 @@ release.
- Update stability definitions of HTTP client and server duration metrics to - Update stability definitions of HTTP client and server duration metrics to
be consistent with markdown. be consistent with markdown.
([#587](https://github.com/open-telemetry/semantic-conventions/pull/587)) ([#587](https://github.com/open-telemetry/semantic-conventions/pull/587))
- Use `deprecated` property to mark attributes as deprecated instead of `stability`
([#588](https://github.com/open-telemetry/semantic-conventions/pull/588))
## v1.23.1 (2023-11-17) ## v1.23.1 (2023-11-17)

18
docs/attributes-registry/http.md
View File

@ -67,15 +67,15 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
<!-- semconv attributes.http.deprecated(omit_requirement_level) --> <!-- semconv attributes.http.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | | Attribute | Type | Description | Examples |
|---|---|---|---| |---|---|---|---|
| `http.flavor` | string | Deprecated, use `network.protocol.name` instead. | `1.0` | | `http.flavor` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.protocol.name` instead. | `1.0` |
| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | | `http.method` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` |
| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | | `http.request_content_length` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.request.header.content-length` instead. | `3495` |
| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | | `http.response_content_length` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.response.header.content-length` instead. | `3495` |
| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` | | `http.scheme` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `url.scheme` instead. | `http`; `https` |
| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` | | `http.status_code` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.response.status_code` instead. | `200` |
| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | | `http.target` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` |
| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | | `http.url` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` |
| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` | | `http.user_agent` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `user_agent.original` instead. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` |
`http.flavor` 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. `http.flavor` 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.

26
docs/attributes-registry/network.md
View File

@ -103,19 +103,19 @@ different processes could be listening on TCP port 12345 and UDP port 12345.
<!-- semconv network-deprecated(omit_requirement_level) --> <!-- semconv network-deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | | Attribute | Type | Description | Examples |
|---|---|---|---| |---|---|---|---|
| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | | `net.host.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.address`. | `example.com` |
| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | | `net.host.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.port`. | `8080` |
| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | | `net.peer.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` |
| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | | `net.peer.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` |
| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | | `net.protocol.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` |
| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | | `net.protocol.version` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.protocol.version`. | `3.1.1` |
| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet` | | `net.sock.family` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.transport` and `network.type`. | `inet` |
| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | | `net.sock.host.addr` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.local.address`. | `/var/my.sock` |
| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | | `net.sock.host.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.local.port`. | `8080` |
| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | | `net.sock.peer.addr` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.peer.address`. | `192.168.0.1` |
| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | | `net.sock.peer.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, no replacement at this time. | `/var/my.sock` |
| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | | `net.sock.peer.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.peer.port`. | `65531` |
| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp` | | `net.transport` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.transport`. | `ip_tcp` |
`net.sock.family` 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. `net.sock.family` 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.

18
model/registry/deprecated/http.yaml
View File

@ -7,37 +7,37 @@ groups:
- id: method - id: method
type: string type: string
brief: 'Deprecated, use `http.request.method` instead.' brief: 'Deprecated, use `http.request.method` instead.'
stability: deprecated deprecated: "Replaced by `http.request.method`."
examples: ["GET", "POST", "HEAD"] examples: ["GET", "POST", "HEAD"]
- id: status_code - id: status_code
type: int type: int
brief: 'Deprecated, use `http.response.status_code` instead.' brief: 'Deprecated, use `http.response.status_code` instead.'
stability: deprecated deprecated: "Replaced by `http.response.status_code`."
examples: [200] examples: [200]
- id: scheme - id: scheme
type: string type: string
brief: 'Deprecated, use `url.scheme` instead.' brief: 'Deprecated, use `url.scheme` instead.'
stability: deprecated deprecated: "Replaced by `url.scheme` instead."
examples: ['http', 'https'] examples: ['http', 'https']
- id: url - id: url
type: string type: string
brief: 'Deprecated, use `url.full` instead.' brief: 'Deprecated, use `url.full` instead.'
stability: deprecated deprecated: "Replaced by `url.full`."
examples: ['https://www.foo.bar/search?q=OpenTelemetry#SemConv'] examples: ['https://www.foo.bar/search?q=OpenTelemetry#SemConv']
- id: target - id: target
type: string type: string
brief: 'Deprecated, use `url.path` and `url.query` instead.' brief: 'Deprecated, use `url.path` and `url.query` instead.'
stability: deprecated deprecated: "Split to `url.path` and `url.query."
examples: ['/search?q=OpenTelemetry#SemConv'] examples: ['/search?q=OpenTelemetry#SemConv']
- id: request_content_length - id: request_content_length
type: int type: int
brief: 'Deprecated, use `http.request.header.content-length` instead.' brief: 'Deprecated, use `http.request.header.content-length` instead.'
stability: deprecated deprecated: "Replaced by `http.request.header.content-length`."
examples: 3495 examples: 3495
- id: response_content_length - id: response_content_length
type: int type: int
brief: 'Deprecated, use `http.response.header.content-length` instead.' brief: 'Deprecated, use `http.response.header.content-length` instead.'
stability: deprecated deprecated: "Replaced by `http.response.header.content-length`."
examples: 3495 examples: 3495
- id: flavor - id: flavor
type: type:
@ -62,10 +62,10 @@ groups:
value: 'QUIC' value: 'QUIC'
brief: 'QUIC protocol.' brief: 'QUIC protocol.'
brief: 'Deprecated, use `network.protocol.name` instead.' brief: 'Deprecated, use `network.protocol.name` instead.'
stability: deprecated deprecated: "Replaced by `network.protocol.name`."
- id: user_agent - id: user_agent
type: string type: string
brief: 'Deprecated, use `user_agent.original` instead.' brief: 'Deprecated, use `user_agent.original` instead.'
examples: ['CERN-LineMode/2.15 libwww/2.17b3', examples: ['CERN-LineMode/2.15 libwww/2.17b3',
'Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1'] 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1']
stability: deprecated deprecated: "Replaced by `user_agent.original`."

26
model/registry/deprecated/network.yaml
View File

@ -7,47 +7,47 @@ groups:
attributes: attributes:
- id: sock.peer.name - id: sock.peer.name
type: string type: string
stability: deprecated deprecated: "Removed."
brief: Deprecated, no replacement at this time. brief: Deprecated, no replacement at this time.
examples: ['/var/my.sock'] examples: ['/var/my.sock']
- id: sock.peer.addr - id: sock.peer.addr
type: string type: string
stability: deprecated deprecated: "Replaced by `network.peer.address`."
brief: Deprecated, use `network.peer.address`. brief: Deprecated, use `network.peer.address`.
examples: ['192.168.0.1'] examples: ['192.168.0.1']
- id: sock.peer.port - id: sock.peer.port
type: int type: int
stability: deprecated deprecated: "Replaced by `network.peer.port`."
examples: [65531] examples: [65531]
brief: Deprecated, use `network.peer.port`. brief: Deprecated, use `network.peer.port`.
- id: peer.name - id: peer.name
type: string type: string
stability: deprecated deprecated: "Replaced by `server.address` on client spans and `client.address` on server spans."
brief: Deprecated, use `server.address` on client spans and `client.address` on server spans. brief: Deprecated, use `server.address` on client spans and `client.address` on server spans.
examples: ['example.com'] examples: ['example.com']
- id: peer.port - id: peer.port
type: int type: int
stability: deprecated deprecated: "Replaced by `server.port` on client spans and `client.port` on server spans."
brief: Deprecated, use `server.port` on client spans and `client.port` on server spans. brief: Deprecated, use `server.port` on client spans and `client.port` on server spans.
examples: [8080] examples: [8080]
- id: host.name - id: host.name
type: string type: string
stability: deprecated deprecated: "Replaced by `server.address`."
brief: Deprecated, use `server.address`. brief: Deprecated, use `server.address`.
examples: ['example.com'] examples: ['example.com']
- id: host.port - id: host.port
type: int type: int
stability: deprecated deprecated: "Replaced by `server.port`."
brief: Deprecated, use `server.port`. brief: Deprecated, use `server.port`.
examples: [8080] examples: [8080]
- id: sock.host.addr - id: sock.host.addr
type: string type: string
stability: deprecated deprecated: "Replaced by `network.local.address`."
brief: Deprecated, use `network.local.address`. brief: Deprecated, use `network.local.address`.
examples: ['/var/my.sock'] examples: ['/var/my.sock']
- id: sock.host.port - id: sock.host.port
type: int type: int
stability: deprecated deprecated: "Replaced by `network.local.port`."
brief: Deprecated, use `network.local.port`. brief: Deprecated, use `network.local.port`.
examples: [8080] examples: [8080]
- id: transport - id: transport
@ -71,16 +71,16 @@ groups:
- id: other - id: other
value: "other" value: "other"
brief: 'Something else (non IP-based).' brief: 'Something else (non IP-based).'
stability: deprecated deprecated: "Replaced by `network.transport`."
brief: Deprecated, use `network.transport`. brief: Deprecated, use `network.transport`.
- id: protocol.name - id: protocol.name
type: string type: string
stability: deprecated deprecated: "Replaced by `network.protocol.name`."
brief: Deprecated, use `network.protocol.name`. brief: Deprecated, use `network.protocol.name`.
examples: ['amqp', 'http', 'mqtt'] examples: ['amqp', 'http', 'mqtt']
- id: protocol.version - id: protocol.version
type: string type: string
stability: deprecated deprecated: "Replaced by `network.protocol.version`."
brief: Deprecated, use `network.protocol.version`. brief: Deprecated, use `network.protocol.version`.
examples: '3.1.1' examples: '3.1.1'
- id: sock.family - id: sock.family
@ -96,5 +96,5 @@ groups:
- id: unix - id: unix
value: 'unix' value: 'unix'
brief: "Unix domain socket path" brief: "Unix domain socket path"
stability: deprecated deprecated: "Split to `network.transport` and `network.type`."
brief: Deprecated, use `network.transport` and `network.type`. brief: Deprecated, use `network.transport` and `network.type`.