forked from Kopano-dev/konnect
/
errors.go
57 lines (49 loc) · 1.53 KB
/
errors.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
* Copyright 2017-2019 Kopano and its licensors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package utils
import (
"fmt"
)
// ErrorWithDescription is an interface binding the standard error
// inteface with a description.
type ErrorWithDescription interface {
error
Description() string
}
// DescribeError returns a wrapped version for errors which contain additional
// fields. The wrapped version contains all fields as a string value. Use this
// for general purpose logging of rich errors.
func DescribeError(err error) error {
switch err.(type) {
case ErrorWithDescription:
err = fmt.Errorf("%s - %s", err, err.(ErrorWithDescription).Description())
}
return err
}
// ErrorAsFields returns a mapping of all fields of the provided error.
func ErrorAsFields(err error) map[string]interface{} {
if err == nil {
return nil
}
fields := make(map[string]interface{})
fields["error"] = err.Error()
switch err.(type) {
case ErrorWithDescription:
fields["desc"] = err.(ErrorWithDescription).Description()
}
return fields
}