-
Notifications
You must be signed in to change notification settings - Fork 39
/
core.go
346 lines (301 loc) · 9.65 KB
/
core.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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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 logp
import (
"flag"
"fmt"
"io/ioutil"
golog "log"
"os"
"path/filepath"
"strings"
"sync/atomic"
"unsafe"
"github.com/hashicorp/go-multierror"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zaptest/observer"
"go.elastic.co/ecszap"
"github.com/elastic/elastic-agent-libs/file"
"github.com/elastic/elastic-agent-libs/paths"
)
var (
_log unsafe.Pointer // Pointer to a coreLogger. Access via atomic.LoadPointer.
_defaultGoLog = golog.Writer()
)
func init() {
storeLogger(&coreLogger{
selectors: map[string]struct{}{},
rootLogger: zap.NewNop(),
globalLogger: zap.NewNop(),
level: zap.NewAtomicLevel(),
logger: newLogger(zap.NewNop(), ""),
})
}
type coreLogger struct {
selectors map[string]struct{} // Set of enabled debug selectors.
rootLogger *zap.Logger // Root logger without any options configured.
globalLogger *zap.Logger // Logger used by legacy global functions (e.g. logp.Info).
logger *Logger // Logger that is the basis for all logp.Loggers.
level zap.AtomicLevel // The minimum level being printed
observedLogs *observer.ObservedLogs // Contains events generated while in observation mode (a testing mode).
}
// Configure configures the logp package.
func Configure(cfg Config) error {
return ConfigureWithOutputs(cfg)
}
// ConfigureWithOutputs XXX: is used by elastic-agent only (See file: x-pack/elastic-agent/pkg/core/logger/logger.go).
// The agent requires that the output specified in the config object is configured and merged with the
// logging outputs given.
func ConfigureWithOutputs(cfg Config, outputs ...zapcore.Core) error {
var (
sink zapcore.Core
observedLogs *observer.ObservedLogs
err error
level zap.AtomicLevel
)
level = zap.NewAtomicLevelAt(cfg.Level.ZapLevel())
// Build a single output (stderr has priority if more than one are enabled).
if cfg.toObserver {
sink, observedLogs = observer.New(level)
} else {
sink, err = createLogOutput(cfg, level)
}
if err != nil {
return fmt.Errorf("failed to build log output: %w", err)
}
// Default logger is always discard, debug level below will
// possibly re-enable it.
golog.SetOutput(ioutil.Discard)
// Enabled selectors when debug is enabled.
selectors := make(map[string]struct{}, len(cfg.Selectors))
if cfg.Level.Enabled(DebugLevel) && len(cfg.Selectors) > 0 {
for _, sel := range cfg.Selectors {
selectors[strings.TrimSpace(sel)] = struct{}{}
}
// Default to all enabled if no selectors are specified.
if len(selectors) == 0 {
selectors["*"] = struct{}{}
}
// Re-enable the default go logger output when either stdlog
// or all selector is enabled.
_, stdlogEnabled := selectors["stdlog"]
_, allEnabled := selectors["*"]
if stdlogEnabled || allEnabled {
golog.SetOutput(_defaultGoLog)
}
sink = selectiveWrapper(sink, selectors)
}
sink = newMultiCore(append(outputs, sink)...)
root := zap.New(sink, makeOptions(cfg)...)
storeLogger(&coreLogger{
selectors: selectors,
rootLogger: root,
globalLogger: root.WithOptions(zap.AddCallerSkip(1)),
logger: newLogger(root, ""),
level: level,
observedLogs: observedLogs,
})
return nil
}
func createLogOutput(cfg Config, enab zapcore.LevelEnabler) (zapcore.Core, error) {
switch {
case cfg.toIODiscard:
return makeDiscardOutput(cfg, enab)
case cfg.ToStderr:
return makeStderrOutput(cfg, enab)
case cfg.ToSyslog:
return makeSyslogOutput(cfg, enab)
case cfg.ToEventLog:
return makeEventLogOutput(cfg, enab)
case cfg.ToFiles:
return makeFileOutput(cfg, enab)
}
switch cfg.environment {
case SystemdEnvironment, ContainerEnvironment:
return makeStderrOutput(cfg, enab)
case MacOSServiceEnvironment, WindowsServiceEnvironment:
fallthrough
default:
return makeFileOutput(cfg, enab)
}
}
// DevelopmentSetup configures the logger in development mode at debug level.
// By default the output goes to stderr.
func DevelopmentSetup(options ...Option) error {
cfg := Config{
Level: DebugLevel,
ToStderr: true,
development: true,
addCaller: true,
}
for _, apply := range options {
apply(&cfg)
}
return Configure(cfg)
}
// TestingSetup configures logging by calling DevelopmentSetup if and only if
// verbose testing is enabled (as in 'go test -v').
func TestingSetup(options ...Option) error {
// Use the flag to avoid a dependency on the testing package.
f := flag.Lookup("test.v")
if f != nil && f.Value.String() == "true" {
return DevelopmentSetup(options...)
}
return nil
}
// ObserverLogs provides the list of logs generated during the observation
// process.
func ObserverLogs() *observer.ObservedLogs {
return loadLogger().observedLogs
}
// Sync flushes any buffered log entries. Applications should take care to call
// Sync before exiting.
func Sync() error {
return loadLogger().rootLogger.Sync()
}
func makeOptions(cfg Config) []zap.Option {
var options []zap.Option
if cfg.addCaller {
options = append(options, zap.AddCaller())
}
if cfg.development {
options = append(options, zap.Development())
}
if cfg.Beat != "" {
fields := []zap.Field{
zap.String("service.name", cfg.Beat),
}
options = append(options, zap.Fields(fields...))
}
return options
}
func makeStderrOutput(cfg Config, enab zapcore.LevelEnabler) (zapcore.Core, error) {
stderr := zapcore.Lock(os.Stderr)
return newCore(buildEncoder(cfg), stderr, enab), nil
}
func makeDiscardOutput(cfg Config, enab zapcore.LevelEnabler) (zapcore.Core, error) {
discard := zapcore.AddSync(ioutil.Discard)
return newCore(buildEncoder(cfg), discard, enab), nil
}
func makeSyslogOutput(cfg Config, enab zapcore.LevelEnabler) (zapcore.Core, error) {
core, err := newSyslog(buildEncoder(cfg), enab)
if err != nil {
return nil, err
}
return wrappedCore(core), nil
}
func makeEventLogOutput(cfg Config, enab zapcore.LevelEnabler) (zapcore.Core, error) {
core, err := newEventLog(cfg.Beat, buildEncoder(cfg), enab)
// nolint: staticcheck,nolintlint // the implementation is OS-specific and some implementations always return errors
if err != nil {
return nil, err
}
return wrappedCore(core), nil
}
func makeFileOutput(cfg Config, enab zapcore.LevelEnabler) (zapcore.Core, error) {
filename := paths.Resolve(paths.Logs, filepath.Join(cfg.Files.Path, cfg.LogFilename()))
rotator, err := file.NewFileRotator(filename,
file.MaxSizeBytes(cfg.Files.MaxSize),
file.MaxBackups(cfg.Files.MaxBackups),
file.Permissions(os.FileMode(cfg.Files.Permissions)),
file.Interval(cfg.Files.Interval),
file.RotateOnStartup(cfg.Files.RotateOnStartup),
file.RedirectStderr(cfg.Files.RedirectStderr),
)
if err != nil {
return nil, fmt.Errorf("failed to create file rotator: %w", err)
}
return newCore(buildEncoder(cfg), rotator, enab), nil
}
func newCore(enc zapcore.Encoder, ws zapcore.WriteSyncer, enab zapcore.LevelEnabler) zapcore.Core {
return wrappedCore(zapcore.NewCore(enc, ws, enab))
}
func wrappedCore(core zapcore.Core) zapcore.Core {
return ecszap.WrapCore(core)
}
func globalLogger() *zap.Logger {
return loadLogger().globalLogger
}
func loadLogger() *coreLogger {
p := atomic.LoadPointer(&_log)
return (*coreLogger)(p)
}
func storeLogger(l *coreLogger) {
if old := loadLogger(); old != nil {
_ = old.rootLogger.Sync()
}
atomic.StorePointer(&_log, unsafe.Pointer(l))
}
func SetLevel(lvl zapcore.Level) {
loadLogger().level.SetLevel(lvl)
}
func GetLevel() zapcore.Level {
return loadLogger().level.Level()
}
// newMultiCore creates a sink that sends to multiple cores.
func newMultiCore(cores ...zapcore.Core) zapcore.Core {
return &multiCore{cores}
}
// multiCore allows multiple cores to be used for logging.
type multiCore struct {
cores []zapcore.Core
}
// Enabled returns true if the level is enabled in any one of the cores.
func (m multiCore) Enabled(level zapcore.Level) bool {
for _, core := range m.cores {
if core.Enabled(level) {
return true
}
}
return false
}
// With creates a new multiCore with each core set with the given fields.
func (m multiCore) With(fields []zapcore.Field) zapcore.Core {
cores := make([]zapcore.Core, len(m.cores))
for i, core := range m.cores {
cores[i] = core.With(fields)
}
return &multiCore{cores}
}
// Check will place each core that checks for that entry.
func (m multiCore) Check(entry zapcore.Entry, checked *zapcore.CheckedEntry) *zapcore.CheckedEntry {
for _, core := range m.cores {
checked = core.Check(entry, checked)
}
return checked
}
// Write writes the entry to each core.
func (m multiCore) Write(entry zapcore.Entry, fields []zapcore.Field) error {
var errs error
for _, core := range m.cores {
if err := core.Write(entry, fields); err != nil {
errs = multierror.Append(errs, err)
}
}
return errs
}
// Sync syncs each core.
func (m multiCore) Sync() error {
var errs error
for _, core := range m.cores {
if err := core.Sync(); err != nil {
errs = multierror.Append(errs, err)
}
}
return errs
}