Notes regarding Log4j2 format check in the log configuration (#604)

Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

Author: harikrishna-patnala

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 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.
+
+   Failure to update may result in missing or incomplete log generation after upgrade.

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

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

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