handler

package
v0.4.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 7, 2024 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsFileExist

func IsFileExist(name string) bool

Types

type FileHandler

type FileHandler struct {
	ErrorCallback func(buf interface{}, err error)
	// contains filtered or unexported fields
}

func (*FileHandler) BulkFill added in v0.3.0

func (h *FileHandler) BulkFill(buf []byte) []byte

func (*FileHandler) Close

func (h *FileHandler) Close() error

func (*FileHandler) Emit

func (h *FileHandler) Emit(entry *message.Entry) error

type FileHandlerConfig added in v0.3.0

type FileHandlerConfig struct {
	FileDir       string
	FileName      string
	MaxFileSize   int64
	BackupCount   int
	BulkWriteSize int

	RotatorType       RotatorType
	Interval          int64  // unit: second. used in TimeRotator and TimeAndSizeRotator.
	TimeSuffixFmt     string // Time suffix format of file name:test.log.2024061104
	ReMatch           string
	FileSuffix        string
	ConcurrentlyWrite bool

	ErrCallback func(buf interface{}, err error)
}

func (*FileHandlerConfig) WithBackupCount added in v0.4.1

func (c *FileHandlerConfig) WithBackupCount(n int) *FileHandlerConfig

func (*FileHandlerConfig) WithBulkSize added in v0.4.1

func (c *FileHandlerConfig) WithBulkSize(size int) *FileHandlerConfig

func (*FileHandlerConfig) WithConcurrentlyWrite added in v0.4.1

func (c *FileHandlerConfig) WithConcurrentlyWrite() *FileHandlerConfig

func (*FileHandlerConfig) WithErrCallback added in v0.4.1

func (c *FileHandlerConfig) WithErrCallback(cb func(buf interface{}, err error)) *FileHandlerConfig

func (*FileHandlerConfig) WithFileDir added in v0.4.1

func (c *FileHandlerConfig) WithFileDir(dir string) *FileHandlerConfig

func (*FileHandlerConfig) WithFileName added in v0.4.1

func (c *FileHandlerConfig) WithFileName(name string) *FileHandlerConfig

func (*FileHandlerConfig) WithFileSize added in v0.4.1

func (c *FileHandlerConfig) WithFileSize(size int64) *FileHandlerConfig

func (*FileHandlerConfig) WithFileSuffix added in v0.4.1

func (c *FileHandlerConfig) WithFileSuffix(suffix string) *FileHandlerConfig

func (*FileHandlerConfig) WithInterval added in v0.4.1

func (c *FileHandlerConfig) WithInterval(seconds int64) *FileHandlerConfig

func (*FileHandlerConfig) WithReMatch added in v0.4.1

func (c *FileHandlerConfig) WithReMatch(regexp string) *FileHandlerConfig

func (*FileHandlerConfig) WithRotatorType added in v0.4.1

func (c *FileHandlerConfig) WithRotatorType(typ RotatorType) *FileHandlerConfig

func (*FileHandlerConfig) WithTimeSuffixFmt added in v0.4.1

func (c *FileHandlerConfig) WithTimeSuffixFmt(timeFormat string) *FileHandlerConfig

type IHandler

type IHandler interface {
	Emit(entry *message.Entry) error
	Close() error
}

type IRotator

type IRotator interface {
	NeedRollover(msg []byte) (*os.File, bool, error)
	DoRollover() (*os.File, error)
	Close() error
}

func NewRotator added in v0.4.0

func NewRotator(cfg *FileHandlerConfig) (IRotator, error)

type IStreamer added in v0.3.0

type IStreamer interface {
	io.WriteCloser
}

type RotatorType added in v0.3.0

type RotatorType int8
const (
	FileRotatorTypeTime        RotatorType = 1
	FileRotatorTypeSize        RotatorType = 2
	FileRotatorTypeTimeAndSize RotatorType = 3
)

type SizeRotator

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

func NewSizeRotator

func NewSizeRotator(cfg *FileHandlerConfig) (*SizeRotator, error)

func (*SizeRotator) Close

func (r *SizeRotator) Close() error

func (*SizeRotator) DoRollover

func (r *SizeRotator) DoRollover() (*os.File, error)

func (*SizeRotator) NeedRollover

func (r *SizeRotator) NeedRollover(msg []byte) (*os.File, bool, error)

type StdoutHandler added in v0.4.0

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

func NewStdoutHandler added in v0.4.0

func NewStdoutHandler(fm formatter.IFormatter, ft filter.IFilter) (*StdoutHandler, error)

func (*StdoutHandler) Close added in v0.4.0

func (h *StdoutHandler) Close() error

func (*StdoutHandler) Emit added in v0.4.0

func (h *StdoutHandler) Emit(entry *message.Entry) error

func (*StdoutHandler) Format added in v0.4.0

func (h *StdoutHandler) Format(entry *message.Entry) ([]byte, error)

type StreamHandler

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

func (*StreamHandler) Close

func (h *StreamHandler) Close() error

func (*StreamHandler) Emit

func (h *StreamHandler) Emit(record *message.Entry) error

type StreamHandlerConfig added in v0.3.0

type StreamHandlerConfig struct {
	Streamer IStreamer
}

type SyslogHandler

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

func (*SyslogHandler) Close

func (h *SyslogHandler) Close() error

func (*SyslogHandler) Emit

func (h *SyslogHandler) Emit(e *message.Entry) error

func (*SyslogHandler) Init

func (h *SyslogHandler) Init() error

type SyslogHandlerConfig added in v0.3.0

type SyslogHandlerConfig struct {
	Network  string
	Address  string
	Tag      string
	Priority int
}

func (*SyslogHandlerConfig) WithAddress added in v0.4.1

func (c *SyslogHandlerConfig) WithAddress(addr string) *SyslogHandlerConfig

func (*SyslogHandlerConfig) WithNetwork added in v0.4.1

func (c *SyslogHandlerConfig) WithNetwork(net string) *SyslogHandlerConfig

func (*SyslogHandlerConfig) WithPriority added in v0.4.1

func (c *SyslogHandlerConfig) WithPriority(priority int) *SyslogHandlerConfig

func (*SyslogHandlerConfig) WithTag added in v0.4.1

type TimeAndSizeRotator

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

func NewTimeAndSizeRotator

func NewTimeAndSizeRotator(cfg *FileHandlerConfig) (*TimeAndSizeRotator, error)

func (*TimeAndSizeRotator) Close

func (r *TimeAndSizeRotator) Close() error

func (*TimeAndSizeRotator) DoRollover

func (r *TimeAndSizeRotator) DoRollover() (*os.File, error)

func (*TimeAndSizeRotator) NeedRollover

func (r *TimeAndSizeRotator) NeedRollover(msg []byte) (*os.File, bool, error)

type TimeRotator

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

func NewTimeRotator

func NewTimeRotator(cfg *FileHandlerConfig) (*TimeRotator, error)

func (*TimeRotator) Close

func (r *TimeRotator) Close() error

func (*TimeRotator) DoRollover

func (r *TimeRotator) DoRollover() (*os.File, error)

func (*TimeRotator) NeedRollover

func (r *TimeRotator) NeedRollover(_ []byte) (*os.File, bool, error)

Jump to

Keyboard shortcuts

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