Skip to content

Notes regarding Log4j2 format check in the log configuration #604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DaanHoogland merged 3 commits into from
Dec 8, 2025
+32 −0
Merged

Notes regarding Log4j2 format check in the log configuration #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f63c13
Log4j file details
harikrishna-patnala Dec 4, 2025
c5d09e8
Update source/upgrading/upgrade/_log4j_file_check.rst
harikrishna-patnala Dec 5, 2025
6879425
Update source/upgrading/upgrade/_log4j_file_check.rst
harikrishna-patnala Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions source/upgrading/upgrade/_log4j_file_check.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions source/upgrading/upgrade/upgrade-4.20.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions source/upgrading/upgrade/upgrade-4.21.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions source/upgrading/upgrade/upgrade-4.22.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down