0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2024-12-23 22:27:38 -05:00

Rewrote access log middleware

This commit is contained in:
Matthew Holt 2015-03-28 16:50:42 -06:00
parent d2892fc799
commit 7578298b3f

View file

@ -1,4 +1,4 @@
// Package log implements basic but useful request logging middleware. // Package log implements basic but useful request (access) logging middleware.
package log package log
import ( import (
@ -11,21 +11,79 @@ import (
// New instantiates a new instance of logging middleware. // New instantiates a new instance of logging middleware.
func New(c middleware.Controller) (middleware.Middleware, error) { func New(c middleware.Controller) (middleware.Middleware, error) {
var logWhat, outputFile, format string rules, err := parse(c)
var logger *log.Logger if err != nil {
return nil, err
}
// Open the log files for writing when the server starts
c.Startup(func() error {
for i := 0; i < len(rules); i++ {
var err error
var file *os.File
if rules[i].OutputFile == "stdout" {
file = os.Stdout
} else if rules[i].OutputFile == "stderr" {
file = os.Stderr
} else {
file, err = os.OpenFile(rules[i].OutputFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
if err != nil {
return err
}
}
rules[i].Log = log.New(file, "", 0)
}
return nil
})
return func(next middleware.HandlerFunc) middleware.HandlerFunc {
return Logger{Next: next, Rules: rules}.ServeHTTP
}, nil
}
func (l Logger) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) {
for _, rule := range l.Rules {
if middleware.Path(r.URL.Path).Matches(rule.PathScope) {
responseRecorder := middleware.NewResponseRecorder(w)
status, err := l.Next(responseRecorder, r)
rep := middleware.NewReplacer(r, responseRecorder)
rule.Log.Println(rep.Replace(rule.Format))
return status, err
}
}
return l.Next(w, r)
}
func parse(c middleware.Controller) ([]LogRule, error) {
var rules []LogRule
for c.Next() { for c.Next() {
c.Args(&logWhat, &outputFile, &format) args := c.RemainingArgs()
if logWhat == "" { if len(args) == 0 {
return nil, c.ArgErr() // Nothing specified; use defaults
} rules = append(rules, LogRule{
if outputFile == "" { PathScope: "/",
outputFile = defaultLogFilename OutputFile: defaultLogFilename,
} Format: defaultLogFormat,
switch format { })
case "": } else if len(args) == 1 {
format = defaultReqLogFormat // Only an output file specified
rules = append(rules, LogRule{
PathScope: "/",
OutputFile: args[0],
Format: defaultLogFormat,
})
} else {
// Path scope, output file, and maybe a format specified
format := defaultLogFormat
if len(args) > 2 {
switch args[2] {
case "{common}": case "{common}":
format = commonLogFormat format = commonLogFormat
case "{combined}": case "{combined}":
@ -33,39 +91,32 @@ func New(c middleware.Controller) (middleware.Middleware, error) {
} }
} }
// Open the log file for writing when the server starts rules = append(rules, LogRule{
c.Startup(func() error { PathScope: args[0],
var err error OutputFile: args[1],
var file *os.File Format: format,
if outputFile == "stdout" {
file = os.Stdout
} else if outputFile == "stderr" {
file = os.Stderr
} else {
file, err = os.OpenFile(outputFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
if err != nil {
return err
}
}
logger = log.New(file, "", 0)
return nil
}) })
return func(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
sw := middleware.NewResponseRecorder(w)
next(sw, r)
rep := middleware.NewReplacer(r, sw)
logger.Println(rep.Replace(format))
} }
}, nil }
return rules, nil
}
type Logger struct {
Next middleware.HandlerFunc
Rules []LogRule
}
type LogRule struct {
PathScope string
OutputFile string
Format string
Log *log.Logger
} }
const ( const (
defaultLogFilename = "access.log" defaultLogFilename = "access.log"
commonLogFormat = `{remote} ` + middleware.EmptyStringReplacer + ` [{when}] "{method} {uri} {proto}" {status} {size}` commonLogFormat = `{remote} ` + middleware.EmptyStringReplacer + ` [{when}] "{method} {uri} {proto}" {status} {size}`
combinedLogFormat = commonLogFormat + ` "{>Referer}" "{>User-Agent}"` combinedLogFormat = commonLogFormat + ` "{>Referer}" "{>User-Agent}"`
defaultReqLogFormat = commonLogFormat defaultLogFormat = commonLogFormat
) )