events

package module

v0.0.0-...-451ac38 Latest Latest Go to latest Published: Mar 2, 2022 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bancek/events

Links

Open Source Insights

README ¶

events

HTTP event logger and middleware

Documentation ¶

Index ¶

Variables
func ContextLogger(ctx context.Context) *logrus.Entry
func GetCause(err error) (error, bool)
func NewEventContext(ctx context.Context, event *Event) context.Context
func RequestIP(r *http.Request, trustForwardedFor bool) string
func RequestLogger(r *http.Request) *logrus.Entry
func SetRequestError(r *http.Request, err error)
func SetRequestField(r *http.Request, key string, value interface{})
func UnwrapAll(err error) error
type Event
- func EventFromContext(ctx context.Context) *Event
- func NewEvent(logger *logrus.Entry) *Event
type HTTPMiddleware
- func NewHTTPMiddleware(next http.Handler, logger *logrus.Entry) *HTTPMiddleware
- func (m *HTTPMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	FieldDuration       = "duration"
	FieldErrorCause     = "errorCause"
	FieldErrorStack     = "errorStack"
	FieldHTTPMethod     = "httpMethod"
	FieldHTTPRemoteAddr = "httpRemoteAddr"
	FieldHTTPRespLen    = "httpRespLen"
	FieldHTTPRespStatus = "httpRespStatus"
	FieldHTTPSourceIP   = "httpSourceIp"
	FieldHTTPURI        = "httpUri"
	FieldHTTPUserAgent  = "httpUserAgent"
	FieldProtocol       = "protocol"
	FieldRequestID      = "requestId"
)

Functions ¶

func ContextLogger ¶

func ContextLogger(ctx context.Context) *logrus.Entry

func GetCause ¶

func GetCause(err error) (error, bool)

GetCause unwraps the error and returns the original error if it is not the same as the passed error.

func NewEventContext ¶

func NewEventContext(ctx context.Context, event *Event) context.Context

func RequestIP ¶

func RequestIP(r *http.Request, trustForwardedFor bool) string

func RequestLogger ¶

func RequestLogger(r *http.Request) *logrus.Entry

func SetRequestError ¶

func SetRequestError(r *http.Request, err error)

func SetRequestField ¶

func SetRequestField(r *http.Request, key string, value interface{})

func UnwrapAll ¶

func UnwrapAll(err error) error

Types ¶

type Event ¶

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

func EventFromContext ¶

func EventFromContext(ctx context.Context) *Event

func NewEvent ¶

func NewEvent(logger *logrus.Entry) *Event

func (*Event) GetField ¶

func (e *Event) GetField(key string) interface{}

func (*Event) Logger ¶

func (e *Event) Logger() *logrus.Entry

func (*Event) SetError ¶

func (e *Event) SetError(err error)

func (*Event) SetField ¶

func (e *Event) SetField(key string, value interface{})

type HTTPMiddleware ¶

type HTTPMiddleware struct {
	BuildEvent         func(r *http.Request, e *Event)
	TrustForwardedFor  bool
	RequestIDHeaderKey string
	RequestLogMessage  string
	EventLogMessage    string
	LogRequest         func(e *Event)
	LogEvent           func(e *Event)
	// contains filtered or unexported fields
}

func NewHTTPMiddleware ¶

func NewHTTPMiddleware(next http.Handler, logger *logrus.Entry) *HTTPMiddleware

func (*HTTPMiddleware) ServeHTTP ¶

func (m *HTTPMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

Source Files ¶

View all Source files

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