GitHub user weizhouapache added a comment to the discussion: logging standards 
in CloudStack

@lucas-a-martins and me had some discussion on [#8603 
](https://github.com/apache/cloudstack/pull/8603#issuecomment-2092439013)

I think it is better to raise the discussion here.

Basically the question is, when an error happens, what error message should be 
displayed to the root admin and regular users or domain admin ?
- as root admin, I want to get information as much/clear/direct as possible. 
some errors like "internal communication error" are not acceptable.
- as user, I want to get clear information. moreover, some sensitive 
information should NOT be displayed to the end users, for example, the id of 
resource (resource uuid or name should be used), the internal name of VM 
instance, the exception on kvm hosts, etc.

Currently most error messages are for root admin, but some of them confuse 
regular users. Sometimes it is hard to find an error message which is good for 
both root admin and regular users. 

Back to #8603 , the current error message "Global setting endpoint.url has to 
be set to the Management Server's API end point" is not good for regular users, 
but the new error message "Unable to complete this operation. Contact your 
cloud admin." does not give any information to root admin which is also not 
good I think. sorry @lucas-a-martins 

Do we need a logging mechanism to display different error messages to root 
admin and regular users ? 

for example
- for `InvalidParameterValueException`, display the same error message to root 
admin and regular user
- for `CloudRuntimeException`, display the error message of the exception to 
root admin, but an error "Unable to complete this operation. Contact your cloud 
admin." to regular user


cc @DaanHoogland @rohityadavcloud  @GutoVeronezi @JoaoJandre 

GitHub link: 
https://github.com/apache/cloudstack/discussions/8746#discussioncomment-9359185

----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to: [email protected]

Reply via email to