Log4j2 refactor cloud api module #8728

KlausDornsbach · 2024-02-29T13:24:01Z

Description

With the new version of Log4j there is some space for improving log readability using the new features. This PR refactors the logs from the cloud-api module.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

How Has This Been Tested?

I have done some operations on cloudstack to induce the generation of the logs
No problems or changes to the log output were found

api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java

codecov · 2024-02-29T17:16:50Z

Codecov Report

❌ Patch coverage is 17.14286% with 58 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.50%. Comparing base (f417c6b) to head (7eebf2e).
⚠️ Report is 25 commits behind head on main.

Files with missing lines	Patch %	Lines
...in/java/com/cloud/agent/api/storage/OVFHelper.java	16.66%	15 Missing ⚠️
...k/api/command/user/template/CreateTemplateCmd.java	0.00%	4 Missing ⚠️
...i/command/admin/vm/ImportUnmanagedInstanceCmd.java	0.00%	3 Missing ⚠️
...in/java/com/cloud/agent/api/storage/OVFParser.java	0.00%	2 Missing ⚠️
...and/user/firewall/CreateEgressFirewallRuleCmd.java	0.00%	2 Missing ⚠️
...loadbalancer/ListLoadBalancerRuleInstancesCmd.java	0.00%	2 Missing ⚠️
...he/cloudstack/api/command/user/vm/DeployVMCmd.java	0.00%	2 Missing ⚠️
...dstack/api/command/user/vm/ResetVMPasswordCmd.java	0.00%	2 Missing ⚠️
...java/org/apache/cloudstack/context/LogContext.java	0.00%	2 Missing ⚠️
.../api/command/admin/autoscale/DeleteCounterCmd.java	0.00%	1 Missing ⚠️
... and 23 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #8728      +/-   ##
============================================
+ Coverage     17.46%   17.50%   +0.03%     
- Complexity    15516    15568      +52     
============================================
  Files          5913     5914       +1     
  Lines        529385   529623     +238     
  Branches      64679    64683       +4     
============================================
+ Hits          92448    92695     +247     
+ Misses       426518   426481      -37     
- Partials      10419    10447      +28

