Fix for usage server getting stuck due to duplicate VM events by abh1sar · Pull Request #13019 · apache/cloudstack · GitHub

Description

This PR fixes #12590

Fix is to remove the unique key constraint from the usage_vm_instance table.
The constraint is not required, and can cause issues with usage processing.
The other helper tables either don't have a constraint or duplicate events cannot happen as the event is generated only at create.
In case of VM instance the event is generated at every Start which makes it susceptible to duplicate events.

Added change in the upgrade path as well as in create-schema-premium.sql

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
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

BLOCKER
Critical
Major
Minor
Trivial

Screenshots (if appropriate):

How Has This Been Tested?

To test, I added 2 VM.START events to the usage_event table with the same created time (id 18 and 20) and set the usage.stats.job.aggregation.range to 5 (minutes)

Without the fix the usage server was stuck processing that interval

After removing the unique constraint, usage server finished successfully and generated the correct usage.

How did you try to break this feature and the system with this change?

Codecov Report

❌ Patch coverage is 21.73913% with 18 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.27%. Comparing base (8eb162c) to head (e5f59a3).
⚠️ Report is 11 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...ava/com/cloud/upgrade/dao/Upgrade42030to42040.java	18.18%	18 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.20   #13019   +/-   ##
=========================================
  Coverage     16.26%   16.27%           
- Complexity    13433    13439    +6     
=========================================
  Files          5665     5666    +1     
  Lines        500530   500557   +27     
  Branches      60787    60789    +2     
=========================================
+ Hits          81411    81444   +33     
+ Misses       410027   410009   -18     
- Partials       9092     9104   +12

Flag	Coverage Δ
uitests	4.15% <ø> (ø)
unittests	17.12% <21.73%> (+<0.01%)	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

@blueorangutan package

@sureshanaparti 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.

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

@abh1sar I do not think this change is the best way to go. First an upgrade patch for minor version should be implicit, expecially if no actual changes are in the specific upgrade script. Second, the create schema script should be for 4.0 and all other changes should be entered in the upgrade scripts.

@abh1sar I do not think this change is the best way to go. First an upgrade patch for minor version should be implicit, expecially if no actual changes are in the specific upgrade script. Second, the create schema script should be for 4.0 and all other changes should be entered in the upgrade scripts.

cc @weizhouapache

@blueorangutan package

@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.

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

we will have to make sure this happens for 22.1 and 23.0 as well.

@blueorangutan test

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

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

Test	Result	Time (s)	Test File
ContextSuite context=TestClusterDRS>:setup	Error	0.00	test_cluster_drs.py

Code looks good, needs upgrade testing

Tested the upgrade. It looks ok.

2026-06-11 15:13:56,404 DEBUG [c.c.u.d.Upgrade42030to42040] (main:[]) (logid:) Dropping index vm_instance_id from usage_vm_instance table if it exists
2026-06-11 15:13:56,501 DEBUG [c.c.u.d.DatabaseAccessObject] (main:[]) (logid:) Key vm_instance_id is dropped successfully from the table cloud_usage.usage_vm_instance

This one needs to be included in the 4.22.2 and 4.23.0 upgrade paths as well. I intend to include it while performing the merge forward.

