search

elastic / elasticsearch

Free and Open Source, Distributed, RESTful Search Engine
https://www.elastic.co/products/elasticsearch
Other
966 stars 24.82k forks source link

Improve actionability of error messages #88372

Open DaveCTurner opened 2 years ago

DaveCTurner commented 2 years ago

Our recent discussions about supportability identified that improving the actionability of error messages (e.g. in logs and responses to clients) would help a significant proportion of users help themselves without needing to escalate questions to the support or development teams. For instance, this might include directly linking from the message to some relevant documentation. We did not go into much depth on what that might mean in practice, but I'm opening this issue to record the need for further discussions in this area. Feel free to take this issue forwards as you see fit, for instance by filling it out into a full meta-issue or by closing it in favour of some other more specific action items.

I'm labelling this for the attention of the core/infra team because I think there is scope for making this easier by adding features to our logging and exception-handling frameworks, noting of course that improvements to the error messages themselves would be owned by other teams.

elasticmachine commented 2 years ago

Pinging @elastic/es-core-infra (Team:Core/Infra)

rjernst commented 2 months ago

We discussed this issue and agree it would be an improvement to supportability.

DaveCTurner commented 2 months ago

I'd forgotten I'd opened this issue. I wonder, is (at least the core/infra content of) this addressed by #92755, or are there other things you think could be done here too?

rjernst commented 2 months ago

IMO there is more to do. I don't like how that is a global class in server, nor how it is linked with the docs build for verification. I also think having a broader "here's an exception with a reference doc" would be good, and a more bespoke logging (eg so we have consistent formatting, instead of leaving it up to each dev).