xecho

package module

v0.1.10 Latest Latest Go to latest Published: Apr 30, 2024 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/JSainsburyPLC/xecho

Links

Open Source Insights

README ¶

xecho

A thin wrapper around https://echo.labstack.com. Includes

New Relic integration
Logrus for structured json logging
Custom error type
Custom request context with tracing (correlation ID)

Documentation ¶

Index ¶

Variables
func ContextMiddleware(buildVersion string, logger *logrus.Entry, isDebug bool, ...) echo.MiddlewareFunc
func DebugLoggerMiddleware(isDebug bool) echo.MiddlewareFunc
func DefaultHeadersMiddleware() echo.MiddlewareFunc
func Echo(conf Config) *echo.Echo
func EchoHandler(handler Handler) echo.HandlerFunc
func ErrorHandlerMiddleware(errorHandler ErrorHandlerFunc) echo.MiddlewareFunc
func NewHttpClient(context *Context, isDebug bool) *http.Client
func PanicHandlerMiddleware(errorHandler ErrorHandlerFunc) echo.MiddlewareFunc
func RequestLogger(c *Context, next echo.HandlerFunc, time TimeProvider) error
func RequestLoggerMiddleware(timeFn TimeProvider) echo.MiddlewareFunc
type Config
- func NewConfig() Config
type Context
- func NewContext(echoCtx echo.Context, newRelicApp newrelic.Application, logger *Logger, ...) *Context
- func (c *Context) AddNewRelicAttribute(key string, val interface{})
- func (c *Context) Logger() echo.Logger
type Error
- func (err *Error) Error() string
type ErrorHandlerFunc
- func DefaultErrorHandler() ErrorHandlerFunc
type Handler
type Logger
- func (l *Logger) Debugj(j log.JSON)
- func (l *Logger) Errorj(j log.JSON)
- func (l *Logger) Fatalj(j log.JSON)
- func (l *Logger) Infoj(j log.JSON)
- func (l *Logger) Level() log.Lvl
- func (l *Logger) Output() io.Writer
- func (l *Logger) Panicj(j log.JSON)
- func (l *Logger) Prefix() string
- func (l *Logger) Printj(j log.JSON)
- func (l *Logger) SetHeader(_ string)
- func (l *Logger) SetLevel(lvl log.Lvl)
- func (l *Logger) SetOutput(w io.Writer)
- func (l *Logger) SetPrefix(_ string)
- func (l *Logger) Warnj(j log.JSON)
type TimeProvider
type Xecho
- func New(conf Config) *Xecho

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrBadRequest = &Error{
	Status: http.StatusBadRequest,
	Code:   "BAD_REQUEST",
	Detail: "Bad request",
}

View Source

var ErrInternalServer = &Error{
	Status: http.StatusInternalServerError,
	Code:   "INTERNAL_SERVER_ERROR",
	Detail: "Internal server error",
}

View Source

var ErrMethodNotAllowed = &Error{
	Status: http.StatusMethodNotAllowed,
	Code:   "METHOD_NOT_ALLOWED",
	Detail: "Method not allowed",
}

View Source

var ErrNotFound = &Error{
	Status: http.StatusNotFound,
	Code:   "NOT_FOUND",
	Detail: "Not found",
}

View Source

var ErrUnauthorised = &Error{
	Status: http.StatusUnauthorized,
	Code:   "UNAUTHORISED",
	Detail: "Unauthorised",
}

Functions ¶

func ContextMiddleware ¶

func ContextMiddleware(
	buildVersion string,
	logger *logrus.Entry,
	isDebug bool,
	newRelicApp newrelic.Application,
) echo.MiddlewareFunc

func DebugLoggerMiddleware ¶

func DebugLoggerMiddleware(isDebug bool) echo.MiddlewareFunc

func DefaultHeadersMiddleware ¶

func DefaultHeadersMiddleware() echo.MiddlewareFunc

func Echo ¶

func Echo(conf Config) *echo.Echo

func EchoHandler ¶

func EchoHandler(handler Handler) echo.HandlerFunc

func ErrorHandlerMiddleware ¶

