MyFavMirrors/minio
1
0
Fork 0
mirror of https://github.com/minio/minio.git synced 2025-01-11 15:03:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup ResponseWriter function for audit and trace (#8283)

Browse Source
This commit is contained in:
poornas 2019-09-23 13:34:28 -07:00 committed by kannappanr
parent 3b05e175d7
commit 2e02e1889b
3 changed files with 84 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
cmd/http-tracer.go
View File

@ -18,7 +18,6 @@ package cmd
import ( import (
"bytes" "bytes"
"fmt"
"io" "io"
"io/ioutil" "io/ioutil"
"net" "net"
@ -34,8 +33,6 @@ import (
trace "github.com/minio/minio/pkg/trace" trace "github.com/minio/minio/pkg/trace"
) )
var traceBodyPlaceHolder = []byte("<BODY>")
// recordRequest - records the first recLen bytes // recordRequest - records the first recLen bytes
// of a given io.Reader // of a given io.Reader
type recordRequest struct { type recordRequest struct {
@ -78,81 +75,7 @@ func (r *recordRequest) Data() []byte {
return r.buf.Bytes() return r.buf.Bytes()
} }
// ... otherwise we return <BODY> placeholder // ... otherwise we return <BODY> placeholder
return traceBodyPlaceHolder return logger.BodyPlaceHolder
}
// recordResponseWriter - records the first recLen bytes
// of a given http.ResponseWriter
type recordResponseWriter struct {
// Data source to record
http.ResponseWriter
// Response body should be logged
logBody bool
// Internal recording buffer
headers bytes.Buffer
body bytes.Buffer
// The status code of the current HTTP request
statusCode int
// Indicate if headers are written in the log
headersLogged bool
// number of bytes written
bytesWritten int
}
// Write the headers into the given buffer
func (r *recordResponseWriter) writeHeaders(w io.Writer, statusCode int, headers http.Header) {
n, _ := fmt.Fprintf(w, "%d %s\n", statusCode, http.StatusText(statusCode))
r.bytesWritten += n
for k, v := range headers {
n, _ := fmt.Fprintf(w, "%s: %s\n", k, v[0])
r.bytesWritten += n
}
}
// Record the headers.
func (r *recordResponseWriter) WriteHeader(i int) {
r.statusCode = i
if !r.headersLogged {
r.writeHeaders(&r.headers, i, r.ResponseWriter.Header())
r.headersLogged = true
}
r.ResponseWriter.WriteHeader(i)
}
func (r *recordResponseWriter) Write(p []byte) (n int, err error) {
n, err = r.ResponseWriter.Write(p)
r.bytesWritten += n
if !r.headersLogged {
// We assume the response code to be '200 OK' when WriteHeader() is not called,
// that way following Golang HTTP response behavior.
r.writeHeaders(&r.headers, http.StatusOK, r.ResponseWriter.Header())
r.headersLogged = true
}
if r.statusCode >= http.StatusBadRequest || r.logBody {
// Always logging error responses.
r.body.Write(p)
}
return n, err
}
func (r *recordResponseWriter) Size() int {
return r.bytesWritten
}
// Calls the underlying Flush.
func (r *recordResponseWriter) Flush() {
r.ResponseWriter.(http.Flusher).Flush()
}
// Return response body.
func (r *recordResponseWriter) Body() []byte {
// If there was an error response or body logging is enabled
// then we return the body contents
if r.statusCode >= http.StatusBadRequest || r.logBody {
return r.body.Bytes()
}
// ... otherwise we return the <BODY> place holder
return traceBodyPlaceHolder
} }
// getOpName sanitizes the operation name for mc // getOpName sanitizes the operation name for mc
@ -205,16 +128,15 @@ func Trace(f http.HandlerFunc, logBody bool, w http.ResponseWriter, r *http.Requ
Headers: reqHeaders, Headers: reqHeaders,
Body: reqBodyRecorder.Data(), Body: reqBodyRecorder.Data(),
} }
rw, _ := w.(*logger.ResponseWriter)
// Setup a http response body recorder rw.LogBody = logBody
respBodyRecorder := &recordResponseWriter{ResponseWriter: w, logBody: logBody} f(rw, r)
f(logger.NewResponseWriter(respBodyRecorder), r)
rs := trace.ResponseInfo{ rs := trace.ResponseInfo{
Time: time.Now().UTC(), Time: time.Now().UTC(),
Headers: respBodyRecorder.Header().Clone(), Headers: rw.Header().Clone(),
StatusCode: respBodyRecorder.statusCode, StatusCode: rw.StatusCode,
Body: respBodyRecorder.Body(), Body: rw.Body(),
} }
if rs.StatusCode == 0 { if rs.StatusCode == 0 {
@ -225,9 +147,10 @@ func Trace(f http.HandlerFunc, logBody bool, w http.ResponseWriter, r *http.Requ
t.RespInfo = rs t.RespInfo = rs
t.CallStats = trace.CallStats{ t.CallStats = trace.CallStats{
Latency: rs.Time.Sub(rq.Time), Latency: rs.Time.Sub(rw.StartTime),
InputBytes: reqBodyRecorder.Size(), InputBytes: reqBodyRecorder.Size(),
OutputBytes: respBodyRecorder.Size(), OutputBytes: rw.Size(),
TimeToFirstByte: rw.TimeToFirstByte,
} }
return t return t
} }

82
cmd/logger/audit.go
View File

@ -1,5 +1,5 @@
/* /*
* MinIO Cloud Storage, (C) 2018 MinIO, Inc. * MinIO Cloud Storage, (C) 2018, 2019 MinIO, Inc.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -17,6 +17,9 @@
package logger package logger
import ( import (
"bytes"
"fmt"
"io"
"net/http" "net/http"
"time" "time"
@ -27,9 +30,18 @@ import (
// ResponseWriter - is a wrapper to trap the http response status code. // ResponseWriter - is a wrapper to trap the http response status code.
type ResponseWriter struct { type ResponseWriter struct {
http.ResponseWriter http.ResponseWriter
statusCode int StatusCode int
startTime time.Time // Response body should be logged
timeToFirstByte time.Duration LogBody bool
TimeToFirstByte time.Duration
StartTime time.Time
// number of bytes written
bytesWritten int
// Internal recording buffer
headers bytes.Buffer
body bytes.Buffer
// Indicate if headers are written in the log
headersLogged bool
} }
// NewResponseWriter - returns a wrapped response writer to trap // NewResponseWriter - returns a wrapped response writer to trap
@ -37,25 +49,64 @@ type ResponseWriter struct {
func NewResponseWriter(w http.ResponseWriter) *ResponseWriter { func NewResponseWriter(w http.ResponseWriter) *ResponseWriter {
return &ResponseWriter{ return &ResponseWriter{
ResponseWriter: w, ResponseWriter: w,
statusCode: http.StatusOK, StatusCode: http.StatusOK,
startTime: time.Now().UTC(), StartTime: time.Now().UTC(),
} }
} }
func (lrw *ResponseWriter) Write(p []byte) (int, error) { func (lrw *ResponseWriter) Write(p []byte) (int, error) {
n, err := lrw.ResponseWriter.Write(p) n, err := lrw.ResponseWriter.Write(p)
lrw.bytesWritten += n
if lrw.TimeToFirstByte == 0 {
lrw.TimeToFirstByte = time.Now().UTC().Sub(lrw.StartTime)
}
if !lrw.headersLogged {
// We assume the response code to be '200 OK' when WriteHeader() is not called,
// that way following Golang HTTP response behavior.
lrw.writeHeaders(&lrw.headers, http.StatusOK, lrw.Header())
lrw.headersLogged = true
}
if lrw.StatusCode >= http.StatusBadRequest || lrw.LogBody {
// Always logging error responses.
lrw.body.Write(p)
}
if err != nil { if err != nil {
return n, err return n, err
} }
if lrw.timeToFirstByte == 0 {
lrw.timeToFirstByte = time.Now().UTC().Sub(lrw.startTime)
}
return n, err return n, err
} }
// Write the headers into the given buffer
func (lrw *ResponseWriter) writeHeaders(w io.Writer, statusCode int, headers http.Header) {
n, _ := fmt.Fprintf(w, "%d %s\n", statusCode, http.StatusText(statusCode))
lrw.bytesWritten += n
for k, v := range headers {
n, _ := fmt.Fprintf(w, "%s: %s\n", k, v[0])
lrw.bytesWritten += n
}
}
// BodyPlaceHolder returns a dummy body placeholder
var BodyPlaceHolder = []byte("<BODY>")
// Body - Return response body.
func (lrw *ResponseWriter) Body() []byte {
// If there was an error response or body logging is enabled
// then we return the body contents
if lrw.StatusCode >= http.StatusBadRequest || lrw.LogBody {
return lrw.body.Bytes()
}
// ... otherwise we return the <BODY> place holder
return BodyPlaceHolder
}
// WriteHeader - writes http status code // WriteHeader - writes http status code
func (lrw *ResponseWriter) WriteHeader(code int) { func (lrw *ResponseWriter) WriteHeader(code int) {
lrw.statusCode = code lrw.StatusCode = code
if !lrw.headersLogged {
lrw.writeHeaders(&lrw.headers, code, lrw.ResponseWriter.Header())
lrw.headersLogged = true
}
lrw.ResponseWriter.WriteHeader(code) lrw.ResponseWriter.WriteHeader(code)
} }
@ -64,6 +115,11 @@ func (lrw *ResponseWriter) Flush() {
lrw.ResponseWriter.(http.Flusher).Flush() lrw.ResponseWriter.(http.Flusher).Flush()
} }
// Size - reutrns the number of bytes written
func (lrw *ResponseWriter) Size() int {
return lrw.bytesWritten
}
// AuditTargets is the list of enabled audit loggers // AuditTargets is the list of enabled audit loggers
var AuditTargets = []Target{} var AuditTargets = []Target{}
@ -80,9 +136,9 @@ func AuditLog(w http.ResponseWriter, r *http.Request, api string, reqClaims map[
var timeToFirstByte time.Duration var timeToFirstByte time.Duration
lrw, ok := w.(*ResponseWriter) lrw, ok := w.(*ResponseWriter)
if ok { if ok {
statusCode = lrw.statusCode statusCode = lrw.StatusCode
timeToResponse = time.Now().UTC().Sub(lrw.startTime) timeToResponse = time.Now().UTC().Sub(lrw.StartTime)
timeToFirstByte = lrw.timeToFirstByte timeToFirstByte = lrw.TimeToFirstByte
} }
vars := mux.Vars(r) vars := mux.Vars(r)

7
pkg/trace/trace.go
View File

@ -33,9 +33,10 @@ type Info struct {
// CallStats records request stats // CallStats records request stats
type CallStats struct { type CallStats struct {
InputBytes int `json:"inputbytes"` InputBytes int `json:"inputbytes"`
OutputBytes int `json:"outputbytes"` OutputBytes int `json:"outputbytes"`
Latency time.Duration `json:"latency"` Latency time.Duration `json:"latency"`
TimeToFirstByte time.Duration `json:"timetofirstbyte"`
} }
// RequestInfo represents trace of http request // RequestInfo represents trace of http request