From 3c37ca34b19744d7c9adb61a850691f31005d4c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicklas=20M=C3=B8ller?= Date: Mon, 27 Jan 2025 22:20:28 +0100 Subject: [PATCH] docs: remove references to dead metric `tcp_connection_duration_ms` (#1905) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: remove references to dead metric `tcp_connection_duration_ms` This metric was dropped in https://github.com/linkerd/linkerd2-proxy/pull/930 Signed-off-by: Nicklas Møller * docs: remove `tcp_connection_duration_ms` reference from 2.10 Signed-off-by: Nicklas Møller * docs: remove references to tcp_connection_duration_ms altogether This metrics was removed in 2.10, but was incorrectly attributed to 2.11 in the upgrade docs, as of https://github.com/linkerd/website/commit/e9ae7770ea685336aa9b2aa0b9f802b028f9aa76#diff-f4328e2dffc88e1711b12c9719e0f948d4bdd73be957179eeb3ceacc8391fe29 It was never incorporated into the original 2.10 docs: https://github.com/linkerd/website/blob/e9ae7770ea685336aa9b2aa0b9f802b028f9aa76/linkerd.io/content/2.10/tasks/upgrade.md Opting to just leave it out - it's been years on end, and the metric itself was taken out due to a memory leak: it's not super likely that someone will come around in the future, missing the metric, after potentially upgrading from 2.10. Signed-off-by: Nicklas Møller --------- Signed-off-by: Nicklas Møller Co-authored-by: Flynn --- linkerd.io/content/2-edge/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2-edge/tasks/upgrade.md | 1 - linkerd.io/content/2.10/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.11/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.11/tasks/upgrade.md | 1 - linkerd.io/content/2.12/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.12/tasks/upgrade.md | 1 - linkerd.io/content/2.13/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.13/tasks/upgrade.md | 1 - linkerd.io/content/2.14/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.14/tasks/upgrade.md | 1 - linkerd.io/content/2.15/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.15/tasks/upgrade.md | 1 - linkerd.io/content/2.16/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.16/tasks/upgrade.md | 1 - linkerd.io/content/2.17/reference/proxy-metrics.md | 4 +--- linkerd.io/content/2.17/tasks/upgrade.md | 1 - 17 files changed, 9 insertions(+), 35 deletions(-) diff --git a/linkerd.io/content/2-edge/reference/proxy-metrics.md b/linkerd.io/content/2-edge/reference/proxy-metrics.md index feb6de3d24..badf921ad1 100644 --- a/linkerd.io/content/2-edge/reference/proxy-metrics.md +++ b/linkerd.io/content/2-edge/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2-edge/tasks/upgrade.md b/linkerd.io/content/2-edge/tasks/upgrade.md index efa33b96f8..b0d10dead3 100644 --- a/linkerd.io/content/2-edge/tasks/upgrade.md +++ b/linkerd.io/content/2-edge/tasks/upgrade.md @@ -591,7 +591,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.10/reference/proxy-metrics.md b/linkerd.io/content/2.10/reference/proxy-metrics.md index 3a93366283..17c756f73e 100644 --- a/linkerd.io/content/2.10/reference/proxy-metrics.md +++ b/linkerd.io/content/2.10/reference/proxy-metrics.md @@ -164,8 +164,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. ### Labels @@ -184,7 +182,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.11/reference/proxy-metrics.md b/linkerd.io/content/2.11/reference/proxy-metrics.md index 3a93366283..17c756f73e 100644 --- a/linkerd.io/content/2.11/reference/proxy-metrics.md +++ b/linkerd.io/content/2.11/reference/proxy-metrics.md @@ -164,8 +164,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. ### Labels @@ -184,7 +182,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.11/tasks/upgrade.md b/linkerd.io/content/2.11/tasks/upgrade.md index 3d24c45cd5..970f3b0dc9 100644 --- a/linkerd.io/content/2.11/tasks/upgrade.md +++ b/linkerd.io/content/2.11/tasks/upgrade.md @@ -294,7 +294,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.12/reference/proxy-metrics.md b/linkerd.io/content/2.12/reference/proxy-metrics.md index 365e85d92e..2c0d976776 100644 --- a/linkerd.io/content/2.12/reference/proxy-metrics.md +++ b/linkerd.io/content/2.12/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.12/tasks/upgrade.md b/linkerd.io/content/2.12/tasks/upgrade.md index e2951b4920..6cbe0c4c46 100644 --- a/linkerd.io/content/2.12/tasks/upgrade.md +++ b/linkerd.io/content/2.12/tasks/upgrade.md @@ -501,7 +501,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.13/reference/proxy-metrics.md b/linkerd.io/content/2.13/reference/proxy-metrics.md index 43f5141b23..62aee7c265 100644 --- a/linkerd.io/content/2.13/reference/proxy-metrics.md +++ b/linkerd.io/content/2.13/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.13/tasks/upgrade.md b/linkerd.io/content/2.13/tasks/upgrade.md index b798663512..4a91846036 100644 --- a/linkerd.io/content/2.13/tasks/upgrade.md +++ b/linkerd.io/content/2.13/tasks/upgrade.md @@ -514,7 +514,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.14/reference/proxy-metrics.md b/linkerd.io/content/2.14/reference/proxy-metrics.md index 743aebf3c2..4b22b02d91 100644 --- a/linkerd.io/content/2.14/reference/proxy-metrics.md +++ b/linkerd.io/content/2.14/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.14/tasks/upgrade.md b/linkerd.io/content/2.14/tasks/upgrade.md index 9cdbbcf0f4..8991367cec 100644 --- a/linkerd.io/content/2.14/tasks/upgrade.md +++ b/linkerd.io/content/2.14/tasks/upgrade.md @@ -529,7 +529,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.15/reference/proxy-metrics.md b/linkerd.io/content/2.15/reference/proxy-metrics.md index 743aebf3c2..4b22b02d91 100644 --- a/linkerd.io/content/2.15/reference/proxy-metrics.md +++ b/linkerd.io/content/2.15/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.15/tasks/upgrade.md b/linkerd.io/content/2.15/tasks/upgrade.md index efa33b96f8..b0d10dead3 100644 --- a/linkerd.io/content/2.15/tasks/upgrade.md +++ b/linkerd.io/content/2.15/tasks/upgrade.md @@ -591,7 +591,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.16/reference/proxy-metrics.md b/linkerd.io/content/2.16/reference/proxy-metrics.md index feb6de3d24..badf921ad1 100644 --- a/linkerd.io/content/2.16/reference/proxy-metrics.md +++ b/linkerd.io/content/2.16/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.16/tasks/upgrade.md b/linkerd.io/content/2.16/tasks/upgrade.md index efa33b96f8..b0d10dead3 100644 --- a/linkerd.io/content/2.16/tasks/upgrade.md +++ b/linkerd.io/content/2.16/tasks/upgrade.md @@ -591,7 +591,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added diff --git a/linkerd.io/content/2.17/reference/proxy-metrics.md b/linkerd.io/content/2.17/reference/proxy-metrics.md index feb6de3d24..badf921ad1 100644 --- a/linkerd.io/content/2.17/reference/proxy-metrics.md +++ b/linkerd.io/content/2.17/reference/proxy-metrics.md @@ -192,8 +192,6 @@ layer. updated when the connection closes. * `tcp_read_bytes_total`: A counter of the total number of received bytes. This is updated when the connection closes. -* `tcp_connection_duration_ms`: A histogram of the duration of the lifetime of a - connection, in milliseconds. This is updated when the connection closes. * `inbound_tcp_errors_total`: A counter of the total number of inbound TCP connections that could not be processed due to a proxy error. * `outbound_tcp_errors_total`: A counter of the total number of outbound TCP @@ -220,7 +218,7 @@ are also added to transport-level metrics, when applicable. #### Connection Close Labels The following labels are added only to metrics which are updated when a -connection closes (`tcp_close_total` and `tcp_connection_duration_ms`): +connection closes (`tcp_close_total`): * `classification`: `success` if the connection terminated cleanly, `failure` if the connection closed due to a connection failure. diff --git a/linkerd.io/content/2.17/tasks/upgrade.md b/linkerd.io/content/2.17/tasks/upgrade.md index efa33b96f8..b0d10dead3 100644 --- a/linkerd.io/content/2.17/tasks/upgrade.md +++ b/linkerd.io/content/2.17/tasks/upgrade.md @@ -591,7 +591,6 @@ be aware of when upgrading from `stable-2.10.x`: result of their deprecation in Kubernetes v1.21 and above. The control plane and core extensions will now be shipped without PSPs; they can be enabled through a new install option `enablePSP: true`. -- The `tcp_connection_duration_ms` metric has been removed. - Opaque ports changes: `443` is no longer included in the default opaque ports list. Ports `4444`, `6379` and `9300` corresponding to Galera, Redis and ElasticSearch respectively (all server speak first protocols) have been added