apache / apache/cloudstack

Error messages and Alerts should include contextual and actionable information

Open
#7,297 3 comments 0 reactions 0 assignees View on GitHub
long-term-plan
Dominant language
Java
Stars
3.1k
Forks
1.4k
Avg merge
6d 19h
Merged PRs (30d)
32

Description

##### ISSUE TYPE

* Improvement Request

##### COMPONENT NAME

~~~
UI and Alert messages
~~~

##### CLOUDSTACK VERSION

~~~
14.7.2
~~~

##### CONFIGURATION

##### OS / ENVIRONMENT

NA

##### SUMMARY

Alert messages should include more contextual and actionable information instead of various IDs to address the issue quickly.

##### STEPS TO REPRODUCE

~~~
During error conditions and alerts
~~~

##### EXPECTED RESULTS

~~~
Error messages should include account, domain, template, storage, VM names, and any other easily referenced information.

"Template 06cfc10e-a07d-4cee-8929-ca98946c60ab Windows 2022 Data Center failed to upload. Error details: Maximum number of resources of type secondary_storage for account _accountname_ has exceeded"
~~~

##### ACTUAL RESULTS

~~~
"Template 06cfc10e-a07d-4cee-8929-ca98946c60ab failed to upload. Error details: Maximum number of resources of type secondary_storage for account/project has exceeded"
~~~

Contributor guide

Open the contributing guide

Research direction

Start with the CloudStack UI and Alert messages produced during error conditions, using the template-upload example in the issue as the reference case. Review where the current ID-only messages are generated and map the contextual names and actionable details that should be included; done means the affected alerts consistently provide those details.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.