…23.0 path (#13617)

…#13019) (cherry picked from commit 7bc458f)

… -> 4.23.0 path (apache#13617) (cherry picked from commit 75748a5)

remove unique key constraint from cloud_usage.usage_vm_instance table

9480668

abh1sar added this to the 4.20.4 milestone Apr 14, 2026

abh1sar changed the title remove unique key constraint from cloud_usage.usage_vm_instance table Fix for usage server getting stuck due to duplicate VM events Apr 14, 2026

abh1sar requested a review from DaanHoogland April 14, 2026 09:47

fix precommit

37ffb5a

DaanHoogland requested changes Apr 15, 2026

View reviewed changes

revert changes to create-schema-premium.sql

e5f59a3

DaanHoogland approved these changes Apr 16, 2026

View reviewed changes

DaanHoogland added the status:ready-for-testing label Apr 16, 2026

DaanHoogland self-assigned this Apr 30, 2026

DaanHoogland added status:needs-review status:needs-testing labels May 6, 2026

winterhazel self-requested a review May 12, 2026 13:24

winterhazel requested changes May 13, 2026

View reviewed changes

Comment thread engine/schema/src/main/java/com/cloud/upgrade/dao/Upgrade42030to42040.java Resolved

winterhazel approved these changes May 14, 2026

View reviewed changes

winterhazel removed the status:needs-review label May 14, 2026

winterhazel removed status:needs-testing status:ready-for-testing labels Jun 11, 2026

winterhazel added the component:usage-server label Jun 11, 2026

winterhazel merged commit 7bc458f into apache:4.20 Jun 11, 2026
25 of 26 checks passed

github-actions Bot mentioned this pull request Jun 11, 2026

[repo-status] Daily Status Report — June 11, 2026 #13405

Closed

This was referenced Jun 12, 2026

[repo-status] Daily Status Report — June 12, 2026 #13413

Closed

[repo-status] Daily Status Report — June 13, 2026 #13416

Closed

DaanHoogland deleted the usage-duplicate-vm branch June 14, 2026 17:12

This was referenced Jun 14, 2026

[repo-status] Daily Status Report — June 14, 2026 #13418

Closed

[repo-status] Daily Status Report — June 15, 2026 #13425

Closed

[repo-status] Daily Status Report — June 16, 2026 #13435

Closed

abh1sar linked an issue Jul 6, 2026 that may be closed by this pull request

Duplicate event for VM.START in the usage_event causes it to never get processed #12590

Closed

abh1sar mentioned this pull request Jul 6, 2026

Duplicate event for VM.START in the usage_event causes it to never get processed #12590

Closed

winterhazel mentioned this pull request Jul 14, 2026

Include the database changes from #13019 in the 4.22.1 -> 4.23.0 upgrade path #13617

Merged

1 of 12 tasks

weizhouapache pushed a commit that referenced this pull request Jul 14, 2026

upgrade: Include the database changes from #13019 in the 4.22.1 -> 4.…

75748a5

…23.0 path (#13617)

DaanHoogland mentioned this pull request Sep 1, 2026

Fix duplicate RUNNING_VM helper record creation on repeated VM.START events #12606

Closed

3 tasks done

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Sep 10, 2026

Fix for usage server getting stuck due to duplicate VM events (apache…

760271a

…#13019) (cherry picked from commit 7bc458f)

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Sep 10, 2026

upgrade: Include the database changes from apache#13019 in the 4.22.1…

759dfb2

… -> 4.23.0 path (apache#13617) (cherry picked from commit 75748a5)

Fix for usage server getting stuck due to duplicate VM events by abh1sar · Pull Request #13019 · apache/cloudstack · GitHub

Repository navigation

Fix for usage server getting stuck due to duplicate VM events - #13019

Fix for usage server getting stuck due to duplicate VM events#13019winterhazel merged 3 commits intoapache:4.20apache/cloudstack:4.20from shapeblue:usage-duplicate-vmshapeblue/cloudstack:usage-duplicate-vmCopy head branch name to clipboard

Conversation

abh1sar commented Apr 14, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov Bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sureshanaparti commented Apr 14, 2026

Uh oh!

blueorangutan commented Apr 14, 2026

Uh oh!

blueorangutan commented Apr 14, 2026

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Apr 15, 2026

Uh oh!

DaanHoogland commented Apr 15, 2026

Uh oh!

blueorangutan commented Apr 15, 2026

Uh oh!

blueorangutan commented Apr 15, 2026

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Apr 16, 2026

Uh oh!

blueorangutan commented Apr 16, 2026

Uh oh!

blueorangutan commented Apr 16, 2026

Uh oh!

Uh oh!

winterhazel left a comment

Choose a reason for hiding this comment

Uh oh!

winterhazel commented Jun 11, 2026

Uh oh!

Uh oh!

winterhazel commented Jun 12, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Fix for usage server getting stuck due to duplicate VM events#13019
winterhazel merged 3 commits into
apache:4.20from
shapeblue:usage-duplicate-vm

codecov Bot commented Apr 14, 2026 •
edited
Loading