log

Documentation

Index

• Constants
• func NewWriter(instance *logrus.Entry) log.Writer
• type Application
  • func NewApplication(config config.Config) *Application
  • func (r *Application) WithContext(ctx context.Context) log.Writer
• type Entry
  • func (r *Entry) Context() context.Context
  • func (r *Entry) Level() log.Level
  • func (r *Entry) Message() string
  • func (r *Entry) Time() time.Time
• type Hook
  • func (h *Hook) Fire(entry *logrus.Entry) error
  • func (h *Hook) Levels() []logrus.Level
• type ServiceProvider
  • func (log *ServiceProvider) Boot(app foundation.Application)
  • func (log *ServiceProvider) Register(app foundation.Application)
• type Writer
  • func (r *Writer) Code(code string) log.Writer
  • func (r *Writer) Debug(args ...any)
  • func (r *Writer) Debugf(format string, args ...any)
  • func (r *Writer) Error(args ...any)
  • func (r *Writer) Errorf(format string, args ...any)
  • func (r *Writer) Fatal(args ...any)
  • func (r *Writer) Fatalf(format string, args ...any)
  • func (r *Writer) Hint(hint string) log.Writer
  • func (r *Writer) In(domain string) log.Writer
  • func (r *Writer) Info(args ...any)
  • func (r *Writer) Infof(format string, args ...any)
  • func (r *Writer) Owner(owner any) log.Writer
  • func (r *Writer) Panic(args ...any)
  • func (r *Writer) Panicf(format string, args ...any)
  • func (r *Writer) Request(req http.ContextRequest) log.Writer
  • func (r *Writer) Response(res http.ContextResponse) log.Writer
  • func (r *Writer) Tags(tags ...string) log.Writer
  • func (r *Writer) User(user any) log.Writer
  • func (r *Writer) Warning(args ...any)
  • func (r *Writer) Warningf(format string, args ...any)
  • func (r *Writer) With(data map[string]any) log.Writer

Constants

const Binding = "goravel.log"

Functions

func NewWriter

func NewWriter(instance *logrus.Entry) log.Writer

Types

type Application

type Application struct {
	log.Writer
	// contains filtered or unexported fields
}

func NewApplication

func NewApplication(config config.Config) *Application

func (*Application) WithContext

func (r *Application) WithContext(ctx context.Context) log.Writer

type Entry

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

func (*Entry) Context

func (r *Entry) Context() context.Context

func (*Entry) Level

func (r *Entry) Level() log.Level

func (*Entry) Message

func (r *Entry) Message() string

func (*Entry) Time

func (r *Entry) Time() time.Time

type Hook

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

func (*Hook) Fire

func (h *Hook) Fire(entry *logrus.Entry) error

func (*Hook) Levels

func (h *Hook) Levels() []logrus.Level

type ServiceProvider

type ServiceProvider struct {
}

func (*ServiceProvider) Boot

func (log *ServiceProvider) Boot(app foundation.Application)

func (*ServiceProvider) Register

func (log *ServiceProvider) Register(app foundation.Application)

type Writer

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

func (*Writer) Code

func (r *Writer) Code(code string) log.Writer

Code set a code or slug that describes the error. Error messages are intended to be read by humans, but such code is expected to be read by machines and even transported over different services.

func (*Writer) Debug

func (r *Writer) Debug(args ...any)

func (*Writer) Debugf

func (r *Writer) Debugf(format string, args ...any)

func (*Writer) Error

func (r *Writer) Error(args ...any)

func (*Writer) Errorf

func (r *Writer) Errorf(format string, args ...any)

func (*Writer) Fatal

func (r *Writer) Fatal(args ...any)

func (*Writer) Fatalf

func (r *Writer) Fatalf(format string, args ...any)

func (*Writer) Hint

func (r *Writer) Hint(hint string) log.Writer

Hint set a hint for faster debugging.

func (*Writer) In

func (r *Writer) In(domain string) log.Writer

In sets the feature category or domain in which the log entry is relevant.

func (*Writer) Info

func (r *Writer) Info(args ...any)

func (*Writer) Infof

func (r *Writer) Infof(format string, args ...any)

func (*Writer) Owner

func (r *Writer) Owner(owner any) log.Writer

Owner set the name/email of the colleague/team responsible for handling this error. Useful for alerting purpose.

func (*Writer) Panic

func (r *Writer) Panic(args ...any)

func (*Writer) Panicf

func (r *Writer) Panicf(format string, args ...any)

func (*Writer) Request

func (r *Writer) Request(req http.ContextRequest) log.Writer

Request supplies a http.Request.

func (*Writer) Response

func (r *Writer) Response(res http.ContextResponse) log.Writer

Response supplies a http.Response.

func (*Writer) Tags

func (r *Writer) Tags(tags ...string) log.Writer

Tags add multiple tags, describing the feature returning an error.

func (*Writer) User

func (r *Writer) User(user any) log.Writer

User sets the user associated with the log entry.

func (*Writer) Warning

func (r *Writer) Warning(args ...any)

func (*Writer) Warningf

func (r *Writer) Warningf(format string, args ...any)

func (*Writer) With

func (r *Writer) With(data map[string]any) log.Writer

With adds key-value pairs to the context of the log entry