From 8e4aa3db607a32ed08b87aeb231c933a2fa02242 Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 10 May 2024 10:02:33 -0400 Subject: [PATCH 1/6] Add `net.peer.ip` and `net.host.ip` to deprecated yaml --- .chloggen/deprecated-net.yaml | 22 ++++++++++++++++++++++ docs/attributes-registry/network.md | 2 ++ model/registry/deprecated/network.yaml | 10 ++++++++++ 3 files changed, 34 insertions(+) create mode 100755 .chloggen/deprecated-net.yaml diff --git a/.chloggen/deprecated-net.yaml b/.chloggen/deprecated-net.yaml new file mode 100755 index 0000000000..b2e272bd06 --- /dev/null +++ b/.chloggen/deprecated-net.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: deprecation + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: net + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Add deprecated net attributes to registry + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: These attributes were deprecated in 1.13 diff --git a/docs/attributes-registry/network.md b/docs/attributes-registry/network.md index 9d038e5e0a..56c960ea1a 100644 --- a/docs/attributes-registry/network.md +++ b/docs/attributes-registry/network.md @@ -107,8 +107,10 @@ These attributes may be used for any network related operation. | Attribute | Type | Description | Examples | Stability | | ---------------------- | ------ | -------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `net.host.ip` | string | Deprecated, use `net.sock.host.addr`. | `192.168.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `net.sock.host.addr`. | | `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | | `net.host.port` | int | Deprecated, use `server.port`. | `8080` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port`. | +| `net.peer.ip` | string | Deprecated, use `net.sock.peer.addr`. | `127.0.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `net.sock.peer.addr`. | | `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` on client spans and `client.address` on server spans. | | `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port` on client spans and `client.port` on server spans. | | `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.name`. | diff --git a/model/registry/deprecated/network.yaml b/model/registry/deprecated/network.yaml index 6614467174..f90a77b7a9 100644 --- a/model/registry/deprecated/network.yaml +++ b/model/registry/deprecated/network.yaml @@ -35,12 +35,22 @@ groups: stability: experimental brief: Deprecated, use `server.port` on client spans and `client.port` on server spans. examples: [8080] + - id: peer.ip + type: string + deprecated: "Replaced by `net.sock.peer.addr`." + brief: Deprecated, use `net.sock.peer.addr`. + examples: '127.0.0.1' - id: host.name type: string deprecated: "Replaced by `server.address`." stability: experimental brief: Deprecated, use `server.address`. examples: ['example.com'] + - id: host.ip + type: string + deprecated: "Replaced by `net.sock.host.addr`." + brief: Deprecated, use `net.sock.host.addr`. + examples: '192.168.0.1' - id: host.port type: int deprecated: "Replaced by `server.port`." From e420156acee6bcdde22db578d322dd3375d1588c Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 10 May 2024 10:04:36 -0400 Subject: [PATCH 2/6] Add issue number to chlog --- .chloggen/deprecated-net.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.chloggen/deprecated-net.yaml b/.chloggen/deprecated-net.yaml index b2e272bd06..a004cb5410 100755 --- a/.chloggen/deprecated-net.yaml +++ b/.chloggen/deprecated-net.yaml @@ -14,7 +14,7 @@ note: Add deprecated net attributes to registry # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. # The values here must be integers. -issues: [] +issues: [1029] # (Optional) One or more lines of additional information to render under the primary note. # These lines will be padded with 2 spaces and then inserted directly into the document. From c0793b1c1fecb17087bf8b49ac954a030cfa4f80 Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 10 May 2024 10:21:28 -0400 Subject: [PATCH 3/6] Add required stability --- model/registry/deprecated/network.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/model/registry/deprecated/network.yaml b/model/registry/deprecated/network.yaml index f90a77b7a9..6f47e12fcd 100644 --- a/model/registry/deprecated/network.yaml +++ b/model/registry/deprecated/network.yaml @@ -38,6 +38,7 @@ groups: - id: peer.ip type: string deprecated: "Replaced by `net.sock.peer.addr`." + stability: experimental brief: Deprecated, use `net.sock.peer.addr`. examples: '127.0.0.1' - id: host.name @@ -49,6 +50,7 @@ groups: - id: host.ip type: string deprecated: "Replaced by `net.sock.host.addr`." + stability: experimental brief: Deprecated, use `net.sock.host.addr`. examples: '192.168.0.1' - id: host.port From 035949df72564f85f8c251bcb88a3e94b22d69cc Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 10 May 2024 11:09:29 -0400 Subject: [PATCH 4/6] Update comment to use latest network attrs --- model/registry/deprecated/network.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/model/registry/deprecated/network.yaml b/model/registry/deprecated/network.yaml index 6f47e12fcd..f13c79f9a9 100644 --- a/model/registry/deprecated/network.yaml +++ b/model/registry/deprecated/network.yaml @@ -37,9 +37,9 @@ groups: examples: [8080] - id: peer.ip type: string - deprecated: "Replaced by `net.sock.peer.addr`." + deprecated: "Replaced by `network.peer.address`." stability: experimental - brief: Deprecated, use `net.sock.peer.addr`. + brief: Deprecated, use `network.peer.address`. examples: '127.0.0.1' - id: host.name type: string @@ -49,9 +49,9 @@ groups: examples: ['example.com'] - id: host.ip type: string - deprecated: "Replaced by `net.sock.host.addr`." + deprecated: "Replaced by `network.local.address`." stability: experimental - brief: Deprecated, use `net.sock.host.addr`. + brief: Deprecated, use `network.local.address`. examples: '192.168.0.1' - id: host.port type: int From 4c45879ce4ea80ff5506eda452b447771043df2d Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 10 May 2024 11:12:02 -0400 Subject: [PATCH 5/6] Generate markdown --- docs/attributes-registry/network.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/attributes-registry/network.md b/docs/attributes-registry/network.md index 56c960ea1a..bd23b59169 100644 --- a/docs/attributes-registry/network.md +++ b/docs/attributes-registry/network.md @@ -107,10 +107,10 @@ These attributes may be used for any network related operation. | Attribute | Type | Description | Examples | Stability | | ---------------------- | ------ | -------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `net.host.ip` | string | Deprecated, use `net.sock.host.addr`. | `192.168.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `net.sock.host.addr`. | +| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | | `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | | `net.host.port` | int | Deprecated, use `server.port`. | `8080` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port`. | -| `net.peer.ip` | string | Deprecated, use `net.sock.peer.addr`. | `127.0.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `net.sock.peer.addr`. | +| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | | `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` on client spans and `client.address` on server spans. | | `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port` on client spans and `client.port` on server spans. | | `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.name`. | From 669d4218cf6181e5d8e317d04af2ac5505f55efa Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 10 May 2024 12:52:38 -0400 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Trask Stalnaker --- .chloggen/deprecated-net.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.chloggen/deprecated-net.yaml b/.chloggen/deprecated-net.yaml index a004cb5410..956d01ff28 100755 --- a/.chloggen/deprecated-net.yaml +++ b/.chloggen/deprecated-net.yaml @@ -4,13 +4,13 @@ # your pull request title with [chore] or use the "Skip Changelog" label. # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' -change_type: deprecation +change_type: bug_fix # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) component: net # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). -note: Add deprecated net attributes to registry +note: Add previously deprecated net attributes to registry # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. # The values here must be integers.