routing

Documentation

Index

• func MarkLongPolling(resp http.ResponseWriter, req *http.Request)
• func NewLoggerHandler() func(next http.Handler) http.Handler
• func UpdateFuncInfo(ctx context.Context, funcInfo *FuncInfo)
• func UpdatePanicError(ctx context.Context, err any)
• type Event
• type FuncInfo
  • func GetFuncInfo(fn any, friendlyName ...string) *FuncInfo
  • func (info *FuncInfo) String() string
• type Printer

Functions

func MarkLongPolling

func MarkLongPolling(resp http.ResponseWriter, req *http.Request)

MarkLongPolling marks the request is a long-polling request, and the logger may output different message for it

func NewLoggerHandler

func NewLoggerHandler() func(next http.Handler) http.Handler

NewLoggerHandler is a handler that will log routing to the router log taking account of routing information

func UpdateFuncInfo

func UpdateFuncInfo(ctx context.Context, funcInfo *FuncInfo)

UpdateFuncInfo updates a context's func info

func UpdatePanicError

func UpdatePanicError(ctx context.Context, err any)

UpdatePanicError updates a context's error info, a panic may be recovered by other middlewares, but we still need to know that.

Types

type Event

type Event int

Event indicates when the printer is triggered

const (
	// StartEvent at the beginning of a request
	StartEvent Event = iota

	// StillExecutingEvent the request is still executing
	StillExecutingEvent

	// EndEvent the request has ended (either completed or failed)
	EndEvent
)

type FuncInfo

type FuncInfo struct {
	// contains filtered or unexported fields
}

FuncInfo contains information about the function to be logged by the router log

func GetFuncInfo

func GetFuncInfo(fn any, friendlyName ...string) *FuncInfo

GetFuncInfo returns the FuncInfo for a provided function and friendlyname

func (*FuncInfo) String

func (info *FuncInfo) String() string

String returns a string form of the FuncInfo for logging

type Printer

type Printer func(trigger Event, record *requestRecord)

Printer is used to output the log for a request