logrushooks

README

logrushooks

Syslog Hooks for Logrus

Documentation

Index

• type StdoutHook
  • func NewStdoutHook(level string, opts ...StdoutOption) (*StdoutHook, error)
  • func (hook *StdoutHook) Fire(entry *logrus.Entry) error
  • func (hook *StdoutHook) Levels() []logrus.Level
  • func (hook *StdoutHook) SetFormater(formater logrus.Formatter)
• type StdoutOption
  • func WithStdoutFormater(formater logrus.Formatter) StdoutOption
• type SyslogHook
  • func NewSyslogHook(addr, level string, opts ...SyslogOptions) (*SyslogHook, error)
  • func (hook *SyslogHook) Fire(entry *logrus.Entry) error
  • func (hook *SyslogHook) Levels() []logrus.Level
  • func (hook *SyslogHook) SetFormater(formater logrus.Formatter)
• type SyslogOptions
  • func WithSyslogFormater(formater logrus.Formatter) SyslogOptions
  • func WithSyslogNetwork(network string) SyslogOptions
  • func WithSyslogPriority(p syslog.Priority) SyslogOptions
  • func WithSyslogTag(tag string) SyslogOptions

Types

type StdoutHook

type StdoutHook struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

func NewStdoutHook

func NewStdoutHook(level string, opts ...StdoutOption) (*StdoutHook, error)

func (*StdoutHook) Fire

func (hook *StdoutHook) Fire(entry *logrus.Entry) error

func (*StdoutHook) Levels

func (hook *StdoutHook) Levels() []logrus.Level

func (*StdoutHook) SetFormater

func (hook *StdoutHook) SetFormater(formater logrus.Formatter)

type StdoutOption

type StdoutOption func(*StdoutHook)

func WithStdoutFormater

func WithStdoutFormater(formater logrus.Formatter) StdoutOption

type SyslogHook

type SyslogHook struct {
	Writer *syslog.Writer
	// contains filtered or unexported fields
}

func NewSyslogHook

func NewSyslogHook(addr, level string, opts ...SyslogOptions) (*SyslogHook, error)

Create a hook to be added to an instance of logger. This is called with

	syslog_host = `127.0.0.1`
    syslog_level = `info

`

    format := (&format.SomeFormater{
		DisableTimestamp:   true,
		MessageAfterFields: true,
	}).Init()

	sysHook, err := logrushooks.NewSyslogHook(
		syslog_host,
		syslog_level,
		logrushooks.WithFormater(format),
	)

	if err != nil {
		logger.Fatalf("Syslog hook init fails: %s", err)
	}

	logger.Hooks.Add(sysHook)

func (*SyslogHook) Fire

func (hook *SyslogHook) Fire(entry *logrus.Entry) error

func (*SyslogHook) Levels

func (hook *SyslogHook) Levels() []logrus.Level

func (*SyslogHook) SetFormater

func (hook *SyslogHook) SetFormater(formater logrus.Formatter)

type SyslogOptions

type SyslogOptions func(*SyslogHook)

func WithSyslogFormater

func WithSyslogFormater(formater logrus.Formatter) SyslogOptions

func WithSyslogNetwork

func WithSyslogNetwork(network string) SyslogOptions

func WithSyslogPriority

func WithSyslogPriority(p syslog.Priority) SyslogOptions

func WithSyslogTag

func WithSyslogTag(tag string) SyslogOptions