tool

Documentation

Overview

provides structured logging with logrus.

Index

• Variables
• func CloseDB(pool *dockertest.Pool, resource *dockertest.Resource)
• func GetLogEntry(r *http.Request) logrus.FieldLogger
• func InitDB() (*dockertest.Pool, *dockertest.Resource)
• func LogEntrySetField(r *http.Request, key string, value interface{})
• func LogEntrySetFields(r *http.Request, fields map[string]interface{})
• func NewLogger() *logrus.Logger
• func NewStructuredLogger(logger *logrus.Logger) func(next http.Handler) http.Handler
• type StructuredLogger
  • func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry
• type StructuredLoggerEntry
  • func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte)
  • func (l *StructuredLoggerEntry) Write(status, bytes int, header http.Header, elapsed time.Duration, ...)

Variables

var (
	// Logger is a configured logrus.Logger.
	Logger *logrus.Logger
)

Functions

func CloseDB

func CloseDB(pool *dockertest.Pool, resource *dockertest.Resource)

func GetLogEntry

func GetLogEntry(r *http.Request) logrus.FieldLogger

GetLogEntry return the request scoped logrus.FieldLogger.

func InitDB

func InitDB() (*dockertest.Pool, *dockertest.Resource)

refs: https://github.com/ory/dockertest

func LogEntrySetField

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

LogEntrySetField adds a field to the request scoped logrus.FieldLogger.

func LogEntrySetFields

func LogEntrySetFields(r *http.Request, fields map[string]interface{})

LogEntrySetFields adds multiple fields to the request scoped logrus.FieldLogger.

func NewLogger

func NewLogger() *logrus.Logger

NewLogger creates and configures a new logrus Logger.

func NewStructuredLogger

func NewStructuredLogger(logger *logrus.Logger) func(next http.Handler) http.Handler

NewStructuredLogger implements a custom structured logrus Logger.

Types

type StructuredLogger

type StructuredLogger struct {
	Logger *logrus.Logger
}

StructuredLogger is a structured logrus Logger.

func (*StructuredLogger) NewLogEntry

func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry

NewLogEntry sets default request log fields.

type StructuredLoggerEntry

type StructuredLoggerEntry struct {
	Logger logrus.FieldLogger
}

StructuredLoggerEntry is a logrus.FieldLogger.

func (*StructuredLoggerEntry) Panic

func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte)

Panic prints stack trace

func (*StructuredLoggerEntry) Write

func (l *StructuredLoggerEntry) Write(status, bytes int, header http.Header, elapsed time.Duration, extra interface{})