log

Documentation

Index

• func HTTPHandlerFuncWithLog(logger Logger, next http.HandlerFunc, middlewareConfig ...APIMiddlewareConfig) http.HandlerFunc
• func HTTPHandlerWithLog(logger Logger, next http.Handler, middlewareConfig ...APIMiddlewareConfig) http.Handler
• func HTTPMiddlewareWithLog(logger Logger, middlewareConfig ...APIMiddlewareConfig) func(http.Handler) http.Handler
• func PubSubHandlerFuncWithLog(logger Logger, next pubsub.HandlerFunc, ...) pubsub.HandlerFunc
• func PubSubMiddlewareWithLog(logger Logger, middlewareConfig ...PubSubMiddlewareConfig) func(pubsub.HandlerFunc) pubsub.HandlerFunc
• func StreamMiddlewareWithLog(logger Logger, middlewareConfig ...APIMiddlewareConfig) grpc.StreamServerInterceptor
• func UnaryMiddlewareWithLog(logger Logger, middlewareConfig ...APIMiddlewareConfig) grpc.UnaryServerInterceptor
• type APIMiddlewareConfig
• type Logger
• type PubSubMiddlewareConfig

Functions

func HTTPHandlerFuncWithLog

func HTTPHandlerFuncWithLog(logger Logger, next http.HandlerFunc, middlewareConfig ...APIMiddlewareConfig) http.HandlerFunc

HTTPHandlerFuncWithLog is http handler func with log.

func HTTPHandlerWithLog

func HTTPHandlerWithLog(logger Logger, next http.Handler, middlewareConfig ...APIMiddlewareConfig) http.Handler

HTTPHandlerWithLog is http handler with log. Also includes error stack tracing feature if you use it.

func HTTPMiddlewareWithLog

func HTTPMiddlewareWithLog(logger Logger, middlewareConfig ...APIMiddlewareConfig) func(http.Handler) http.Handler

HTTPMiddlewareWithLog is http middleware that will log the request and response.

func PubSubHandlerFuncWithLog

func PubSubHandlerFuncWithLog(logger Logger, next pubsub.HandlerFunc, middlewareConfig ...PubSubMiddlewareConfig) pubsub.HandlerFunc

PubSubHandlerFuncWithLog is pubsub handler with log. Also includes error stack tracing feature if you use it.

func PubSubMiddlewareWithLog

func PubSubMiddlewareWithLog(logger Logger, middlewareConfig ...PubSubMiddlewareConfig) func(pubsub.HandlerFunc) pubsub.HandlerFunc

PubSubMiddlewareWithLog is pubsub middelware that will log the request.

func StreamMiddlewareWithLog

func StreamMiddlewareWithLog(logger Logger, middlewareConfig ...APIMiddlewareConfig) grpc.StreamServerInterceptor

StreamMiddlewareWithLog is stream grpc middleware that will log the request and response. Todo: implement logger here.

func UnaryMiddlewareWithLog

func UnaryMiddlewareWithLog(logger Logger, middlewareConfig ...APIMiddlewareConfig) grpc.UnaryServerInterceptor

UnaryMiddlewareWithLog is unary grpc middleware that will log the request and response.

Types

type APIMiddlewareConfig

type APIMiddlewareConfig struct {
	// Show request header.
	RequestHeader bool
	// Show request body.
	RequestBody bool
	// Show response header.
	ResponseHeader bool
	// Show response body.
	ResponseBody bool
	// Show raw path (includes query params).
	RawPath bool
	// Show error stack.
	Error bool
}

APIMiddlewareConfig is log config for middleware.

type Logger

type Logger interface {
	Trace(format string, args ...interface{})
	Debug(format string, args ...interface{})
	Info(format string, args ...interface{})
	Warn(format string, args ...interface{})
	Error(format string, args ...interface{})
	Fatal(format string, args ...interface{})
	Panic(format string, args ...interface{})

	// General log with key value.
	Log(fields map[string]interface{})
}

Logger is logging interface.

See usage example in example folder.

type PubSubMiddlewareConfig

type PubSubMiddlewareConfig struct {
	// Topic/queue name.
	Topic string
	// Show message payload.
	Payload bool
	// Show error stack.
	Error bool
}

PubSubMiddlewareConfig is pubsub config for middleware.