generated from cloudwego/.github
-
Notifications
You must be signed in to change notification settings - Fork 17
/
accesslog.go
200 lines (172 loc) · 5.26 KB
/
accesslog.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
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
* Copyright 2022 CloudWeGo Authors
*
* 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.
*
* MIT License
*
* Copyright (c) 2019-present Fenny and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.E SOFTWARE.
*
* This file may have been modified by CloudWeGo authors. All CloudWeGo
* Modifications are Copyright 2022 CloudWeGo Authors.
*/
package accesslog
import (
"context"
"fmt"
"os"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/cloudwego/hertz/pkg/app"
"github.com/cloudwego/hertz/pkg/common/bytebufferpool"
)
var defaultFormat = " %s | %3d | %7v | %-7s | %-s "
func New(opts ...Option) app.HandlerFunc {
return new(context.Background(), opts...)
}
func NewWithContext(ctx context.Context, opts ...Option) app.HandlerFunc {
return new(ctx, opts...)
}
func new(ctx context.Context, opts ...Option) app.HandlerFunc {
cfg := newOptions(opts...)
// Check if format contains latency
cfg.enableLatency = strings.Contains(cfg.format, "${latency}")
// Create correct time format
var timestamp atomic.Value
timestamp.Store(time.Now().In(cfg.timeZoneLocation).Format(cfg.timeFormat))
// Update date/time every 500 milliseconds in a separate go routine
if strings.Contains(cfg.format, "${time}") {
go func() {
for {
select {
case <-time.After(cfg.timeInterval):
case <-ctx.Done():
return
}
timestamp.Store(time.Now().In(cfg.timeZoneLocation).Format(cfg.timeFormat))
}
}()
}
// Set PID once and add tag
pid := strconv.Itoa(os.Getpid())
dataPool := sync.Pool{
New: func() interface{} {
return &Data{}
},
}
// instead of analyzing the template inside(handler) each time, this is done once before
// and we create several slices of the same length with the functions to be executed and fixed parts.
tmplChain, logFunChain, err := buildLogFuncChain(cfg, Tags)
if err != nil {
panic(err)
}
return func(ctx context.Context, c *app.RequestContext) {
var start, stop time.Time
// Logger data
data := dataPool.Get().(*Data) //nolint:forcetypeassert,errcheck // We store nothing else in the pool
// no need for a reset, as long as we always override everything
data.Pid = pid
data.Timestamp = timestamp
// put data back in the pool
defer dataPool.Put(data)
// Set latency start time
if cfg.enableLatency {
data.Start = time.Now()
}
c.Next(ctx)
if !cfg.logConditionFunc(ctx, c) {
return
}
if cfg.enableLatency {
data.Stop = time.Now()
}
// Get new buffer
buf := bytebufferpool.Get()
defer bytebufferpool.Put(buf)
if cfg.format == defaultTagFormat {
// format log to buffer
_, _ = buf.WriteString(fmt.Sprintf(defaultFormat,
timestamp,
c.Response.StatusCode(),
stop.Sub(start),
c.Method(),
c.Path(),
))
cfg.logFunc(ctx, buf.String())
return
}
// Loop over template parts execute dynamic parts and add fixed parts to the buffer
for i, logFunc := range logFunChain {
if logFunc == nil {
_, _ = buf.Write(tmplChain[i]) //nolint:errcheck // This will never fail
} else if tmplChain[i] == nil {
_, err = logFunc(buf, c, data, "")
} else {
_, err = logFunc(buf, c, data, unsafeString(tmplChain[i]))
}
if err != nil {
break
}
}
// Also write errors to the buffer
if err != nil {
_, _ = buf.WriteString(err.Error())
}
cfg.logFunc(ctx, buf.String())
}
}
func appendInt(output Buffer, v int) (int, error) {
old := output.Len()
output.Set(appendUint(output.Bytes(), v))
return output.Len() - old, nil
}
func appendUint(dst []byte, n int) []byte {
if n < 0 {
panic("BUG: int must be positive")
}
var b [20]byte
buf := b[:]
i := len(buf)
var q int
for n >= 10 {
i--
q = n / 10
buf[i] = '0' + byte(n-q*10)
n = q
}
i--
buf[i] = '0' + byte(n)
dst = append(dst, buf[i:]...)
return dst
}