func ErrorHandlerMiddleware(errorHandler ErrorHandlerFunc) echo.MiddlewareFunc

func NewHttpClient ¶

func NewHttpClient(
	context *Context,
	isDebug bool,
) *http.Client

func PanicHandlerMiddleware ¶

func PanicHandlerMiddleware(errorHandler ErrorHandlerFunc) echo.MiddlewareFunc

func RequestLogger ¶ added in v0.1.7

func RequestLogger(c *Context, next echo.HandlerFunc, time TimeProvider) error

func RequestLoggerMiddleware ¶

func RequestLoggerMiddleware(timeFn TimeProvider) echo.MiddlewareFunc

Types ¶

type Config ¶

type Config struct {
	ProjectName       string
	AppName           string
	EnvName           string
	BuildVersion      string
	LogLevel          logrus.Level
	LogFormatter      logrus.Formatter
	IsDebug           bool
	NewRelicLicense   string
	NewRelicEnabled   bool
	ErrorHandler      ErrorHandlerFunc
	UseDefaultHeaders bool
	RoutePrefix       string
}

func NewConfig ¶

func NewConfig() Config

type Context ¶

type Context struct {
	echo.Context
	CorrelationID string
	HttpClient    *http.Client
	NewRelicApp   newrelic.Application
	NewRelicTx    newrelic.Transaction
	// contains filtered or unexported fields
}

func NewContext ¶ added in v0.1.2

func NewContext(
	echoCtx echo.Context,
	newRelicApp newrelic.Application,
	logger *Logger,
	correlationID string,
	isDebug bool,
	buildVersion string,
) *Context

func (*Context) AddNewRelicAttribute ¶

func (c *Context) AddNewRelicAttribute(key string, val interface{})

func (*Context) Logger ¶

func (c *Context) Logger() echo.Logger

type Error ¶

type Error struct {
	Status int               `json:"-" example:"400"`
	Code   string            `json:"code" example:"BAD_REQUEST"`
	Detail string            `json:"detail" example:"Bad request"`
	Params map[string]string `json:"-"`
}

func (*Error) Error ¶

func (err *Error) Error() string

type ErrorHandlerFunc ¶

type ErrorHandlerFunc func(c *Context, err *Error)

func DefaultErrorHandler ¶

func DefaultErrorHandler() ErrorHandlerFunc

type Handler ¶

type Handler func(c *Context) error

type Logger ¶

type Logger struct {
	*logrus.Entry
}

Wrap logrus entry and implement additional methods required to satisfy echo logger interface

func (*Logger) Debugj ¶

func (l *Logger) Debugj(j log.JSON)

func (*Logger) Errorj ¶

func (l *Logger) Errorj(j log.JSON)

func (*Logger) Fatalj ¶

func (l *Logger) Fatalj(j log.JSON)

func (*Logger) Infoj ¶

func (l *Logger) Infoj(j log.JSON)

func (*Logger) Level ¶

func (l *Logger) Level() log.Lvl

func (*Logger) Output ¶

func (l *Logger) Output() io.Writer

func (*Logger) Panicj ¶

func (l *Logger) Panicj(j log.JSON)

func (*Logger) Prefix ¶

func (l *Logger) Prefix() string

func (*Logger) Printj ¶

func (l *Logger) Printj(j log.JSON)

func (*Logger) SetHeader ¶

func (l *Logger) SetHeader(_ string)

func (*Logger) SetLevel ¶

func (l *Logger) SetLevel(lvl log.Lvl)

func (*Logger) SetOutput ¶

func (l *Logger) SetOutput(w io.Writer)

func (*Logger) SetPrefix ¶

func (l *Logger) SetPrefix(_ string)

func (*Logger) Warnj ¶

func (l *Logger) Warnj(j log.JSON)

type TimeProvider ¶ added in v0.1.7

type TimeProvider func() time.Time

type Xecho ¶ added in v0.1.9

type Xecho struct {
	Echo        *echo.Echo
	NewRelicApp newrelic.Application
}

func New ¶ added in v0.1.9

func New(conf Config) *Xecho

Source Files ¶

View all Source files

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