mirror of
https://github.com/oauth2-proxy/oauth2-proxy.git
synced 2024-11-28 09:08:44 +02:00
ec97000169
Add ability to silence logging of requests to /ping endpoint, reducing log clutter Pros: - Don't have to change all handlers to set/not set silent ping logging - Don't have to duplicate `loggingHandler` (this could be preferable yet) Cons: - Leaking oauth2proxy logic into `package logger` - Defining default pingPath in two locations Alternative: - Add generic exclude path to `logger.go` and pass in `/ping`.
109 lines
2.7 KiB
Go
109 lines
2.7 KiB
Go
// largely adapted from https://github.com/gorilla/handlers/blob/master/handlers.go
|
|
// to add logging of request duration as last value (and drop referrer)
|
|
|
|
package main
|
|
|
|
import (
|
|
"bufio"
|
|
"errors"
|
|
"net"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/pusher/oauth2_proxy/pkg/logger"
|
|
)
|
|
|
|
// responseLogger is wrapper of http.ResponseWriter that keeps track of its HTTP status
|
|
// code and body size
|
|
type responseLogger struct {
|
|
w http.ResponseWriter
|
|
status int
|
|
size int
|
|
upstream string
|
|
authInfo string
|
|
}
|
|
|
|
// Header returns the ResponseWriter's Header
|
|
func (l *responseLogger) Header() http.Header {
|
|
return l.w.Header()
|
|
}
|
|
|
|
// Support Websocket
|
|
func (l *responseLogger) Hijack() (rwc net.Conn, buf *bufio.ReadWriter, err error) {
|
|
if hj, ok := l.w.(http.Hijacker); ok {
|
|
return hj.Hijack()
|
|
}
|
|
return nil, nil, errors.New("http.Hijacker is not available on writer")
|
|
}
|
|
|
|
// ExtractGAPMetadata extracts and removes GAP headers from the ResponseWriter's
|
|
// Header
|
|
func (l *responseLogger) ExtractGAPMetadata() {
|
|
upstream := l.w.Header().Get("GAP-Upstream-Address")
|
|
if upstream != "" {
|
|
l.upstream = upstream
|
|
l.w.Header().Del("GAP-Upstream-Address")
|
|
}
|
|
authInfo := l.w.Header().Get("GAP-Auth")
|
|
if authInfo != "" {
|
|
l.authInfo = authInfo
|
|
l.w.Header().Del("GAP-Auth")
|
|
}
|
|
}
|
|
|
|
// Write writes the response using the ResponseWriter
|
|
func (l *responseLogger) Write(b []byte) (int, error) {
|
|
if l.status == 0 {
|
|
// The status will be StatusOK if WriteHeader has not been called yet
|
|
l.status = http.StatusOK
|
|
}
|
|
l.ExtractGAPMetadata()
|
|
size, err := l.w.Write(b)
|
|
l.size += size
|
|
return size, err
|
|
}
|
|
|
|
// WriteHeader writes the status code for the Response
|
|
func (l *responseLogger) WriteHeader(s int) {
|
|
l.ExtractGAPMetadata()
|
|
l.w.WriteHeader(s)
|
|
l.status = s
|
|
}
|
|
|
|
// Status returns the response status code
|
|
func (l *responseLogger) Status() int {
|
|
return l.status
|
|
}
|
|
|
|
// Size returns the response size
|
|
func (l *responseLogger) Size() int {
|
|
return l.size
|
|
}
|
|
|
|
// Flush sends any buffered data to the client
|
|
func (l *responseLogger) Flush() {
|
|
if flusher, ok := l.w.(http.Flusher); ok {
|
|
flusher.Flush()
|
|
}
|
|
}
|
|
|
|
// loggingHandler is the http.Handler implementation for LoggingHandler
|
|
type loggingHandler struct {
|
|
handler http.Handler
|
|
}
|
|
|
|
// LoggingHandler provides an http.Handler which logs requests to the HTTP server
|
|
func LoggingHandler(h http.Handler) http.Handler {
|
|
return loggingHandler{
|
|
handler: h,
|
|
}
|
|
}
|
|
|
|
func (h loggingHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
|
|
t := time.Now()
|
|
url := *req.URL
|
|
responseLogger := &responseLogger{w: w}
|
|
h.handler.ServeHTTP(responseLogger, req)
|
|
logger.PrintReq(responseLogger.authInfo, responseLogger.upstream, req, url, t, responseLogger.Status(), responseLogger.Size())
|
|
}
|