What's in a Good Error Message? : vimarsana.com

What's in a Good Error Message?


Update Jan 13: This post is discussed on Reddit


As software developers, we’ve all come across those annoying, not-so-useful error messages when using some library or framework: "Couldn’t parse config file", "Lacking permission for this operation", etc.
Ok, ok, so something went wrong apparently; but what exactly? What config file? Which permissions? And what should you do about it?
Error messages lacking this kind of information quickly create a feeling of frustration and helplessness.


So what makes a good error message then?
To me, it boils down to three pieces of information which should be conveyed by an error message:




Context: What led to the error? What was the code trying to do when it failed?


The error itself: What exactly failed?


Mitigation: What needs to be done in order to overcome the error?




Related Keywords

, Mapped Diagnostic Context , Kafka Connect ,

© 2025 Vimarsana