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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
// Copyright 2021 Northern.tech AS
//
// 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 accesslog
import (
"fmt"
"net/http"
"runtime"
"strings"
"time"
"github.com/gin-gonic/gin"
"github.com/mendersoftware/go-lib-micro/log"
"github.com/mendersoftware/go-lib-micro/rest.utils"
"github.com/pkg/errors"
)
const MaxTraceback = 32
func funcname(fn string) string {
// strip package path
i := strings.LastIndex(fn, "/")
fn = fn[i+1:]
// strip package name.
i = strings.Index(fn, ".")
fn = fn[i+1:]
return fn
}
func panicHandler(c *gin.Context, startTime time.Time) {
if r := recover(); r != nil {
l := log.FromContext(c.Request.Context())
latency := time.Since(startTime)
trace := [MaxTraceback]uintptr{}
// Skip 3
// = runtime.Callers + runtime.extern.Callers + runtime.gopanic
num := runtime.Callers(3, trace[:])
var traceback strings.Builder
for i := 0; i < num; i++ {
fn := runtime.FuncForPC(trace[i])
if fn == nil {
fmt.Fprintf(&traceback, "\n???")
continue
}
file, line := fn.FileLine(trace[i])
fmt.Fprintf(&traceback, "\n%s(%s):%d",
file, funcname(fn.Name()), line,
)
}
logCtx := log.Ctx{
"clientip": c.ClientIP(),
"method": c.Request.Method,
"path": c.Request.URL.Path,
"qs": c.Request.URL.RawQuery,
"responsetime": fmt.Sprintf("%dus",
latency.Round(time.Microsecond).Microseconds()),
"status": 500,
"ts": startTime.Format(time.RFC3339),
"type": c.Request.Proto,
"useragent": c.Request.UserAgent(),
"trace": traceback.String()[1:],
}
l = l.F(logCtx)
func() {
// Panic is going to panic, but we
// immediately want to recover.
defer func() { recover() }() //nolint:errcheck
l.Panicf("[request panic] %s", r)
}()
// Try to respond with an internal server error.
// If the connection is broken it might panic again.
defer func() { recover() }() // nolint:errcheck
rest.RenderError(c,
http.StatusInternalServerError,
errors.New("internal error"),
)
}
}
// Middleware provides accesslog middleware for the gin-gonic framework.
// This middleware will recover any panic from the occurring in the API
// handler and log it to panic level.
// If an error status is returned in the response, the middleware tries
// to pop the topmost error from the gin.Context (c.Error) and puts it in
// the "error" context to the final log entry.
func Middleware() gin.HandlerFunc {
return func(c *gin.Context) {
startTime := time.Now()
defer panicHandler(c, startTime)
c.Next()
l := log.FromContext(c.Request.Context())
latency := time.Since(startTime)
code := c.Writer.Status()
// Add status and response time to log context
size := c.Writer.Size()
if size < 0 {
size = 0
}
logCtx := log.Ctx{
"byteswritten": size,
"clientip": c.ClientIP(),
"method": c.Request.Method,
"path": c.Request.URL.Path,
"qs": c.Request.URL.RawQuery,
"responsetime": fmt.Sprintf("%dus",
latency.Round(time.Microsecond).Microseconds()),
"status": code,
"ts": startTime.Format(time.RFC3339),
"type": c.Request.Proto,
"useragent": c.Request.UserAgent(),
}
l = l.F(logCtx)
if code < 400 {
l.Info()
} else {
if len(c.Errors) > 0 {
errs := c.Errors.Errors()
var errMsg string
if len(errs) == 1 {
errMsg = errs[0]
} else {
for i, err := range errs {
errMsg = errMsg + fmt.Sprintf(
"#%02d: %s\n", i+1, err,
)
}
}
l = l.F(log.Ctx{
"error": errMsg,
})
} else {
l = l.F(log.Ctx{
"error": http.StatusText(code),
})
}
l.Error()
}
}
}
|
