vimagination.zapto.org/httplog

httplog

-- import "vimagination.zapto.org/httplog"

Package httplog is used to create wrappers around http.Handler's to gather information about a request and its response.

Usage

const DefaultFormat = "{{.RemoteAddr}} - {{.URL.User.Username}} - [{{.StartTime.Format \"02/01/2006:15:04:05 +0700\"}}] \"{{.Method}} {{.URL.RequestURI}} {{.Proto}}\" {{.Status}} {{.RequestLength}} {{.StartTime.Sub .EndTime}}"

DefaultFormat is a simple template to output log data in something reminiscent on the Apache default format.

func Wrap

func Wrap(m http.Handler, l Logger) http.Handler

Wrap wraps an existing http.Handler and collects data about the request and response and passes it to a logger.

type Details

type Details struct {
	*http.Request
	Status, ResponseLength int
	StartTime, EndTime     time.Time
}

Details is a collection of data about the request and response.

type Logger

type Logger interface {
	Log(d Details)
}

Logger allows clients to specify how collected data is handled.

func NewWriteLogger

func NewWriteLogger(w io.Writer, format string) (Logger, error)

NewWriteLogger uses the given format as a template to write log data to the given io.Writer.

type WriteLogger

type WriteLogger struct {
}

WriteLogger is a Logger which formats log data to a given template and writes it to a given io.Writer.

func (*WriteLogger) Log

func (w *WriteLogger) Log(d Details)

Log satisfies the Logger interface.