From 62342e45a4b32552036b721138cdbe55a891c13c Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Mon, 8 Jul 2024 11:34:33 -0700 Subject: [PATCH 1/3] Deprecate tls.client.server_name attribute in favor of common server.address --- docs/attributes-registry/tls.md | 12 +++++++++++- model/registry/deprecated/tls.yaml | 11 +++++++++++ model/registry/tls.yaml | 5 ----- schema-next.yaml | 4 ++++ 4 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 model/registry/deprecated/tls.yaml diff --git a/docs/attributes-registry/tls.md b/docs/attributes-registry/tls.md index e6cdb56b19..ac4df8366a 100644 --- a/docs/attributes-registry/tls.md +++ b/docs/attributes-registry/tls.md @@ -6,6 +6,9 @@ # TLS +- [Tls](#tls-attributes) +- [Tls Deprecated](#tls-deprecated-attributes) + ## TLS Attributes This document defines semantic convention attributes in the TLS namespace. @@ -22,7 +25,6 @@ This document defines semantic convention attributes in the TLS namespace. | `tls.client.ja3` | string | A hash that identifies clients based on how they perform an SSL/TLS handshake. | `d4e5b18d6b55c71272893221c96ba240` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tls.client.not_after` | string | Date/Time indicating when client certificate is no longer considered valid. | `2021-01-01T00:00:00.000Z` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tls.client.not_before` | string | Date/Time indicating when client certificate is first considered valid. | `1970-01-01T00:00:00.000Z` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `tls.client.server_name` | string | Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. | `opentelemetry.io` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tls.client.subject` | string | Distinguished name of subject of the x.509 certificate presented by the client. | `CN=myclient, OU=Documentation Team, DC=example, DC=com` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tls.client.supported_ciphers` | string[] | Array of ciphers offered by the client during the client hello. | `["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "..."]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tls.curve` | string | String indicating the curve used for the given cipher, when applicable | `secp256r1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -50,3 +52,11 @@ This document defines semantic convention attributes in the TLS namespace. | ----- | ----------- | ---------------------------------------------------------------- | | `ssl` | ssl | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tls` | tls | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +## TLS Deprecated Attributes + +Describes deprecated `tls`` attributes. + +| Attribute | Type | Description | Examples | Stability | +| ------------------------ | ------ | ----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------ | +| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address | diff --git a/model/registry/deprecated/tls.yaml b/model/registry/deprecated/tls.yaml new file mode 100644 index 0000000000..a682a2ee19 --- /dev/null +++ b/model/registry/deprecated/tls.yaml @@ -0,0 +1,11 @@ +groups: + - id: registry.tls.deprecated + type: attribute_group + brief: Describes deprecated `tls`` attributes. + attributes: + - id: tls.client.server_name + type: string + stability: experimental + deprecated: "Replaced by `server.address" + brief: "Deprecated, use `server.address` instead." + examples: ["opentelemetry.io"] \ No newline at end of file diff --git a/model/registry/tls.yaml b/model/registry/tls.yaml index 2c4f31a752..c7fc6303a7 100644 --- a/model/registry/tls.yaml +++ b/model/registry/tls.yaml @@ -73,11 +73,6 @@ groups: stability: experimental brief: "Date/Time indicating when client certificate is first considered valid." examples: ["1970-01-01T00:00:00.000Z"] - - id: client.server_name - type: string - stability: experimental - brief: "Also called an SNI, this tells the server which hostname to which the client is attempting to connect to." - examples: ["opentelemetry.io"] - id: client.subject type: string stability: experimental diff --git a/schema-next.yaml b/schema-next.yaml index b2d310bd77..dd61fcf750 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -4,6 +4,10 @@ versions: next: all: changes: + # https://github.com/open-telemetry/semantic-conventions/pull/TODO + - rename_attributes: + attribute_map: + tls.client.server_name: server.address # https://github.com/open-telemetry/semantic-conventions/pull/815 - rename_attributes: attribute_map: From a47c01407cc55cf820aeb511596f880c9ecdbd6c Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Mon, 8 Jul 2024 11:38:50 -0700 Subject: [PATCH 2/3] changelog --- .chloggen/1216.yaml | 5 +++++ schema-next.yaml | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .chloggen/1216.yaml diff --git a/.chloggen/1216.yaml b/.chloggen/1216.yaml new file mode 100644 index 0000000000..27b98da42a --- /dev/null +++ b/.chloggen/1216.yaml @@ -0,0 +1,5 @@ +change_type: breaking +component: tls +note: > + Deprecate `tls.client.server_name attribute` in favor of common `server.address`. +issues: [ 1211, 1216 ] diff --git a/schema-next.yaml b/schema-next.yaml index dd61fcf750..dea261c757 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -4,7 +4,7 @@ versions: next: all: changes: - # https://github.com/open-telemetry/semantic-conventions/pull/TODO + # https://github.com/open-telemetry/semantic-conventions/pull/1216 - rename_attributes: attribute_map: tls.client.server_name: server.address From 6f0e96297533ed42b43e0b46ea8afe70e980d55c Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Mon, 8 Jul 2024 11:40:54 -0700 Subject: [PATCH 3/3] lint --- docs/attributes-registry/tls.md | 8 ++++---- model/registry/deprecated/tls.yaml | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/attributes-registry/tls.md b/docs/attributes-registry/tls.md index ac4df8366a..e17de0dc0a 100644 --- a/docs/attributes-registry/tls.md +++ b/docs/attributes-registry/tls.md @@ -55,8 +55,8 @@ This document defines semantic convention attributes in the TLS namespace. ## TLS Deprecated Attributes -Describes deprecated `tls`` attributes. +Describes deprecated `tls` attributes. -| Attribute | Type | Description | Examples | Stability | -| ------------------------ | ------ | ----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------ | -| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address | +| Attribute | Type | Description | Examples | Stability | +| ------------------------ | ------ | ----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------- | +| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address. | diff --git a/model/registry/deprecated/tls.yaml b/model/registry/deprecated/tls.yaml index a682a2ee19..ebde7b32d4 100644 --- a/model/registry/deprecated/tls.yaml +++ b/model/registry/deprecated/tls.yaml @@ -1,11 +1,11 @@ groups: - id: registry.tls.deprecated type: attribute_group - brief: Describes deprecated `tls`` attributes. + brief: Describes deprecated `tls` attributes. attributes: - id: tls.client.server_name type: string stability: experimental - deprecated: "Replaced by `server.address" + deprecated: "Replaced by `server.address." brief: "Deprecated, use `server.address` instead." - examples: ["opentelemetry.io"] \ No newline at end of file + examples: ["opentelemetry.io"]