Flag	Coverage Δ
uitests	`3.58% <ø> (-0.01%)`	⬇️
unittests	`18.56% <17.14%> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-authored-by: Vishesh <vishesh92@gmail.com>

DaanHoogland

clgtm, I think we need to implement some policies on when to log stack traces though. cc @JoaoJandre

JoaoJandre

CLGTM

JoaoJandre · 2024-03-04T13:49:44Z

clgtm, I think we need to implement some policies on when to log stack traces though. cc @JoaoJandre

I think that some guidelines would be good, sadly the discussion regarding this never got traction on the dev mailing list.

DaanHoogland · 2024-03-05T10:24:50Z

clgtm, I think we need to implement some policies on when to log stack traces though. cc @JoaoJandre

I think that some guidelines would be good, sadly the discussion regarding this never got traction on the dev mailing list.

maybe this will work better : #8746

github-actions · 2024-03-08T10:41:03Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2024-06-13T06:46:16Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2024-06-25T14:12:08Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

DaanHoogland · 2024-07-01T08:11:49Z

@blueorangutan package

blueorangutan · 2024-07-01T08:14:03Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-07-01T08:18:40Z

Packaging result [SF]: ✖️ el7 ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 10219

DaanHoogland

lgtm generally, but foun d one possible problem

api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java

Co-authored-by: dahn <daan.hoogland@gmail.com>

api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java

api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java

...c/main/java/org/apache/cloudstack/api/command/user/firewall/CreateEgressFirewallRuleCmd.java

api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLListCmd.java

...in/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotFromVMSnapshotCmd.java

api/src/main/java/org/apache/cloudstack/context/LogContext.java

GutoVeronezi · 2025-12-17T00:05:51Z

@blueorangutan package

blueorangutan · 2025-12-17T00:08:04Z

@GutoVeronezi a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-12-17T01:44:13Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✔️ debian ✖️ suse15. SL-JID 16064

DaanHoogland · 2025-12-17T08:15:41Z

@blueorangutan package

blueorangutan · 2025-12-17T08:18:06Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-12-17T09:44:48Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 16071

DaanHoogland · 2025-12-17T12:30:12Z

@blueorangutan test

blueorangutan · 2025-12-17T12:32:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-12-17T13:39:35Z

[SF] Trillian Build Failed (tid-15014)

blueorangutan · 2025-12-18T05:57:34Z

[SF] Trillian test result (tid-15016)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 54993 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr8728-t15016-kvm-ol8.zip
Smoke tests completed. 149 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_03_deploy_and_scale_kubernetes_cluster	`Failure`	28.76	test_kubernetes_clusters.py

DaanHoogland · 2025-12-18T10:08:38Z

@GutoVeronezi , are you satisfied like this or do you want more testing? test_03_deploy_and_scale_kubernetes_cluster needs attention but seems unrelated.

GutoVeronezi · 2025-12-18T13:54:48Z

@GutoVeronezi , are you satisfied like this or do you want more testing? test_03_deploy_and_scale_kubernetes_cluster needs attention but seems unrelated.

It is fine for me.

@JoaoJandre, could you review it again as well?

api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java

JoaoJandre · 2025-12-18T14:26:29Z

Left a minor nit

…mportUnmanagedInstanceCmd.java Co-authored-by: João Jandre <48719461+JoaoJandre@users.noreply.github.com>

vishesh92

lgtm

klaus.freitas.scclouds added 5 commits February 16, 2024 16:41

Refactor cloud-api module logs for Log4j2

1d2d2e7

more log refactoring

1db5234

more log refactoring

3ea0aa3

log refactor

5154c69

minor tweaks in log refactor

a0f8ce9

boring-cyborg bot added component:api component:networking component:vpc labels Feb 29, 2024

JoaoJandre reviewed Feb 29, 2024

View reviewed changes

api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java Show resolved Hide resolved

vishesh92 reviewed Feb 29, 2024

View reviewed changes

api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java Outdated Show resolved Hide resolved

Update api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java

39f435f

Co-authored-by: Vishesh <vishesh92@gmail.com>

DaanHoogland approved these changes Mar 4, 2024

View reviewed changes

JoaoJandre approved these changes Mar 4, 2024

View reviewed changes

github-actions bot added the status:has-conflicts label Mar 8, 2024

Merge branch 'main' into log4j2-refactor-cloud-api-module

e76c58e

github-actions bot removed the status:has-conflicts label Mar 8, 2024

github-actions bot added the status:has-conflicts label Jun 13, 2024

Merge branch 'main' into log4j2-refactor-cloud-api-module

d8a5f2f

github-actions bot added status:has-conflicts and removed status:has-conflicts labels Jun 25, 2024

DaanHoogland removed the status:has-conflicts label Jul 1, 2024

GutoVeronezi self-assigned this Dec 13, 2025

GutoVeronezi marked this pull request as draft December 13, 2025 14:42

Adjusts logs

a8dc748

GutoVeronezi marked this pull request as ready for review December 15, 2025 03:00

GutoVeronezi requested review from DaanHoogland, JoaoJandre and vishesh92 December 15, 2025 03:00

DaanHoogland reviewed Dec 15, 2025

View reviewed changes

api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java Outdated Show resolved Hide resolved

Apply suggestions from code review

84be387

Co-authored-by: dahn <daan.hoogland@gmail.com>

GutoVeronezi reviewed Dec 15, 2025

View reviewed changes

Apply suggestions from code review

8ff694a

DaanHoogland approved these changes Dec 15, 2025

View reviewed changes

Change log level from debug to error on host update failure

46428f8

JoaoJandre approved these changes Dec 18, 2025

View reviewed changes

api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java Outdated Show resolved Hide resolved

Update api/src/main/java/org/apache/cloudstack/api/command/admin/vm/I…

7eebf2e

…mportUnmanagedInstanceCmd.java Co-authored-by: João Jandre <48719461+JoaoJandre@users.noreply.github.com>

vishesh92 approved these changes Dec 19, 2025

View reviewed changes

vishesh92 merged commit 13f805f into apache:main Dec 19, 2025
27 of 28 checks passed

Log4j2 refactor cloud api module #8728

Log4j2 refactor cloud api module #8728

Uh oh!

Conversation

KlausDornsbach commented Feb 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

How Has This Been Tested?

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

JoaoJandre left a comment

Choose a reason for hiding this comment

Uh oh!

JoaoJandre commented Mar 4, 2024

Uh oh!

DaanHoogland commented Mar 5, 2024

Uh oh!

github-actions bot commented Mar 8, 2024

Uh oh!

github-actions bot commented Jun 13, 2024

Uh oh!

github-actions bot commented Jun 25, 2024

Uh oh!

DaanHoogland commented Jul 1, 2024

Uh oh!

blueorangutan commented Jul 1, 2024

Uh oh!

blueorangutan commented Jul 1, 2024

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GutoVeronezi commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 17, 2025

Uh oh!

DaanHoogland commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 17, 2025

Uh oh!

DaanHoogland commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 17, 2025

Uh oh!

blueorangutan commented Dec 18, 2025

Uh oh!

DaanHoogland commented Dec 18, 2025

Uh oh!

GutoVeronezi commented Dec 18, 2025

Uh oh!

Uh oh!

JoaoJandre commented Dec 18, 2025

Uh oh!

vishesh92 left a comment

Choose a reason for hiding this comment

KlausDornsbach commented Feb 29, 2024 •

edited

Loading

codecov bot commented Feb 29, 2024 •

edited

Loading