mirrors/maddy
1
0
Fork 0
mirror of https://github.com/foxcpp/maddy.git synced 2025-04-04 21:47:40 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: Document error logging conventions in HACKING.md

Browse source 
>Shortly put, it is module responsibility to log errors it generated since it is
>assumed it can provide all useful details about possible causes.

Modules can be chained in arbitrary ways so it is not possible to know
whether module should log the error or not. Logging errors at every
stage will result in useless duplication of messages.

Additionally, error source can provide all useful information about the
error context. Functionality for attaching arbitrary context info to the
error objects is not implemented now and its arguable whether it will be
useful.
This commit is contained in:
fox.cpp 2019-09-28 13:08:02 +03:00
parent 23c76cc518
commit 2e3a11e3e5
No known key found for this signature in database
GPG key ID: E76D97CCEDE90B6C
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
HACKING.md
View file

@ -81,3 +81,20 @@ block. All arguments after the module name in an inline definition represent
"inline arguments". They are passed to the module instance directly and not
used anyhow by other code (i.e. they are not guaranteed to be unique).
### A word on error logging
Shortly put, it is module responsibility to log errors it generated since it is
assumed it can provide all useful details about possible causes.
Modules should not log errors received from other modules. However, it is
fine to log decisions made based on these errors.
This does not apply to "debug log", anything can be logged using it if it is
considered useful for troubleshooting.
Here is the example: remote module logs all errors received from remote server
and passes them to the caller. queue module only logs whether delivery to
certain recipient is permanently failed or it will be retried. When used
together, remote module will provide logs about concrete errors happened and
queue module will provide information about tries made and scheduled to be made
in future.