Update gson date format for serializing/deserializing Date in MS stats by sureshanaparti · Pull Request #11506 · apache/cloudstack

sureshanaparti · 2025-08-25T11:48:31Z

Description

This PR updates gson date format for serializing/deserializing Date in MS stats (across multiple management servers).

The DateFormat is set to default system locale if not set, and serialization/deserialization fails when management server nodes have different locale/timezones.

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

Screenshots (if appropriate):

How Has This Been Tested?

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

sureshanaparti · 2025-08-25T11:49:13Z

@blueorangutan package

blueorangutan · 2025-08-25T11:50:03Z

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

codecov · 2025-08-25T11:55:54Z

Codecov Report

❌ Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.17%. Comparing base (38006b2) to head (b1b0087).
⚠️ Report is 13 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...src/main/java/com/cloud/server/StatsCollector.java	50.00%	3 Missing ⚠️
...m/cloud/server/ManagementServerHostStatsEntry.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.20   #11506   +/-   ##
=========================================
  Coverage     16.17%   16.17%           
- Complexity    13297    13298    +1     
=========================================
  Files          5656     5656           
  Lines        498136   498154   +18     
  Branches      60432    60441    +9     
=========================================
+ Hits          80583    80590    +7     
- Misses       408585   408589    +4     
- Partials       8968     8975    +7

Flag	Coverage Δ
uitests	`4.00% <ø> (+<0.01%)`	⬆️
unittests	`17.03% <42.85%> (+<0.01%)`	⬆️

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.

blueorangutan · 2025-08-25T13:02:14Z

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

sureshanaparti · 2025-08-25T14:55:52Z

@blueorangutan test

blueorangutan · 2025-08-25T14:58:05Z

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

blueorangutan · 2025-08-25T15:39:19Z

[SF] Trillian Build Failed (tid-14113)

sureshanaparti · 2025-08-26T04:08:09Z

@blueorangutan test

blueorangutan · 2025-08-26T04:10:03Z

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

Copilot

Pull Request Overview

This PR standardizes the date format for Gson serialization/deserialization across CloudStack's management server statistics functionality. The change ensures consistent date formatting when exchanging statistics data between multiple management servers.

Updates the StatsCollector's Gson instance to use a specific date format pattern
Applies the same date format to the global Gson configuration in GsonHelper
Simplifies JSON deserialization by removing unnecessary TypeToken usage

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File	Description
server/src/main/java/com/cloud/server/StatsCollector.java	Updates Gson initialization with date format, simplifies deserialization, and removes unused import
core/src/main/java/com/cloud/serializer/GsonHelper.java	Adds consistent date format to the default Gson configuration

Comments suppressed due to low confidence (1)

server/src/main/java/com/cloud/server/StatsCollector.java:163

[nitpick] The variable initialization change from 'null' to uninitialized is unnecessary since the variable is immediately assigned in the try block. The original initialization provided better clarity about the intended flow.

import com.cloud.vm.dao.VmStatsDao;

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

server/src/main/java/com/cloud/server/StatsCollector.java

sureshanaparti · 2025-08-26T04:33:02Z

@blueorangutan package

blueorangutan · 2025-08-26T04:34:04Z

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

blueorangutan · 2025-08-26T06:09:18Z

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

DaanHoogland · 2025-08-26T09:08:36Z

code looks good @sureshanaparti , but can you update with a test procedure? (or automated test)

core/src/main/java/com/cloud/serializer/GsonHelper.java

…s (across multiple management servers)

sureshanaparti · 2025-09-11T10:43:36Z

@blueorangutan package

blueorangutan · 2025-09-11T10:44:03Z

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

blueorangutan · 2025-09-11T13:34:53Z

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

weizhouapache

@sureshanaparti
codewise it looks good to me

the GsonHelper class is being used in many classes, need to be careful

weizhouapache · 2025-09-15T08:12:22Z

@weizhouapache the issue rarely occurs, mostly it is noticed when management server nodes with different locale/timezones. You'll see exception like below. The DateFormat is set to default system locale if not set, and serialization/deserialization fails when nodes have different locale/timezones

thanks @sureshanaparti
It seems to be a rare issue indeed.

since the date format is used in many scenarios (mgmt to mgmt, mgmt to agent, acs to 3rd parties, etc), it is difficult to test if it works or breaks some functionalities, I would prefer to leave it for next release.

cc @harikrishna-patnala @sureshanaparti @DaanHoogland

sureshanaparti · 2025-09-15T13:46:01Z

@weizhouapache the issue rarely occurs, mostly it is noticed when management server nodes with different locale/timezones. You'll see exception like below. The DateFormat is set to default system locale if not set, and serialization/deserialization fails when nodes have different locale/timezones

thanks @sureshanaparti It seems to be a rare issue indeed.

since the date format is used in many scenarios (mgmt to mgmt, mgmt to agent, acs to 3rd parties, etc), it is difficult to test if it works or breaks some functionalities, I would prefer to leave it for next release.

cc @harikrishna-patnala @sureshanaparti @DaanHoogland

upto @weizhouapache there'll be issues during deserialization when date format doesn't match.

sureshanaparti · 2025-09-15T13:57:01Z

@blueorangutan package

blueorangutan · 2025-09-15T13:58:04Z

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

blueorangutan · 2025-09-15T17:19:01Z

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

