Page History

...

Currently the events logged in CloudStack doesn't give detailed information about the event that has occurred. The information provided in each event shown on the cloudstack ui doesn't provide specifics, particularly in case of errors. For example, the message shown on the cloudstack ui is just "Error while starting Vm. Vm Id: <id>" in case of failure to start a vm , which doesn't help much. Hence, the events should be enhanced to include more information to be descriptive enough.

...

Proposal

I would like to propose some changes to enhance the events to be more informative. Like:

1. Instead of just showing resource database id in the event details it should display resource UUID. Since all the cloudstack apis take input as resource uuid it would be helpful to see the same on the ui as well.
2. Enhance the events and listEvents API to include the resource UUID so that it can be queried by the resource UUID as well.
3. Currently, the event description messages are specified in the *Cmd.java file instead, all of them should be externalize to a resource file. This would be helpful even for internationalization.
4. Provide more detailed messages in case of error events. Messages such as "Error while starting VM" are generic to take any action.
   

Design description

Introduce resource UUID in event description

All cloudstack async apis specifies event description which specifies the database id of the resource. In order to change the database id to resource UUID there would not be any design level changes. Currently, the resource uuid passed as required parameter are translated into internal id.

Details

Introduce resource UUID

Currently, all async commands required parameter resource database ids are displayed in the event descriptions. Change the resource ids with the resource UUIDs. As per current implementation event description is described in the following commands

...