git.iko.soy/typeable/oauth2-proxy
on v1.1 help sign in
typeable/oauth2-proxy/logging_handler.go
132 lines 3.0 kB history raw
1// largely adapted from https://github.com/gorilla/handlers/blob/master/handlers.go
2// to add logging of request duration as last value (and drop referrer)
4package main
6import (
7 "fmt"
8 "io"
9 "net"
10 "net/http"
11 "net/url"
12 "time"
15// responseLogger is wrapper of http.ResponseWriter that keeps track of its HTTP status
16// code and body size
17type responseLogger struct {
18 w http.ResponseWriter
19 status int
20 size int
21 upstream string
22 authInfo string
25func (l *responseLogger) Header() http.Header {
26 return l.w.Header()
29func (l *responseLogger) ExtractGAPMetadata() {
30 upstream := l.w.Header().Get("GAP-Upstream-Address")
31 if upstream != "" {
32 l.upstream = upstream
33 l.w.Header().Del("GAP-Upstream-Address")
34 }
35 authInfo := l.w.Header().Get("GAP-Auth")
36 if authInfo != "" {
37 l.authInfo = authInfo
38 l.w.Header().Del("GAP-Auth")
39 }
42func (l *responseLogger) Write(b []byte) (int, error) {
43 if l.status == 0 {
44 // The status will be StatusOK if WriteHeader has not been called yet
45 l.status = http.StatusOK
46 }
47 l.ExtractGAPMetadata()
48 size, err := l.w.Write(b)
49 l.size += size
50 return size, err
53func (l *responseLogger) WriteHeader(s int) {
54 l.ExtractGAPMetadata()
55 l.w.WriteHeader(s)
56 l.status = s
59func (l *responseLogger) Status() int {
60 return l.status
63func (l *responseLogger) Size() int {
64 return l.size
67// loggingHandler is the http.Handler implementation for LoggingHandlerTo and its friends
68type loggingHandler struct {
69 writer io.Writer
70 handler http.Handler
71 enabled bool
74func LoggingHandler(out io.Writer, h http.Handler, v bool) http.Handler {
75 return loggingHandler{out, h, v}
78func (h loggingHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
79 t := time.Now()
80 url := *req.URL
81 logger := &responseLogger{w: w}
82 h.handler.ServeHTTP(logger, req)
83 if !h.enabled {
84 return
85 }
86 logLine := buildLogLine(logger.authInfo, logger.upstream, req, url, t, logger.Status(), logger.Size())
87 h.writer.Write(logLine)
90// Log entry for req similar to Apache Common Log Format.
91// ts is the timestamp with which the entry should be logged.
92// status, size are used to provide the response HTTP status and size.
93func buildLogLine(username, upstream string, req *http.Request, url url.URL, ts time.Time, status int, size int) []byte {
94 if username == "" {
95 username = "-"
96 }
97 if upstream == "" {
98 upstream = "-"
99 }
100 if url.User != nil && username == "-" {
101 if name := url.User.Username(); name != "" {
102 username = name
103 }
104 }
106 client := req.Header.Get("X-Real-IP")
107 if client == "" {
108 client = req.RemoteAddr
109 }
111 if c, _, err := net.SplitHostPort(client); err == nil {
112 client = c
113 }
115 duration := float64(time.Now().Sub(ts)) / float64(time.Second)
117 logLine := fmt.Sprintf("%s - %s [%s] %s %s %s %q %s %q %d %d %0.3f\n",
118 client,
119 username,
120 ts.Format("02/Jan/2006:15:04:05 -0700"),
121 req.Host,
122 req.Method,
123 upstream,
124 url.RequestURI(),
125 req.Proto,
126 req.UserAgent(),
127 status,
128 size,
129 duration,
130 )
131 return []byte(logLine)