logging

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2021 License: MIT Imports: 12 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

AllLevels lists all 5 values in order.

View Source
var LongBodyThreshold = 100

LongBodyThreshold is the body length threshold beyond which the body will be written to a text file (when the content is text). Otherwise it is written inline in the log.

Functions

func IsTextual

func IsTextual(contentType string) bool

IsTextual tests a media type (a.k.a. content type) to determine whether it describes text or binary content.

Types

type Level

type Level int

Level allows control of the level of detail in log messages.

const (
	// Off turns logging off.
	Off Level = iota

	// Discrete log messages contain only a summary of the request and response.
	// No query parameters are printed in order to hide potential personal information.
	Discrete

	// Summary log messages contain only a summary of the request and response,
	// including the full target URL.
	Summary

	// WithHeaders log messages contain a summary and the request/response headers
	WithHeaders

	// WithHeadersAndBodies log messages contain a summary and the request/response headers and bodies
	// Textual bodies are included in the log; for binary content, the size is shown instead.
	WithHeadersAndBodies
)

func (Level) Ordinal added in v0.0.7

func (i Level) Ordinal() int

Ordinal returns the ordinal number of a Level.

func (Level) String added in v0.0.7

func (i Level) String() string

String returns the literal string representation of a Level, which is the same as the const identifier.

type LogContent

type LogContent struct {
	Header http.Header
	Body   []byte
}

type LogItem

type LogItem struct {
	Method     string
	URL        *url.URL
	StatusCode int
	Request    LogContent
	Response   LogContent
	Err        error
	Start      time.Time
	Duration   time.Duration
	Level      Level
}

type Logger

type Logger func(item *LogItem)

func LogWriter

func LogWriter(out io.Writer, dir string) Logger

LogWriter returns a new Logger.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL