alert messages restructure

[DaanHoogland]

Description

This PR...

Fixes: #7297

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?

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

[Copilot]

Pull request overview

Note

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Restructures several alert/log messages to be more consistent and information-rich, and introduces a shared formatter for host location descriptions (fixing CLOUDSTACK-7297).

Changes:

• Added AlertFormatUtils.describeHostLocation(...) and reused it in HA/agent/orchestration alert call sites.
• Updated many alerts/logs to include object context (e.g., host, domain, account) rather than only IDs/UUIDs.
• Tweaked multiple failure/permission messages to improve operator readability.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
server/src/main/java/org/apache/cloudstack/outofbandmanagement/OutOfBandManagementServiceImpl.java	Updates host degraded/removed debug message formatting.
server/src/main/java/org/apache/cloudstack/ha/provider/host/HAAbstractHostProvider.java	Simplifies HA fencing/recovery alert subject/body to include host object.
server/src/main/java/org/apache/cloudstack/ca/CAManagerImpl.java	Improves SSH provisioning error context by logging the host object.
server/src/main/java/com/cloud/vm/UserVmManagerImpl.java	Reworks several VM/host dedication alert messages; adds account/domain lookups for richer output.
server/src/main/java/com/cloud/storage/snapshot/SnapshotManagerImpl.java	Updates snapshot limit alert to reference account object.
server/src/main/java/com/cloud/resourcelimit/ResourceLimitManagerImpl.java	Updates permission-denied exception messages to include domain object.
server/src/main/java/com/cloud/ha/KVMFencer.java	Updates fencing failure alerts to include host object.
server/src/main/java/com/cloud/ha/HighAvailabilityManagerImpl.java	Uses AlertFormatUtils for host location in HA alerts; improves VM-stopped alert host description.
server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java	Makes several validation exceptions include full entity objects (domain/network offering).
server/src/main/java/com/cloud/alert/AlertManagerImpl.java	Changes alert logging to structured logging with entity objects.
plugins/storage/volume/scaleio/src/main/java/org/apache/cloudstack/storage/datastore/provider/ScaleIOHostListener.java	Updates ScaleIO host/pool alerts/logs to include host object.
plugins/storage/volume/scaleio/src/main/java/org/apache/cloudstack/storage/datastore/driver/ScaleIOPrimaryDataStoreDriver.java	Updates ScaleIO disconnection checks/alerts to include host/pool objects.
plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/listener/OntapHostListener.java	Improves Ontap attach-storage error messages by using host object.
plugins/storage/volume/datera/src/main/java/org/apache/cloudstack/storage/datastore/provider/DateraHostListener.java	Improves Datera attach-storage alert message by using fetched host object.
engine/storage/volume/src/main/java/org/apache/cloudstack/storage/datastore/provider/DefaultHostListener.java	Improves default host connect failure message by including host object.
engine/storage/src/main/java/org/apache/cloudstack/storage/image/BaseImageStoreDriverImpl.java	Updates upload/register/copy failure alerts to include object string.
engine/storage/snapshot/src/main/java/org/apache/cloudstack/storage/vmsnapshot/ScaleIOVMSnapshotStrategy.java	Clarifies VM snapshot failure message to include snapshot object context.
engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java	Uses AlertFormatUtils to include host location in agent network-setup failure alert.
engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java	Uses AlertFormatUtils for consistent host location strings in disconnect/alert-state messages.
engine/components-api/src/main/java/com/cloud/alert/AlertFormatUtils.java	New shared helper for consistent host/zone/pod alert formatting.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

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

Suppressed comments (7)

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java:2869

• The conditional uses hostId != null but prints host (object). If hostId is set but the host lookup failed, this will produce on host [null] and loses the only reliable identifier (the host id). Consider using host != null for the host-object rendering, and fall back to hostId when host is null so the alert remains actionable.

                String subject = String.format("Failed to deploy Instance [%s]", vm);
                String body = String.format("Failed to deploy [%s]%s. To troubleshoot, please check the logs with [logid:%s].",
                        vm,
                        hostId != null ? String.format(" on host [%s]", host) : "",
                        ThreadContext.get("logcontextid"));

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java:7769

• These alerts now depend on Account.toString() / Domain.toString() for human-readable names, and will render null if the DAO lookup returns null—where previously the IDs were always present. To keep alerts stable and actionable, consider formatting explicitly (e.g., account name + id, domain name + id) with a fallback to the raw IDs when the DAO lookup fails, instead of relying on toString().

            Long srcAccountId = accountOfDedicatedHost(srcHost);
            Long destAccountId = accountOfDedicatedHost(destHost);
            if (!((srcAccountId == null) || (srcAccountId.equals(destAccountId)))) {
                Account srcAccount = _accountDao.findById(srcAccountId);
                Account destAccount = _accountDao.findById(destAccountId);
                String msg = String.format("VM is being migrated from host %s explicitly dedicated to account %s to host %s explicitly dedicated to account %s",
                        srcHost, srcAccount, destHost, destAccount);

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java:7779

• These alerts now depend on Account.toString() / Domain.toString() for human-readable names, and will render null if the DAO lookup returns null—where previously the IDs were always present. To keep alerts stable and actionable, consider formatting explicitly (e.g., account name + id, domain name + id) with a fallback to the raw IDs when the DAO lookup fails, instead of relying on toString().

            Long srcDomainId = domainOfDedicatedHost(srcHost);
            Long destDomainId = domainOfDedicatedHost(destHost);
            if (!((srcDomainId == null) || (srcDomainId.equals(destDomainId)))) {
                Domain srcDomain = _domainDao.findById(srcDomainId);
                Domain destDomain = _domainDao.findById(destDomainId);
                String msg = String.format("VM is being migrated from host %s explicitly dedicated to domain %s to host %s explicitly dedicated to domain %s",
                        srcHost, srcDomain, destHost, destDomain);

server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java:4597

• This test hard-codes expectations around toString() output for AccountVO and DomainVO, which is typically not a stable API and can change without functional impact. If the production intent is to include account/domain names, it would be more robust to have production code format using explicit getters (e.g., account name / domain name) and have the test stub those getters and assert on them.

        AccountVO srcAccount = Mockito.mock(AccountVO.class);
        when(srcAccount.toString()).thenReturn("Account {accountName=account-a}");
        AccountVO destAccount = Mockito.mock(AccountVO.class);
        when(destAccount.toString()).thenReturn("Account {accountName=account-b}");

server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java:4604

• This test hard-codes expectations around toString() output for AccountVO and DomainVO, which is typically not a stable API and can change without functional impact. If the production intent is to include account/domain names, it would be more robust to have production code format using explicit getters (e.g., account name / domain name) and have the test stub those getters and assert on them.

        DomainVO srcDomain = Mockito.mock(DomainVO.class);
        when(srcDomain.toString()).thenReturn("Domain {name=domain-a}");
        DomainVO destDomain = Mockito.mock(DomainVO.class);
        when(destDomain.toString()).thenReturn("Domain {name=domain-b}");

plugins/storage/volume/datera/src/main/java/org/apache/cloudstack/storage/datastore/provider/DateraHostListener.java:301

• If _hostDao.findById(hostId) returns null, the message will become ... to host null, which is less actionable than the previous host id-based message. Consider falling back to hostId when host is null (or rendering both: host + id) to preserve diagnostic value.

            HostVO host = _hostDao.findById(hostId);
            String msg = String.format("Unable to attach storage pool %s to host %s", storagePool, host);

engine/components-api/src/main/java/com/cloud/alert/AlertFormatUtils.java:26

• The PR description is still the default template (type-of-change checkboxes and testing details are not filled in). Since repository automation relies on the description for labeling/documentation, please update the PR description to clearly state the functional behavior change and how it was tested.

 * Shared formatting for the host/zone/pod description that recurs, independently
 * hand-rolled and inconsistently worded (and occasionally mislabelled), across the
 * HA and agent-management alert call sites. See CLOUDSTACK-7297.

[github-actions]

🔴 Test Coverage Grade: D — Marginal

Metric	Value
Line coverage	24.74%
Branch coverage	18.88%

Grade Scale

Grade	Line Coverage	Meaning
🟢 A	≥ 80%	Excellent - this code sleeps well at night 😴
🟡 B	60-79%	Good - almost there, don't stop now 😉
🟠 C	40-59%	Acceptable - your code is wearing a seatbelt, but no airbags 😬
🔴 D	20-39%	Marginal - boldly shipping where no test has gone before 🖖
⛔ F	< 20%	Failing - tests? what tests? 🔥

Branch coverage is shown as a secondary signal. Grade is determined by line coverage.
View full Actions run

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[sonarqubecloud]

Quality Gate passed

Issues
32 New issues
0 Accepted issues

Measures
0 Security Hotspots
59.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud