mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-23 22:27:38 -05:00
2a46f2a14e
fastcgi's ServeHTTP method originally returned the correct value (0) inb51e8bc191. Later, I mistakenly suggested we change that to return the status code because I forgot that status codes aren't logged by the return value. So fastcgi broke due in3966936bd6due to my error. We later had to try to make up for this with ugly Content-Length checks like inc37ad7f677. Turns out that all we had to do was fix the returned status here back to 0. The proxy middleware behaves the same way, and returning 0 is correct. We should only return a status code if the response has not been written, but with upstream servers, we do write a response; they do not know about our error handler. Also clarifed this in the middleware.Handler documentation.
64 lines
2 KiB
Go
64 lines
2 KiB
Go
// Package log implements basic but useful request (access) logging middleware.
|
|
package log
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"net/http"
|
|
|
|
"github.com/mholt/caddy/middleware"
|
|
)
|
|
|
|
// Logger is a basic request logging middleware.
|
|
type Logger struct {
|
|
Next middleware.Handler
|
|
Rules []Rule
|
|
ErrorFunc func(http.ResponseWriter, *http.Request, int) // failover error handler
|
|
}
|
|
|
|
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.ServeHTTP(responseRecorder, r)
|
|
if status >= 400 {
|
|
// There was an error up the chain, but no response has been written yet.
|
|
// The error must be handled here so the log entry will record the response size.
|
|
if l.ErrorFunc != nil {
|
|
l.ErrorFunc(responseRecorder, r, status)
|
|
} else {
|
|
// Default failover error handler
|
|
responseRecorder.WriteHeader(status)
|
|
fmt.Fprintf(responseRecorder, "%d %s", status, http.StatusText(status))
|
|
}
|
|
status = 0
|
|
}
|
|
rep := middleware.NewReplacer(r, responseRecorder, CommonLogEmptyValue)
|
|
rule.Log.Println(rep.Replace(rule.Format))
|
|
return status, err
|
|
}
|
|
}
|
|
return l.Next.ServeHTTP(w, r)
|
|
}
|
|
|
|
// Rule configures the logging middleware.
|
|
type Rule struct {
|
|
PathScope string
|
|
OutputFile string
|
|
Format string
|
|
Log *log.Logger
|
|
Roller *middleware.LogRoller
|
|
}
|
|
|
|
const (
|
|
// DefaultLogFilename is the default log filename.
|
|
DefaultLogFilename = "access.log"
|
|
// CommonLogFormat is the common log format.
|
|
CommonLogFormat = `{remote} ` + CommonLogEmptyValue + ` [{when}] "{method} {uri} {proto}" {status} {size}`
|
|
// CommonLogEmptyValue is the common empty log value.
|
|
CommonLogEmptyValue = "-"
|
|
// CombinedLogFormat is the combined log format.
|
|
CombinedLogFormat = CommonLogFormat + ` "{>Referer}" "{>User-Agent}"`
|
|
// DefaultLogFormat is the default log format.
|
|
DefaultLogFormat = CommonLogFormat
|
|
)
|