sureshanaparti · 2025-09-16T04:31:34Z

@blueorangutan package

blueorangutan · 2025-09-16T04:32:04Z

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

blueorangutan · 2025-09-16T05:56:31Z

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

sureshanaparti · 2025-09-18T12:04:33Z

@blueorangutan package

weizhouapache

code lgtm

weizhouapache · 2025-09-18T18:17:56Z

@blueorangutan package

blueorangutan · 2025-09-18T18:20:06Z

@weizhouapache 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-09-18T20:31:47Z

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

weizhouapache · 2025-09-19T05:36:10Z

@blueorangutan package

blueorangutan · 2025-09-19T05:38:04Z

@weizhouapache 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-09-19T07:35:09Z

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

sureshanaparti · 2025-09-19T08:38:21Z

@blueorangutan test

blueorangutan · 2025-09-19T08:40:04Z

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

weizhouapache · 2025-09-19T13:09:40Z

@sureshanaparti
you can assign to me if you need testing

blueorangutan · 2025-09-20T00:27:02Z

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

Test	Result	Time (s)	Test File

weizhouapache · 2025-09-22T10:22:28Z

tested ok

the logs show date like

"collectionTime": "2025-09-22T10:18:58+0000",
"systemBootTime": "2025-09-08T11:45:34+0000",

mshost_peer is updated without issue
cmk list managementserversmetrics shows the date (collection time, last boot/start/stop) without issue

… MS stats (apache#11506) * Update gson date format for serializing/deserializing Date in MS stats (across multiple management servers) * review * review comments, and unit tests * added unit test with different date format * Use separate Gson for MS stats serialization/deserialization

boring-cyborg bot added the component:management-server label Aug 25, 2025

sureshanaparti requested review from DaanHoogland and Copilot August 26, 2025 04:20

Copilot AI reviewed Aug 26, 2025

View reviewed changes

server/src/main/java/com/cloud/server/StatsCollector.java Outdated Show resolved Hide resolved

apache deleted a comment from blueorangutan Aug 26, 2025

harikrishna-patnala reviewed Aug 28, 2025

View reviewed changes

core/src/main/java/com/cloud/serializer/GsonHelper.java Outdated Show resolved Hide resolved

sureshanaparti added 3 commits September 11, 2025 16:12

Update gson date format for serializing/deserializing Date in MS stat…

90e1ac8

…s (across multiple management servers)

review

17e03c9

review comments, and unit tests

8a451a4

sureshanaparti force-pushed the mgmt-server-status-date-format-update branch from 34bab74 to 8a451a4 Compare September 11, 2025 10:43

sureshanaparti marked this pull request as ready for review September 11, 2025 10:43

sureshanaparti requested review from harikrishna-patnala and weizhouapache September 11, 2025 10:43

weizhouapache reviewed Sep 12, 2025

View reviewed changes

added unit test with different date format

36ae0d4

sureshanaparti mentioned this pull request Sep 18, 2025

use /prod/stat to get uptime instead of the uptime command #11670

Merged

14 tasks

Use separate Gson for MS stats serialization/deserialization

b1b0087

weizhouapache added this to the 4.20.2 milestone Sep 18, 2025

sureshanaparti requested a review from weizhouapache September 18, 2025 12:04

weizhouapache approved these changes Sep 18, 2025

View reviewed changes

DaanHoogland assigned weizhouapache Sep 20, 2025

weizhouapache merged commit 12513e1 into apache:4.20 Sep 22, 2025
25 of 26 checks passed

DaanHoogland deleted the mgmt-server-status-date-format-update branch September 24, 2025 07:06

Conversation

sureshanaparti commented Aug 25, 2025 • 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

Screenshots (if appropriate):

How Has This Been Tested?

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

Uh oh!

sureshanaparti commented Aug 25, 2025

Uh oh!

blueorangutan commented Aug 25, 2025

Uh oh!

codecov bot commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Aug 25, 2025

Uh oh!

sureshanaparti commented Aug 25, 2025

Uh oh!

blueorangutan commented Aug 25, 2025

Uh oh!

blueorangutan commented Aug 25, 2025

Uh oh!

sureshanaparti commented Aug 26, 2025

Uh oh!

blueorangutan commented Aug 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

sureshanaparti commented Aug 26, 2025

Uh oh!

blueorangutan commented Aug 26, 2025

Uh oh!

blueorangutan commented Aug 26, 2025

Uh oh!

DaanHoogland commented Aug 26, 2025

Uh oh!

Uh oh!

sureshanaparti commented Sep 11, 2025

Uh oh!

blueorangutan commented Sep 11, 2025

Uh oh!

blueorangutan commented Sep 11, 2025

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Sep 15, 2025

Uh oh!

sureshanaparti commented Sep 15, 2025

Uh oh!

sureshanaparti commented Sep 15, 2025

Uh oh!

blueorangutan commented Sep 15, 2025

Uh oh!

blueorangutan commented Sep 15, 2025

Uh oh!

sureshanaparti commented Sep 16, 2025

Uh oh!

blueorangutan commented Sep 16, 2025

Uh oh!

blueorangutan commented Sep 16, 2025

Uh oh!

sureshanaparti commented Sep 18, 2025

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 18, 2025

sureshanaparti commented Aug 25, 2025 •

edited

Loading

codecov bot commented Aug 25, 2025 •

edited

Loading