Action error messages are difficult for humans and machines to read
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Mistral |
Confirmed
|
Medium
|
Unassigned |
Bug Description
Hi,
We use Mistral in our cases that ought to use some sophisticated action, the format is somehow below:
"Failed to run action [action_
action_
attributes=
params=
} JavaScriptAction failed: There's not enough zones available for this operation! Check instantiation parameters!"
The actual root cause of this failed action is: JavaScriptAction failed: There's not enough zones available for this operation! Check instantiation parameters!". It locates at the end of the error. Suppose that if we have an action with a sophisticated, long params, the root cause is hard to find out.
However, due to the purpose of human-readable content, it is hard for operators those who want to know the actual root cause.
Changed in mistral: | |
milestone: | rocky-2 → rocky-rc1 |
milestone: | rocky-rc1 → rocky-3 |
Changed in mistral: | |
milestone: | rocky-3 → stein-1 |
Changed in mistral: | |
milestone: | stein-1 → none |
I actually think the problem here is bigger. The error message from actions needs to be easier for humans and machines to read. The information there is good, and sometimes even useful - but we should make it easier to work with.
One option would be to return JSON (we do this in other cases already). I think we should consider a JSON object with this information - then consumers could easily extract out just the error message or just the input if that is what they need.