From 5f63c137a895fafb73215179e9132772977ef9a5 Mon Sep 17 00:00:00 2001 From: Harikrishna Patnala Date: Thu, 4 Dec 2025 15:09:56 +0530 Subject: [PATCH 1/3] Log4j file details --- .../upgrading/upgrade/_log4j_file_check.rst | 26 +++++++++++++++++++ source/upgrading/upgrade/upgrade-4.20.rst | 2 ++ source/upgrading/upgrade/upgrade-4.21.rst | 2 ++ source/upgrading/upgrade/upgrade-4.22.rst | 2 ++ 4 files changed, 32 insertions(+) create mode 100644 source/upgrading/upgrade/_log4j_file_check.rst diff --git a/source/upgrading/upgrade/_log4j_file_check.rst b/source/upgrading/upgrade/_log4j_file_check.rst new file mode 100644 index 0000000000..62cdd2ffa4 --- /dev/null +++ b/source/upgrading/upgrade/_log4j_file_check.rst @@ -0,0 +1,26 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information# + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. sub-section included in upgrade notes. + +.. note:: + + During upgrades from versions prior to 4.20, the logging configuration file may not be migrated automatically to the new Log4j2 format - especially if the original log4j configuration file was manually customized or modified. + + It is strongly recommended to verify **before starting the Management Server** that the configuration file under `/etc/cloudstack/management` and `/etc/cloudstack/usage` (e.g., `log4j-cloud.xml`) uses the Log4j2 format. + + If the file still uses legacy Log4j (version 1) syntax or structure, **manually replace or update** the configuration using the default Log4j2 configuration supplied with the latest package. + + Failure to update may result in missing or incomplete log generation after upgrade. diff --git a/source/upgrading/upgrade/upgrade-4.20.rst b/source/upgrading/upgrade/upgrade-4.20.rst index 083ac2e81e..dacf9a1ca6 100644 --- a/source/upgrading/upgrade/upgrade-4.20.rst +++ b/source/upgrading/upgrade/upgrade-4.20.rst @@ -207,6 +207,8 @@ Setup the GPG public key if you wish to enable ``gpgcheck=1``: $ sudo yum upgrade cloudstack-usage +.. include:: _log4j_file_check.rst + .. _upg_hyp_414: Upgrade Hypervisors diff --git a/source/upgrading/upgrade/upgrade-4.21.rst b/source/upgrading/upgrade/upgrade-4.21.rst index 0449de1645..441990c851 100644 --- a/source/upgrading/upgrade/upgrade-4.21.rst +++ b/source/upgrading/upgrade/upgrade-4.21.rst @@ -207,6 +207,8 @@ Setup the GPG public key if you wish to enable ``gpgcheck=1``: $ sudo yum upgrade cloudstack-usage +.. include:: _log4j_file_check.rst + .. _upg_hyp_414: Upgrade Hypervisors diff --git a/source/upgrading/upgrade/upgrade-4.22.rst b/source/upgrading/upgrade/upgrade-4.22.rst index 38ad410ecb..333fa2aaca 100644 --- a/source/upgrading/upgrade/upgrade-4.22.rst +++ b/source/upgrading/upgrade/upgrade-4.22.rst @@ -216,6 +216,8 @@ Setup the GPG public key if you wish to enable ``gpgcheck=1``: $ sudo yum upgrade cloudstack-usage +.. include:: _log4j_file_check.rst + .. _upg_hyp_414: Upgrade Hypervisors From c5d09e8d09c9c7b449f2fd7ba5ad524e4ce7d3e1 Mon Sep 17 00:00:00 2001 From: Harikrishna Date: Fri, 5 Dec 2025 12:57:50 +0530 Subject: [PATCH 2/3] Update source/upgrading/upgrade/_log4j_file_check.rst Co-authored-by: Suresh Kumar Anaparti --- source/upgrading/upgrade/_log4j_file_check.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/upgrading/upgrade/_log4j_file_check.rst b/source/upgrading/upgrade/_log4j_file_check.rst index 62cdd2ffa4..8e7efe6ffa 100644 --- a/source/upgrading/upgrade/_log4j_file_check.rst +++ b/source/upgrading/upgrade/_log4j_file_check.rst @@ -19,7 +19,7 @@ During upgrades from versions prior to 4.20, the logging configuration file may not be migrated automatically to the new Log4j2 format - especially if the original log4j configuration file was manually customized or modified. - It is strongly recommended to verify **before starting the Management Server** that the configuration file under `/etc/cloudstack/management` and `/etc/cloudstack/usage` (e.g., `log4j-cloud.xml`) uses the Log4j2 format. + It is strongly recommended to verify **before starting the Management Server and the Usage Server** that the configuration file under `/etc/cloudstack/management` and `/etc/cloudstack/usage` (e.g., `log4j-cloud.xml`) respectively uses the Log4j2 format. If the file still uses legacy Log4j (version 1) syntax or structure, **manually replace or update** the configuration using the default Log4j2 configuration supplied with the latest package. From 6879425b8e750cedab67cf3a136c4d657944bb18 Mon Sep 17 00:00:00 2001 From: Harikrishna Date: Fri, 5 Dec 2025 15:56:00 +0530 Subject: [PATCH 3/3] Update source/upgrading/upgrade/_log4j_file_check.rst Co-authored-by: Suresh Kumar Anaparti --- source/upgrading/upgrade/_log4j_file_check.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/upgrading/upgrade/_log4j_file_check.rst b/source/upgrading/upgrade/_log4j_file_check.rst index 8e7efe6ffa..28a22fd984 100644 --- a/source/upgrading/upgrade/_log4j_file_check.rst +++ b/source/upgrading/upgrade/_log4j_file_check.rst @@ -19,7 +19,7 @@ During upgrades from versions prior to 4.20, the logging configuration file may not be migrated automatically to the new Log4j2 format - especially if the original log4j configuration file was manually customized or modified. - It is strongly recommended to verify **before starting the Management Server and the Usage Server** that the configuration file under `/etc/cloudstack/management` and `/etc/cloudstack/usage` (e.g., `log4j-cloud.xml`) respectively uses the Log4j2 format. + It is strongly recommended to verify **before starting the Management Server and the Usage Server** that the configuration file (e.g. `log4j-cloud.xml`) under `/etc/cloudstack/management` and `/etc/cloudstack/usage` respectively uses the Log4j2 format. If the file still uses legacy Log4j (version 1) syntax or structure, **manually replace or update** the configuration using the default Log4j2 configuration supplied with the latest package.