MyFavMirrors
/
minio
mirror of https://github.com/minio/minio.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
minio/pkg/handlers/http-tracer.go

201 lines
5.4 KiB
Go
Raw Normal View History

log: Store http request/responses in a log file (#4804) When MINIO_TRACE_DIR is provided, create a new log file and store all HTTP requests + responses data, body are excluded to reduce memory consumption. MINIO_HTTP_TRACE=1 enables logging. Use non mem consuming http req/resp recorders, the maximum is about 32k per request. This logs to STDOUT, body logging is disabled for PutObject PutObjectPart GetObject.
2017-10-24 22:04:51 -04:00
/*
* Minio Cloud Storage, (C) 2017 Minio, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package handlers
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"net/http"
"reflect"
"runtime"
"strings"
"time"
)
// recordRequest - records the first recLen bytes
// of a given io.Reader
type recordRequest struct {
// Data source to record
io.Reader
// Response body should be logged
logBody bool
// Internal recording buffer
buf bytes.Buffer
}
func (r *recordRequest) Read(p []byte) (n int, err error) {
n, err = r.Reader.Read(p)
if r.logBody {
r.buf.Write(p[:n])
}
if err != nil {
return n, err
}
return n, err
}
// Return the bytes that were recorded.
func (r *recordRequest) Data() []byte {
return r.buf.Bytes()
}
// 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
}
// Write the headers into the given buffer
func writeHeaders(w io.Writer, statusCode int, headers http.Header) {
fmt.Fprintf(w, "%d %s\n", statusCode, http.StatusText(statusCode))
for k, v := range headers {
fmt.Fprintf(w, "%s: %s\n", k, v[0])
}
}
// Record the headers.
func (r *recordResponseWriter) WriteHeader(i int) {
r.statusCode = i
if !r.headersLogged {
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)
if !r.headersLogged {
Avoid logging the body of the http 206 response (#6258) When an S3 client issues a GET request with range specified, Minio server returns some partial data with 206 http code. The latter is sent in MINIO_HTTP_TRACE output which is incorrect. This PR fixes the issue.
2018-08-08 15:34:42 -04:00
// We assume the response code to be '200 OK' when WriteHeader() is not called,
// that way following Golang HTTP response behavior.
log: Store http request/responses in a log file (#4804) When MINIO_TRACE_DIR is provided, create a new log file and store all HTTP requests + responses data, body are excluded to reduce memory consumption. MINIO_HTTP_TRACE=1 enables logging. Use non mem consuming http req/resp recorders, the maximum is about 32k per request. This logs to STDOUT, body logging is disabled for PutObject PutObjectPart GetObject.
2017-10-24 22:04:51 -04:00
writeHeaders(&r.headers, http.StatusOK, r.ResponseWriter.Header())
r.headersLogged = true
}
Avoid logging the body of the http 206 response (#6258) When an S3 client issues a GET request with range specified, Minio server returns some partial data with 206 http code. The latter is sent in MINIO_HTTP_TRACE output which is incorrect. This PR fixes the issue.
2018-08-08 15:34:42 -04:00
if (r.statusCode != http.StatusOK && r.statusCode != http.StatusPartialContent && r.statusCode != 0) || r.logBody {
// Always logging error responses.
log: Store http request/responses in a log file (#4804) When MINIO_TRACE_DIR is provided, create a new log file and store all HTTP requests + responses data, body are excluded to reduce memory consumption. MINIO_HTTP_TRACE=1 enables logging. Use non mem consuming http req/resp recorders, the maximum is about 32k per request. This logs to STDOUT, body logging is disabled for PutObject PutObjectPart GetObject.
2017-10-24 22:04:51 -04:00
r.body.Write(p)
}
return n, err
}
// Calls the underlying Flush.
func (r *recordResponseWriter) Flush() {
r.ResponseWriter.(http.Flusher).Flush()
}
// Return response headers.
func (r *recordResponseWriter) Headers() []byte {
return r.headers.Bytes()
}
// Return response body.
func (r *recordResponseWriter) Body() []byte {
return r.body.Bytes()
}
// TraceReqHandlerFunc logs request/response headers and body.
func TraceReqHandlerFunc(f http.HandlerFunc, output io.Writer, logBody bool) http.HandlerFunc {
name := runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name()
name = strings.TrimPrefix(name, "github.com/minio/minio/cmd.")
bodyPlaceHolder := []byte("<BODY>")
return func(w http.ResponseWriter, r *http.Request) {
const timeFormat = "2006-01-02 15:04:05 -0700"
var reqBodyRecorder *recordRequest
// Generate short random request ID
reqID := fmt.Sprintf("%f", float64(time.Now().UnixNano())/1e10)
reqBodyRecorder = &recordRequest{Reader: r.Body, logBody: logBody}
r.Body = ioutil.NopCloser(reqBodyRecorder)
// Setup a http response body recorder
respBodyRecorder := &recordResponseWriter{ResponseWriter: w, logBody: logBody}
b := bytes.NewBuffer(nil)
fmt.Fprintf(b, "[REQUEST %s] [%s] [%s]\n", name, reqID, time.Now().Format(timeFormat))
f(respBodyRecorder, r)
// Build request log and write it to log file
fmt.Fprintf(b, "%s %s", r.Method, r.URL.Path)
if r.URL.RawQuery != "" {
fmt.Fprintf(b, "?%s", r.URL.RawQuery)
}
fmt.Fprintf(b, "\n")
fmt.Fprintf(b, "Host: %s\n", r.Host)
for k, v := range r.Header {
fmt.Fprintf(b, "%s: %s\n", k, v[0])
}
fmt.Fprintf(b, "\n")
if logBody {
bodyContents := reqBodyRecorder.Data()
if bodyContents != nil {
// If body logging is disabled then we print <BODY> as a placeholder
// for the actual body.
b.Write(bodyContents)
fmt.Fprintf(b, "\n")
}
} else {
b.Write(bodyPlaceHolder)
fmt.Fprintf(b, "\n")
}
fmt.Fprintf(b, "\n")
// Build response log and write it to log file
fmt.Fprintf(b, "[RESPONSE] [%s] [%s]\n", reqID, time.Now().Format(timeFormat))
b.Write(respBodyRecorder.Headers())
fmt.Fprintf(b, "\n")
Avoid logging the body of the http 206 response (#6258) When an S3 client issues a GET request with range specified, Minio server returns some partial data with 206 http code. The latter is sent in MINIO_HTTP_TRACE output which is incorrect. This PR fixes the issue.
2018-08-08 15:34:42 -04:00
// recordResponseWriter{} is configured to record only
// responses with http code != 200 & != 206, we don't
// have to check for logBody value here.
log: Store http request/responses in a log file (#4804) When MINIO_TRACE_DIR is provided, create a new log file and store all HTTP requests + responses data, body are excluded to reduce memory consumption. MINIO_HTTP_TRACE=1 enables logging. Use non mem consuming http req/resp recorders, the maximum is about 32k per request. This logs to STDOUT, body logging is disabled for PutObject PutObjectPart GetObject.
2017-10-24 22:04:51 -04:00
bodyContents := respBodyRecorder.Body()
if bodyContents != nil {
b.Write(bodyContents)
fmt.Fprintf(b, "\n")
} else {
if !logBody {
// If there was no error response and body logging is disabled
// then we print <BODY> as a placeholder for the actual body.
b.Write(bodyPlaceHolder)
fmt.Fprintf(b, "\n")
}
}
fmt.Fprintf(b, "\n")
// Write the contents in one shot so that logs don't get interspersed.
output.Write(b.Bytes())
}
}