mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-05 22:17:39 +03:00
cf9e81d8a1
Previous error reporting code was inconsistent in terms of what is
logged, when and by whom. This caused several problems such as: logs
missing important error context, duplicated error messages, too verbose
messages, etc.
Instead of logging all generated errors, module should log
only errors it 'handles' somehow and does not simply pass it to the
caller. This removes duplication, however, also it removes context
information. To fix this, exterrors package was extended to provide
utilities for error wrapping. These utilities provide ability to
'attach' arbitrary key-value ('fields') pairs to any error object while
preserving the original value (using to Go 1.13 error handling
primitives).
In additional to solving problems described above this commit makes logs
machine-readable, creating the possibility for automated analysis.
Three new functions were added to the Logger object, providing
loosely-typed structured logging. However, they do not completely
replace plain logging and are used only where they are useful (to allow
automated analysis of message processing logs).
So, basically, instead of being logged god knows where and when,
all context information is attached to the error object and then it is
passed up until it is handled somewhere, at this point it is logged
together with all context information and then discarded.
66 lines
1.4 KiB
Go
66 lines
1.4 KiB
Go
package exterrors
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/emersion/go-smtp"
|
|
)
|
|
|
|
type EnhancedCode smtp.EnhancedCode
|
|
|
|
func (ec EnhancedCode) FormatLog() string {
|
|
return fmt.Sprintf("%d.%d.%d", ec[0], ec[1], ec[2])
|
|
}
|
|
|
|
// SMTPError type is a copy of emersion/go-smtp.SMTPError type
|
|
// that extends it with Fields method for logging and reporting
|
|
// in maddy. It should be used instead of library type for all
|
|
// errors.
|
|
type SMTPError struct {
|
|
Code int
|
|
EnhancedCode EnhancedCode
|
|
Message string
|
|
|
|
// If the error was generated by a message check
|
|
// this field includes module name.
|
|
CheckName string
|
|
|
|
// If the error was generated by a delivery target
|
|
// this field includes module name.
|
|
TargetName string
|
|
|
|
// If the error was generated as a result of another
|
|
// error - this field contains the original error object.
|
|
Err error
|
|
|
|
Misc map[string]interface{}
|
|
}
|
|
|
|
func (se *SMTPError) Unwrap() error {
|
|
return se.Err
|
|
}
|
|
|
|
func (se *SMTPError) Fields() map[string]interface{} {
|
|
ctx := make(map[string]interface{}, len(se.Misc)+3)
|
|
for k, v := range se.Misc {
|
|
ctx[k] = v
|
|
}
|
|
ctx["smtp_code"] = se.Code
|
|
ctx["smtp_enchcode"] = se.EnhancedCode
|
|
ctx["smtp_msg"] = se.Message
|
|
if se.CheckName != "" {
|
|
ctx["check"] = se.CheckName
|
|
}
|
|
if se.TargetName != "" {
|
|
ctx["target"] = se.TargetName
|
|
}
|
|
return ctx
|
|
}
|
|
|
|
func (se *SMTPError) Temporary() bool {
|
|
return se.Code/100 == 4
|
|
}
|
|
|
|
func (se *SMTPError) Error() string {
|
|
return se.Message
|
|
}
|