mirror of
https://github.com/octoleo/restic.git
synced 2024-12-22 10:58:55 +00:00
debug: support roundtripper logging also for release builds
Different from debug builds do not use the eofDetectRoundTripper if logging is disabled.
This commit is contained in:
parent
38becfc436
commit
1ed775e3a8
116
internal/debug/round_tripper.go
Normal file
116
internal/debug/round_tripper.go
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
package debug
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httputil"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"github.com/restic/restic/internal/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
type eofDetectRoundTripper struct {
|
||||||
|
http.RoundTripper
|
||||||
|
}
|
||||||
|
|
||||||
|
type eofDetectReader struct {
|
||||||
|
eofSeen bool
|
||||||
|
rd io.ReadCloser
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rd *eofDetectReader) Read(p []byte) (n int, err error) {
|
||||||
|
n, err = rd.rd.Read(p)
|
||||||
|
if err == io.EOF {
|
||||||
|
rd.eofSeen = true
|
||||||
|
}
|
||||||
|
return n, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rd *eofDetectReader) Close() error {
|
||||||
|
if !rd.eofSeen {
|
||||||
|
buf, err := ioutil.ReadAll(rd)
|
||||||
|
msg := fmt.Sprintf("body not drained, %d bytes not read", len(buf))
|
||||||
|
if err != nil {
|
||||||
|
msg += fmt.Sprintf(", error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(buf) > 0 {
|
||||||
|
if len(buf) > 20 {
|
||||||
|
buf = append(buf[:20], []byte("...")...)
|
||||||
|
}
|
||||||
|
msg += fmt.Sprintf(", body: %q", buf)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintln(os.Stderr, msg)
|
||||||
|
Log("%s: %+v", msg, errors.New("Close()"))
|
||||||
|
}
|
||||||
|
return rd.rd.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (tr eofDetectRoundTripper) RoundTrip(req *http.Request) (res *http.Response, err error) {
|
||||||
|
res, err = tr.RoundTripper.RoundTrip(req)
|
||||||
|
if res != nil && res.Body != nil {
|
||||||
|
res.Body = &eofDetectReader{rd: res.Body}
|
||||||
|
}
|
||||||
|
return res, err
|
||||||
|
}
|
||||||
|
|
||||||
|
type loggingRoundTripper struct {
|
||||||
|
http.RoundTripper
|
||||||
|
}
|
||||||
|
|
||||||
|
func redactHeader(header http.Header) map[string][]string {
|
||||||
|
removedHeaders := make(map[string][]string)
|
||||||
|
for _, hdr := range []string{
|
||||||
|
"Authorization",
|
||||||
|
"X-Auth-Token", // Swift headers
|
||||||
|
"X-Auth-Key",
|
||||||
|
} {
|
||||||
|
origHeader, hasHeader := header[hdr]
|
||||||
|
if hasHeader {
|
||||||
|
removedHeaders[hdr] = origHeader
|
||||||
|
header[hdr] = []string{"**redacted**"}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return removedHeaders
|
||||||
|
}
|
||||||
|
|
||||||
|
func restoreHeader(header http.Header, origHeaders map[string][]string) {
|
||||||
|
for hdr, val := range origHeaders {
|
||||||
|
header[hdr] = val
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (tr loggingRoundTripper) RoundTrip(req *http.Request) (res *http.Response, err error) {
|
||||||
|
// save original auth and redact it
|
||||||
|
origHeaders := redactHeader(req.Header)
|
||||||
|
|
||||||
|
trace, err := httputil.DumpRequestOut(req, false)
|
||||||
|
if err != nil {
|
||||||
|
Log("DumpRequestOut() error: %v\n", err)
|
||||||
|
} else {
|
||||||
|
Log("------------ HTTP REQUEST -----------\n%s", trace)
|
||||||
|
}
|
||||||
|
|
||||||
|
restoreHeader(req.Header, origHeaders)
|
||||||
|
|
||||||
|
res, err = tr.RoundTripper.RoundTrip(req)
|
||||||
|
if err != nil {
|
||||||
|
Log("RoundTrip() returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if res != nil {
|
||||||
|
origHeaders := redactHeader(res.Header)
|
||||||
|
trace, err := httputil.DumpResponse(res, false)
|
||||||
|
restoreHeader(res.Header, origHeaders)
|
||||||
|
if err != nil {
|
||||||
|
Log("DumpResponse() error: %v\n", err)
|
||||||
|
} else {
|
||||||
|
Log("------------ HTTP RESPONSE ----------\n%s", trace)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, err
|
||||||
|
}
|
@ -3,66 +3,7 @@
|
|||||||
|
|
||||||
package debug
|
package debug
|
||||||
|
|
||||||
import (
|
import "net/http"
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httputil"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"github.com/restic/restic/internal/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
type eofDetectRoundTripper struct {
|
|
||||||
http.RoundTripper
|
|
||||||
}
|
|
||||||
|
|
||||||
type eofDetectReader struct {
|
|
||||||
eofSeen bool
|
|
||||||
rd io.ReadCloser
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rd *eofDetectReader) Read(p []byte) (n int, err error) {
|
|
||||||
n, err = rd.rd.Read(p)
|
|
||||||
if err == io.EOF {
|
|
||||||
rd.eofSeen = true
|
|
||||||
}
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rd *eofDetectReader) Close() error {
|
|
||||||
if !rd.eofSeen {
|
|
||||||
buf, err := ioutil.ReadAll(rd)
|
|
||||||
msg := fmt.Sprintf("body not drained, %d bytes not read", len(buf))
|
|
||||||
if err != nil {
|
|
||||||
msg += fmt.Sprintf(", error: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(buf) > 0 {
|
|
||||||
if len(buf) > 20 {
|
|
||||||
buf = append(buf[:20], []byte("...")...)
|
|
||||||
}
|
|
||||||
msg += fmt.Sprintf(", body: %q", buf)
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Fprintln(os.Stderr, msg)
|
|
||||||
Log("%s: %+v", msg, errors.New("Close()"))
|
|
||||||
}
|
|
||||||
return rd.rd.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tr eofDetectRoundTripper) RoundTrip(req *http.Request) (res *http.Response, err error) {
|
|
||||||
res, err = tr.RoundTripper.RoundTrip(req)
|
|
||||||
if res != nil && res.Body != nil {
|
|
||||||
res.Body = &eofDetectReader{rd: res.Body}
|
|
||||||
}
|
|
||||||
return res, err
|
|
||||||
}
|
|
||||||
|
|
||||||
type loggingRoundTripper struct {
|
|
||||||
http.RoundTripper
|
|
||||||
}
|
|
||||||
|
|
||||||
// RoundTripper returns a new http.RoundTripper which logs all requests (if
|
// RoundTripper returns a new http.RoundTripper which logs all requests (if
|
||||||
// debug is enabled). When debug is not enabled, upstream is returned.
|
// debug is enabled). When debug is not enabled, upstream is returned.
|
||||||
@ -74,57 +15,3 @@ func RoundTripper(upstream http.RoundTripper) http.RoundTripper {
|
|||||||
}
|
}
|
||||||
return eofRoundTripper
|
return eofRoundTripper
|
||||||
}
|
}
|
||||||
|
|
||||||
func redactHeader(header http.Header) map[string][]string {
|
|
||||||
removedHeaders := make(map[string][]string)
|
|
||||||
for _, hdr := range []string{
|
|
||||||
"Authorization",
|
|
||||||
"X-Auth-Token", // Swift headers
|
|
||||||
"X-Auth-Key",
|
|
||||||
} {
|
|
||||||
origHeader, hasHeader := header[hdr]
|
|
||||||
if hasHeader {
|
|
||||||
removedHeaders[hdr] = origHeader
|
|
||||||
header[hdr] = []string{"**redacted**"}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return removedHeaders
|
|
||||||
}
|
|
||||||
|
|
||||||
func restoreHeader(header http.Header, origHeaders map[string][]string) {
|
|
||||||
for hdr, val := range origHeaders {
|
|
||||||
header[hdr] = val
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tr loggingRoundTripper) RoundTrip(req *http.Request) (res *http.Response, err error) {
|
|
||||||
// save original auth and redact it
|
|
||||||
origHeaders := redactHeader(req.Header)
|
|
||||||
|
|
||||||
trace, err := httputil.DumpRequestOut(req, false)
|
|
||||||
if err != nil {
|
|
||||||
Log("DumpRequestOut() error: %v\n", err)
|
|
||||||
} else {
|
|
||||||
Log("------------ HTTP REQUEST -----------\n%s", trace)
|
|
||||||
}
|
|
||||||
|
|
||||||
restoreHeader(req.Header, origHeaders)
|
|
||||||
|
|
||||||
res, err = tr.RoundTripper.RoundTrip(req)
|
|
||||||
if err != nil {
|
|
||||||
Log("RoundTrip() returned error: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if res != nil {
|
|
||||||
origHeaders := redactHeader(res.Header)
|
|
||||||
trace, err := httputil.DumpResponse(res, false)
|
|
||||||
restoreHeader(res.Header, origHeaders)
|
|
||||||
if err != nil {
|
|
||||||
Log("DumpResponse() error: %v\n", err)
|
|
||||||
} else {
|
|
||||||
Log("------------ HTTP RESPONSE ----------\n%s", trace)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return res, err
|
|
||||||
}
|
|
||||||
|
@ -8,5 +8,9 @@ import "net/http"
|
|||||||
// RoundTripper returns a new http.RoundTripper which logs all requests (if
|
// RoundTripper returns a new http.RoundTripper which logs all requests (if
|
||||||
// debug is enabled). When debug is not enabled, upstream is returned.
|
// debug is enabled). When debug is not enabled, upstream is returned.
|
||||||
func RoundTripper(upstream http.RoundTripper) http.RoundTripper {
|
func RoundTripper(upstream http.RoundTripper) http.RoundTripper {
|
||||||
|
if opts.isEnabled {
|
||||||
|
// only use loggingRoundTripper if the debug log is configured
|
||||||
|
return loggingRoundTripper{eofDetectRoundTripper{upstream}}
|
||||||
|
}
|
||||||
return upstream
|
return upstream
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
// +build debug
|
|
||||||
|
|
||||||
package debug
|
package debug
|
||||||
|
|
||||||
import (
|
import (
|
Loading…
Reference in New Issue
Block a user