Infrastructure/caddy
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2024-12-30 22:34:15 -05:00
Code Issues Activity

Use JSON format for logs if not interactive terminal

Browse source
This commit is contained in:
Matthew Holt 2020-03-16 14:22:40 -06:00
parent b550ea433b
commit ae86f6dd91
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
logging.go
View file

@ -27,6 +27,7 @@ import (
"go.uber.org/zap" "go.uber.org/zap"
"go.uber.org/zap/zapcore" "go.uber.org/zap/zapcore"
"golang.org/x/crypto/ssh/terminal"
) )
func init() { func init() {
@ -35,12 +36,14 @@ func init() {
RegisterModule(DiscardWriter{}) RegisterModule(DiscardWriter{})
} }
// Logging facilitates logging within Caddy. // Logging facilitates logging within Caddy. The default log is
// called "default" and you can customize it. You can also define
// additional logs.
// //
// By default, all logs at INFO level and higher are written to // By default, all logs at INFO level and higher are written to
// standard error ("stderr" writer) in a human-readable format // standard error ("stderr" writer) in a human-readable format
// ("console" encoder). The default log is called "default" and // ("console" encoder if stdout is an interactive terminal, "json"
// you can customize it. You can also define additional logs. // encoder otherwise).
// //
// All defined logs accept all log entries by default, but you // All defined logs accept all log entries by default, but you
// can filter by level and module/logger names. A logger's name // can filter by level and module/logger names. A logger's name
@ -50,10 +53,10 @@ func init() {
// "http.handlers", because all HTTP handler module names have // "http.handlers", because all HTTP handler module names have
// that prefix. // that prefix.
// //
// Caddy logs (except the sink) are mostly zero-allocation, so // Caddy logs (except the sink) are zero-allocation, so they are
// they are very high-performing in terms of memory and CPU time. // very high-performing in terms of memory and CPU time. Enabling
// Enabling sampling can further increase throughput on extremely // sampling can further increase throughput on extremely high-load
// high-load servers. // servers.
type Logging struct { type Logging struct {
// Sink is the destination for all unstructured logs emitted // Sink is the destination for all unstructured logs emitted
// from Go's standard library logger. These logs are common // from Go's standard library logger. These logs are common
@ -660,11 +663,15 @@ func newDefaultProductionLog() (*defaultCustomLog, error) {
func newDefaultProductionLogEncoder() zapcore.Encoder { func newDefaultProductionLogEncoder() zapcore.Encoder {
encCfg := zap.NewProductionEncoderConfig() encCfg := zap.NewProductionEncoderConfig()
encCfg.EncodeLevel = zapcore.CapitalColorLevelEncoder if terminal.IsTerminal(int(os.Stdout.Fd())) {
encCfg.EncodeTime = func(ts time.Time, encoder zapcore.PrimitiveArrayEncoder) { // if interactive terminal, make output more human-readable by default
encoder.AppendString(ts.UTC().Format("2006/01/02 15:04:05.000")) encCfg.EncodeTime = func(ts time.Time, encoder zapcore.PrimitiveArrayEncoder) {
encoder.AppendString(ts.UTC().Format("2006/01/02 15:04:05.000"))
}
encCfg.EncodeLevel = zapcore.CapitalColorLevelEncoder
return zapcore.NewConsoleEncoder(encCfg)
} }
return zapcore.NewConsoleEncoder(encCfg) return zapcore.NewJSONEncoder(encCfg)
} }
// Log returns the current default logger. // Log returns the current default logger.