From bebd5edbbea62f34f140caa256c7b370283d5ef2 Mon Sep 17 00:00:00 2001 From: Amnon Heiman Date: Fri, 29 Dec 2023 02:46:05 +0200 Subject: [PATCH 1/3] upgrade-guide-from-monitoring-4.x-to-monitoring-4.y: Warn about breaking changes with targets ports --- ...guide-from-monitoring-4.x-to-monitoring-4.y.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst b/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst index d73f97479..a3cf3a2d5 100644 --- a/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst +++ b/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst @@ -27,13 +27,25 @@ Replace “y” with the new minor release number, for example, 4.0.1.zip Setting the server's files -------------------------- -Copy the ``scylla_servers.yml`` and ``scylla_manager_servers.yml`` from the version that is already installed. +Copy the target files ``scylla_servers.yml`` and ``scylla_manager_servers.yml`` from the version that is already installed. .. code-block:: bash cp /path/to/monitoring/4.x.a/prometheus/scylla_servers.yml prometheus/ cp /path/to/monitoring/4.x.a/prometheus/scylla_manager_servers.yml.yml prometheus/ +Validate the port numbers +^^^^^^^^^^^^^^^^^^^^^^^^^ +ScyllaDB-monitoring reads from ScyllaDB itself, from node_exporter for OS-related metrics, and from the ScyllaDB manager agent. + +Almost always, those targets use their default ports, and all share the same IP. +If you use the default port number, we recommend using the target file without ports and letting ScyllaDB monitoring add the default port number. +If the ScyllaDB manager agent and node_exporter are running next to ScyllaDB on the same host (the default installation), use one target file for scylla_server, and the ScyllaDB monitoring will use that file with the correct ports for each target. + +.. caution:: + + As of SyllaDB Monitoring 4.5, Specifying the node_exporter file (the -n flag) with the wrong ports will prevent ScyllaDB Monitoring from reading the metrics. + Validate the new version is running the correct version ------------------------------------------------------- From 72f1e8768a7bf6852a34a39db9a82d04676f65c8 Mon Sep 17 00:00:00 2001 From: Amnon Heiman Date: Wed, 3 Jan 2024 12:40:45 +0200 Subject: [PATCH 2/3] Update docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst Co-authored-by: Tzach Livyatan --- .../upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst b/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst index a3cf3a2d5..84bfac769 100644 --- a/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst +++ b/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst @@ -36,7 +36,7 @@ Copy the target files ``scylla_servers.yml`` and ``scylla_manager_servers.yml`` Validate the port numbers ^^^^^^^^^^^^^^^^^^^^^^^^^ -ScyllaDB-monitoring reads from ScyllaDB itself, from node_exporter for OS-related metrics, and from the ScyllaDB manager agent. +ScyllaDB-monitoring reads from ScyllaDB itself, from node_exporter for OS-related metrics, and from the ScyllaDB Manager agent. Almost always, those targets use their default ports, and all share the same IP. If you use the default port number, we recommend using the target file without ports and letting ScyllaDB monitoring add the default port number. From f57c81c24e0a38a50970b373f0799a564043717b Mon Sep 17 00:00:00 2001 From: Amnon Heiman Date: Wed, 3 Jan 2024 12:40:52 +0200 Subject: [PATCH 3/3] Update docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst Co-authored-by: Tzach Livyatan --- .../upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst b/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst index 84bfac769..59fd4f9a1 100644 --- a/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst +++ b/docs/source/upgrade/upgrade-guide-from-monitoring-4.x-to-monitoring-4.y.rst @@ -40,7 +40,7 @@ ScyllaDB-monitoring reads from ScyllaDB itself, from node_exporter for OS-relate Almost always, those targets use their default ports, and all share the same IP. If you use the default port number, we recommend using the target file without ports and letting ScyllaDB monitoring add the default port number. -If the ScyllaDB manager agent and node_exporter are running next to ScyllaDB on the same host (the default installation), use one target file for scylla_server, and the ScyllaDB monitoring will use that file with the correct ports for each target. +If the ScyllaDB Mmanager agent and node_exporter are running next to ScyllaDB on the same host (the default installation), use one target file for scylla_server, and the ScyllaDB monitoring will use that file with the correct ports for each target. .. caution::