handler

package
v0.5.8 Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: MIT Imports: 14 Imported by: 0

README

Handlers

Package handler provide useful common log handlers. eg: file, console, multi_file, rotate_file, stream, syslog, email

handler -> buffered -> rotated -> writer(os.File)

Built-in handlers

  • handler.ConsoleHandler Console handler
  • handler.FileHandler File handler
  • handler.StreamHandler Stream handler
  • handler.SyslogHandler Syslog handler
  • handler.EmailHandler Email handler
  • handler.FlushCloseHandler Flush and close handler

Go Docs

Docs generated by: go doc ./handler

Handler Functions
func LineBuffOsFile(f *os.File, bufSize int, levels []slog.Level) slog.Handler
func LineBuffWriter(w io.Writer, bufSize int, levels []slog.Level) slog.Handler
func LineBufferedFile(logfile string, bufSize int, levels []slog.Level) (slog.Handler, error)

type ConsoleHandler = IOWriterHandler
    func ConsoleWithLevels(levels []slog.Level) *ConsoleHandler
    func ConsoleWithMaxLevel(level slog.Level) *ConsoleHandler
    func NewConsole(levels []slog.Level) *ConsoleHandler
    func NewConsoleHandler(levels []slog.Level) *ConsoleHandler
    func NewConsoleWithLF(lf slog.LevelFormattable) *ConsoleHandler
type EmailHandler struct{ ... }
    func NewEmailHandler(from EmailOption, toAddresses []string) *EmailHandler
type EmailOption struct{ ... }

type FlushCloseHandler struct{ ... }
    func FlushCloserWithLevels(out FlushCloseWriter, levels []slog.Level) *FlushCloseHandler
    func FlushCloserWithMaxLevel(out FlushCloseWriter, maxLevel slog.Level) *FlushCloseHandler
    func NewBuffered(w io.WriteCloser, bufSize int, levels ...slog.Level) *FlushCloseHandler
    func NewBufferedHandler(w io.WriteCloser, bufSize int, levels ...slog.Level) *FlushCloseHandler
    func NewFlushCloseHandler(out FlushCloseWriter, levels []slog.Level) *FlushCloseHandler
    func NewFlushCloser(out FlushCloseWriter, levels []slog.Level) *FlushCloseHandler
    func NewFlushCloserWithLF(out FlushCloseWriter, lf slog.LevelFormattable) *FlushCloseHandler

type IOWriterHandler struct{ ... }
    func IOWriterWithLevels(out io.Writer, levels []slog.Level) *IOWriterHandler
    func IOWriterWithMaxLevel(out io.Writer, maxLevel slog.Level) *IOWriterHandler
    func NewIOWriter(out io.Writer, levels []slog.Level) *IOWriterHandler
    func NewIOWriterHandler(out io.Writer, levels []slog.Level) *IOWriterHandler
    func NewIOWriterWithLF(out io.Writer, lf slog.LevelFormattable) *IOWriterHandler
    func NewSimpleHandler(out io.Writer, maxLevel slog.Level) *IOWriterHandler
    func SimpleWithLevels(out io.Writer, levels []slog.Level) *IOWriterHandler


type SimpleHandler = IOWriterHandler
    func NewHandler(out io.Writer, maxLevel slog.Level) *SimpleHandler
    func NewSimple(out io.Writer, maxLevel slog.Level) *SimpleHandler

type SyncCloseHandler struct{ ... }
    func JSONFileHandler(logfile string, fns ...ConfigFn) (*SyncCloseHandler, error)
    func MustFileHandler(logfile string, fns ...ConfigFn) *SyncCloseHandler
    func MustRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) *SyncCloseHandler
    func MustSimpleFile(filepath string, maxLv ...slog.Level) *SyncCloseHandler
    func MustSizeRotateFile(logfile string, maxSize int, fns ...ConfigFn) *SyncCloseHandler
    func MustTimeRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) *SyncCloseHandler
    func NewBuffFileHandler(logfile string, buffSize int, fns ...ConfigFn) (*SyncCloseHandler, error)
    func NewFileHandler(logfile string, fns ...ConfigFn) (h *SyncCloseHandler, err error)
    func NewRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)
    func NewRotateFileHandler(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)
    func NewSimpleFile(filepath string, maxLv ...slog.Level) (*SyncCloseHandler, error)
    func NewSimpleFileHandler(filePath string, maxLv ...slog.Level) (*SyncCloseHandler, error)
    func NewSizeRotateFile(logfile string, maxSize int, fns ...ConfigFn) (*SyncCloseHandler, error)
    func NewSizeRotateFileHandler(logfile string, maxSize int, fns ...ConfigFn) (*SyncCloseHandler, error)
    func NewSyncCloseHandler(out SyncCloseWriter, levels []slog.Level) *SyncCloseHandler
    func NewSyncCloser(out SyncCloseWriter, levels []slog.Level) *SyncCloseHandler
    func NewSyncCloserWithLF(out SyncCloseWriter, lf slog.LevelFormattable) *SyncCloseHandler
    func NewTimeRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)
    func NewTimeRotateFileHandler(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)
    func SyncCloserWithLevels(out SyncCloseWriter, levels []slog.Level) *SyncCloseHandler
    func SyncCloserWithMaxLevel(out SyncCloseWriter, maxLevel slog.Level) *SyncCloseHandler

type SysLogHandler struct{ ... }
    func NewSysLogHandler(priority syslog.Priority, tag string) (*SysLogHandler, error)

type WriteCloserHandler struct{ ... }
    func NewWriteCloser(out io.WriteCloser, levels []slog.Level) *WriteCloserHandler
    func NewWriteCloserHandler(out io.WriteCloser, levels []slog.Level) *WriteCloserHandler
    func NewWriteCloserWithLF(out io.WriteCloser, lf slog.LevelFormattable) *WriteCloserHandler
    func WriteCloserWithLevels(out io.WriteCloser, levels []slog.Level) *WriteCloserHandler
    func WriteCloserWithMaxLevel(out io.WriteCloser, maxLevel slog.Level) *WriteCloserHandler
Config Functions
type Builder struct{ ... }
    func NewBuilder() *Builder
type Config struct{ ... }
    func NewConfig(fns ...ConfigFn) *Config
    func NewEmptyConfig(fns ...ConfigFn) *Config
type ConfigFn func(c *Config)
    func WithBackupNum(n uint) ConfigFn
    func WithBackupTime(bt uint) ConfigFn
    func WithBuffMode(buffMode string) ConfigFn
    func WithBuffSize(buffSize int) ConfigFn
    func WithCompress(compress bool) ConfigFn
    func WithFilePerm(filePerm fs.FileMode) ConfigFn
    func WithLevelMode(mode slog.LevelMode) ConfigFn
    func WithLevelNames(names []string) ConfigFn
    func WithLogLevel(level slog.Level) ConfigFn
    func WithLogLevels(levels slog.Levels) ConfigFn
    func WithLogfile(logfile string) ConfigFn
    func WithMaxSize(maxSize uint64) ConfigFn
    func WithRotateMode(m rotatefile.RotateMode) ConfigFn
    func WithRotateTime(rt rotatefile.RotateTime) ConfigFn
    func WithUseJSON(useJSON bool) ConfigFn

Documentation

Overview

Package handler provide useful common log handlers.

eg: file, console, multi_file, rotate_file, stream, syslog, email

Example (FileHandler) 
package main

import (
	"github.com/gookit/slog"
	"github.com/gookit/slog/handler"
)

func main() {
	withLevels := handler.WithLogLevels(slog.Levels{slog.PanicLevel, slog.ErrorLevel, slog.WarnLevel})
	h1 := handler.MustFileHandler("/tmp/error.log", withLevels)

	withLevels = handler.WithLogLevels(slog.Levels{slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel, slog.TraceLevel})
	h2 := handler.MustFileHandler("/tmp/info.log", withLevels)

	slog.PushHandler(h1)
	slog.PushHandler(h2)

	// add logs
	slog.Info("info message")
	slog.Error("error message")
}

Output:
Example (RotateFileHandler) 
package main

import (
	"github.com/gookit/slog"
	"github.com/gookit/slog/handler"
)

func main() {
	h1 := handler.MustRotateFile("/tmp/error.log", handler.EveryHour, handler.WithLogLevels(slog.DangerLevels))
	h2 := handler.MustRotateFile("/tmp/info.log", handler.EveryHour, handler.WithLogLevels(slog.NormalLevels))

	slog.PushHandler(h1)
	slog.PushHandler(h2)

	// add logs
	slog.Info("info message")
	slog.Error("error message")
}

Output:

Index

Examples

Constants

View Source 
const (
	BuffModeLine = "line"
	BuffModeBite = "bite"
)

the buff mode consts

View Source 
const (
	// LevelModeList use level list for limit record write
	LevelModeList = slog.LevelModeList
	// LevelModeValue use max level limit log record write
	LevelModeValue = slog.LevelModeMax
)
View Source 
const (
	EveryDay  = rotatefile.EveryDay
	EveryHour = rotatefile.EveryDay

	Every30Minutes = rotatefile.Every30Min
	Every15Minutes = rotatefile.Every15Min

	EveryMinute = rotatefile.EveryMinute
	EverySecond = rotatefile.EverySecond // only use for tests
)

Deprecated: Please use define constants on pkg rotatefile. e.g. rotatefile.EveryDay

Variables

View Source 
var (
	// DefaultFilePerm perm and flags for create log file
	DefaultFilePerm os.FileMode = 0664
	// DefaultFileFlags for create/open file
	DefaultFileFlags = os.O_CREATE | os.O_WRONLY | os.O_APPEND
)
View Source 
var DefaultBufferSize = 8 * 1024

DefaultBufferSize sizes the buffer associated with each log file. It's large so that log records can accumulate without the logging thread blocking on disk I/O. The flushDaemon will block instead.

Functions

func LineBuffOsFile 

func LineBuffOsFile(f *os.File, bufSize int, levels []slog.Level) slog.Handler

LineBuffOsFile handler

func LineBuffWriter 

func LineBuffWriter(w io.Writer, bufSize int, levels []slog.Level) slog.Handler

LineBuffWriter handler

func LineBufferedFile 

func LineBufferedFile(logfile string, bufSize int, levels []slog.Level) (slog.Handler, error)

LineBufferedFile handler

func QuickOpenFile 

func QuickOpenFile(filepath string) (*os.File, error)

QuickOpenFile like os.OpenFile

Types

type Builder 

type Builder struct {
	*Config
	Output io.Writer
}

Builder struct for create handler

func NewBuilder 

func NewBuilder() *Builder

NewBuilder create

func (*Builder) Build 

func (b *Builder) Build() slog.FormattableHandler

Build slog handler.

func (*Builder) With deprecated 

func (b *Builder) With(fns ...ConfigFn) *Builder

With some config fn

Deprecated: please use WithConfigFn()

func (*Builder) WithBuffMode 

func (b *Builder) WithBuffMode(bufMode string) *Builder

WithBuffMode setting

func (*Builder) WithBuffSize 

func (b *Builder) WithBuffSize(bufSize int) *Builder

WithBuffSize setting

func (*Builder) WithCompress 

func (b *Builder) WithCompress(compress bool) *Builder

WithCompress setting

func (*Builder) WithConfigFn 

func (b *Builder) WithConfigFn(fns ...ConfigFn) *Builder

WithConfigFn some config fn

func (*Builder) WithLevelMode 

func (b *Builder) WithLevelMode(mode slog.LevelMode) *Builder

WithLevelMode setting

func (*Builder) WithLogLevel 

func (b *Builder) WithLogLevel(level slog.Level) *Builder

WithLogLevel setting

func (*Builder) WithLogLevels 

func (b *Builder) WithLogLevels(levels []slog.Level) *Builder

WithLogLevels setting

func (*Builder) WithLogfile 

func (b *Builder) WithLogfile(logfile string) *Builder

WithLogfile setting

func (*Builder) WithMaxSize 

func (b *Builder) WithMaxSize(maxSize uint64) *Builder

WithMaxSize setting

func (*Builder) WithOutput 

func (b *Builder) WithOutput(w io.Writer) *Builder

WithOutput to the builder

func (*Builder) WithRotateTime 

func (b *Builder) WithRotateTime(rt rotatefile.RotateTime) *Builder

WithRotateTime setting

func (*Builder) WithUseJSON 

func (b *Builder) WithUseJSON(useJSON bool) *Builder

WithUseJSON setting

type Config 

type Config struct {
	// Logfile for write logs
	Logfile string `json:"logfile" yaml:"logfile"`

	// FilePerm for create log file. default rotatefile.DefaultFilePerm
	FilePerm fs.FileMode `json:"file_perm" yaml:"file_perm"`

	// LevelMode for limit log records. default LevelModeList
	LevelMode slog.LevelMode `json:"level_mode" yaml:"level_mode"`

	// Level max value. valid on LevelMode = LevelModeValue
	Level slog.Level `json:"level" yaml:"level"`

	// Levels list for write. valid on LevelMode = LevelModeList
	Levels []slog.Level `json:"levels" yaml:"levels"`

	// UseJSON for format logs
	UseJSON bool `json:"use_json" yaml:"use_json"`

	// BuffMode type name. allow: line, bite
	BuffMode string `json:"buff_mode" yaml:"buff_mode"`

	// BuffSize for enable buffer, unit is bytes. set 0 to disable buffer
	BuffSize int `json:"buff_size" yaml:"buff_size"`

	// RotateTime for rotate file, unit is seconds.
	RotateTime rotatefile.RotateTime `json:"rotate_time" yaml:"rotate_time"`

	// RotateMode for rotate file by time. default rotatefile.ModeRename
	RotateMode rotatefile.RotateMode `json:"rotate_mode" yaml:"rotate_mode"`

	// MaxSize on rotate file by size, unit is bytes.
	MaxSize uint64 `json:"max_size" yaml:"max_size"`

	// Compress determines if the rotated log files should be compressed using gzip.
	// The default is not to perform compression.
	Compress bool `json:"compress" yaml:"compress"`

	// BackupNum max number for keep old files.
	//
	// 0 is not limit, default is 20.
	BackupNum uint `json:"backup_num" yaml:"backup_num"`

	// BackupTime max time for keep old files, unit is hours.
	//
	// 0 is not limit, default is a week.
	BackupTime uint `json:"backup_time" yaml:"backup_time"`

	// RenameFunc build filename for rotate file
	RenameFunc func(filepath string, rotateNum uint) string

	// DebugMode for debug on development.
	DebugMode bool
}

Config struct

func NewConfig 

func NewConfig(fns ...ConfigFn) *Config

NewConfig new config instance with some default settings.

func NewEmptyConfig 

func NewEmptyConfig(fns ...ConfigFn) *Config

NewEmptyConfig new config instance

func (*Config) CreateHandler 

func (c *Config) CreateHandler() (*SyncCloseHandler, error)

CreateHandler quick create a handler by config

func (*Config) CreateWriter 

func (c *Config) CreateWriter() (output SyncCloseWriter, err error)

CreateWriter build writer by config

func (*Config) RotateWriter 

func (c *Config) RotateWriter() (output SyncCloseWriter, err error)

RotateWriter build rotate writer by config

func (*Config) With 

func (c *Config) With(fns ...ConfigFn) *Config

With more config settings func

func (*Config) WithConfigFn 

func (c *Config) WithConfigFn(fns ...ConfigFn) *Config

WithConfigFn more config settings func

type ConfigFn 

type ConfigFn func(c *Config)

ConfigFn for config some settings

func WithBackupNum 

func WithBackupNum(n uint) ConfigFn

WithBackupNum setting

func WithBackupTime 

func WithBackupTime(bt uint) ConfigFn

WithBackupTime setting

func WithBuffMode 

func WithBuffMode(buffMode string) ConfigFn

WithBuffMode setting

func WithBuffSize 

func WithBuffSize(buffSize int) ConfigFn

WithBuffSize setting

func WithCompress 

func WithCompress(compress bool) ConfigFn

WithCompress setting

func WithFilePerm 

func WithFilePerm(filePerm fs.FileMode) ConfigFn

WithFilePerm setting

func WithLevelMode 

func WithLevelMode(mode slog.LevelMode) ConfigFn

WithLevelMode setting

func WithLevelNames 

func WithLevelNames(names []string) ConfigFn

WithLevelNames set levels by level names.

func WithLogLevel 

func WithLogLevel(level slog.Level) ConfigFn

WithLogLevel setting

func WithLogLevels 

func WithLogLevels(levels slog.Levels) ConfigFn

WithLogLevels setting

func WithLogfile 

func WithLogfile(logfile string) ConfigFn

WithLogfile setting

func WithMaxSize 

func WithMaxSize(maxSize uint64) ConfigFn

WithMaxSize setting

func WithRotateMode 

func WithRotateMode(m rotatefile.RotateMode) ConfigFn

WithRotateMode setting

func WithRotateTime 

func WithRotateTime(rt rotatefile.RotateTime) ConfigFn

WithRotateTime setting

func WithUseJSON 

func WithUseJSON(useJSON bool) ConfigFn

WithUseJSON setting

type ConsoleHandler 

type ConsoleHandler = IOWriterHandler

ConsoleHandler definition

func ConsoleWithLevels 

func ConsoleWithLevels(levels []slog.Level) *ConsoleHandler

ConsoleWithLevels create new ConsoleHandler and with limited log levels

func ConsoleWithMaxLevel 

func ConsoleWithMaxLevel(level slog.Level) *ConsoleHandler

ConsoleWithMaxLevel create new ConsoleHandler and with max log level

func NewConsole 

func NewConsole(levels []slog.Level) *ConsoleHandler

NewConsole create new ConsoleHandler, alias of NewConsoleHandler

func NewConsoleHandler 

func NewConsoleHandler(levels []slog.Level) *ConsoleHandler

NewConsoleHandler create new ConsoleHandler with limited log levels

func NewConsoleWithLF 

func NewConsoleWithLF(lf slog.LevelFormattable) *ConsoleHandler

NewConsoleWithLF create new ConsoleHandler and with custom slog.LevelFormattable

type EmailHandler 

type EmailHandler struct {
	NopFlushClose
	slog.LevelWithFormatter
	// From the sender email information
	From EmailOption
	// ToAddresses email list
	ToAddresses []string
}

EmailHandler struct

func NewEmailHandler 

func NewEmailHandler(from EmailOption, toAddresses []string) *EmailHandler

NewEmailHandler instance

func (*EmailHandler) Handle 

func (h *EmailHandler) Handle(r *slog.Record) error

Handle a log record

type EmailOption 

type EmailOption struct {
	SMTPHost string `json:"smtp_host"` // eg "smtp.gmail.com"
	SMTPPort int    `json:"smtp_port"` // eg 587
	FromAddr string `json:"from_addr"` // eg "yourEmail@gmail.com"
	Password string `json:"password"`
}

EmailOption struct

type FlushCloseHandler 

type FlushCloseHandler struct {
	slog.LevelFormattable
	Output FlushCloseWriter
}

FlushCloseHandler definition

func FlushCloserWithLevels 

func FlushCloserWithLevels(out FlushCloseWriter, levels []slog.Level) *FlushCloseHandler

FlushCloserWithLevels create new FlushCloseHandler, alias of NewFlushCloseHandler()

func FlushCloserWithMaxLevel 

func FlushCloserWithMaxLevel(out FlushCloseWriter, maxLevel slog.Level) *FlushCloseHandler

FlushCloserWithMaxLevel create new FlushCloseHandler, with max log level

func NewBuffered 

func NewBuffered(w io.WriteCloser, bufSize int, levels ...slog.Level) *FlushCloseHandler

NewBuffered create new BufferedHandler

func NewBufferedHandler 

func NewBufferedHandler(w io.WriteCloser, bufSize int, levels ...slog.Level) *FlushCloseHandler

NewBufferedHandler create new BufferedHandler

func NewFlushCloseHandler 

func NewFlushCloseHandler(out FlushCloseWriter, levels []slog.Level) *FlushCloseHandler

NewFlushCloseHandler create new FlushCloseHandler

Usage: 

buf := new(bytes.Buffer)
h := handler.NewFlushCloseHandler(&buf, slog.AllLevels)

f, err := os.OpenFile("my.log", ...)
h := handler.NewFlushCloseHandler(f, slog.AllLevels)

func NewFlushCloser 

func NewFlushCloser(out FlushCloseWriter, levels []slog.Level) *FlushCloseHandler

NewFlushCloser create new FlushCloseHandler, alias of NewFlushCloseHandler()

func NewFlushCloserWithLF 

func NewFlushCloserWithLF(out FlushCloseWriter, lf slog.LevelFormattable) *FlushCloseHandler

NewFlushCloserWithLF create new FlushCloseHandler, with custom slog.LevelFormattable

func (*FlushCloseHandler) Close 

func (h *FlushCloseHandler) Close() error

Close the handler

func (*FlushCloseHandler) Flush 

func (h *FlushCloseHandler) Flush() error

Flush the handler

func (*FlushCloseHandler) Handle 

func (h *FlushCloseHandler) Handle(record *slog.Record) error

Handle log record

type FlushCloseWriter 

type FlushCloseWriter interface {
	Flush() error
	// WriteCloser the output writer
	io.WriteCloser
}

FlushCloseWriter is the interface satisfied by logging destinations.

type FlushWriter 

type FlushWriter interface {
	Flush() error
	// Writer the output writer
	io.Writer
}

FlushWriter is the interface satisfied by logging destinations.

type FormatWriterHandler 

type FormatWriterHandler interface {
	slog.Handler
	// Formatter record formatter
	Formatter() slog.Formatter
	// Writer the output writer
	Writer() io.Writer
}

FormatWriterHandler interface

type IOWriterHandler 

type IOWriterHandler struct {
	NopFlushClose
	slog.LevelFormattable
	Output io.Writer
}

IOWriterHandler definition

func IOWriterWithLevels 

func IOWriterWithLevels(out io.Writer, levels []slog.Level) *IOWriterHandler

IOWriterWithLevels create a new instance and with limited log levels

func IOWriterWithMaxLevel 

func IOWriterWithMaxLevel(out io.Writer, maxLevel slog.Level) *IOWriterHandler

IOWriterWithMaxLevel create new IOWriterHandler, with max log level

Usage: 

	buf := new(bytes.Buffer)
	h := handler.IOWriterWithMaxLevel(buf, slog.InfoLevel)
 slog.AddHandler(h)
	slog.Info("info message")

func NewIOWriter 

func NewIOWriter(out io.Writer, levels []slog.Level) *IOWriterHandler

NewIOWriter create a new instance and with limited log levels

func NewIOWriterHandler 

func NewIOWriterHandler(out io.Writer, levels []slog.Level) *IOWriterHandler

NewIOWriterHandler create new IOWriterHandler

Usage: 

buf := new(bytes.Buffer)
h := handler.NewIOWriterHandler(&buf, slog.AllLevels)

f, err := os.OpenFile("my.log", ...)
h := handler.NewIOWriterHandler(f, slog.AllLevels)

func NewIOWriterWithLF 

func NewIOWriterWithLF(out io.Writer, lf slog.LevelFormattable) *IOWriterHandler

NewIOWriterWithLF create new IOWriterHandler, with custom slog.LevelFormattable

func NewSimpleHandler 

func NewSimpleHandler(out io.Writer, maxLevel slog.Level) *IOWriterHandler

NewSimpleHandler create new SimpleHandler

Usage: 

buf := new(bytes.Buffer)
h := handler.NewSimpleHandler(&buf, slog.InfoLevel)

f, err := os.OpenFile("my.log", ...)
h := handler.NewSimpleHandler(f, slog.InfoLevel)

func SimpleWithLevels 

func SimpleWithLevels(out io.Writer, levels []slog.Level) *IOWriterHandler

SimpleWithLevels create new simple handler, with log levels

func (*IOWriterHandler) Handle 

func (h *IOWriterHandler) Handle(record *slog.Record) error

Handle log record

func (*IOWriterHandler) TextFormatter 

func (h *IOWriterHandler) TextFormatter() *slog.TextFormatter

TextFormatter get the formatter

type LevelWithFormatter deprecated 

type LevelWithFormatter = slog.LevelWithFormatter

LevelWithFormatter struct definition

- support set log formatter - only support set one log level

Deprecated: please use slog.LevelWithFormatter instead.

type LevelsWithFormatter deprecated 

type LevelsWithFormatter = slog.LevelsWithFormatter

LevelsWithFormatter struct definition

- support set log formatter - support setting multi log levels

Deprecated: please use slog.LevelsWithFormatter instead.

type LockWrapper 

type LockWrapper struct {
	sync.Mutex
	// contains filtered or unexported fields
}

LockWrapper struct

func (*LockWrapper) EnableLock 

func (lw *LockWrapper) EnableLock(enable bool)

EnableLock enable lock

func (*LockWrapper) Lock 

func (lw *LockWrapper) Lock()

Lock it

func (*LockWrapper) LockEnabled 

func (lw *LockWrapper) LockEnabled() bool

LockEnabled status

func (*LockWrapper) Unlock 

func (lw *LockWrapper) Unlock()

Unlock it

type NopFlushClose 

type NopFlushClose struct{}

NopFlushClose no operation.

provide empty Flush(), Close() methods, useful for tests.

func (*NopFlushClose) Close 

func (h *NopFlushClose) Close() error

Close handler

func (*NopFlushClose) Flush 

func (h *NopFlushClose) Flush() error

Flush logs to disk

type RotateTime deprecated 

type RotateTime = rotatefile.RotateTime

RotateTime rotate log file by time.

EveryDay:

  • "error.log.20201223"

EveryHour, Every30Minutes, EveryMinute:

  • "error.log.20201223_1500"
  • "error.log.20201223_1530"
  • "error.log.20201223_1523"

Deprecated: please use rotatefile.RotateTime

type SimpleHandler 

type SimpleHandler = IOWriterHandler

SimpleHandler definition. alias of IOWriterHandler

func NewHandler 

func NewHandler(out io.Writer, maxLevel slog.Level) *SimpleHandler

NewHandler create a new instance

func NewSimple 

func NewSimple(out io.Writer, maxLevel slog.Level) *SimpleHandler

NewSimple create a new instance

type SyncCloseHandler 

type SyncCloseHandler struct {
	slog.LevelFormattable
	Output SyncCloseWriter
}

SyncCloseHandler definition

func JSONFileHandler 

func JSONFileHandler(logfile string, fns ...ConfigFn) (*SyncCloseHandler, error)

JSONFileHandler create new FileHandler with JSON formatter

func MustFileHandler 

func MustFileHandler(logfile string, fns ...ConfigFn) *SyncCloseHandler

MustFileHandler create file handler

func MustRotateFile 

func MustRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) *SyncCloseHandler

MustRotateFile handler instance, will panic on create error

func MustSimpleFile 

func MustSimpleFile(filepath string, maxLv ...slog.Level) *SyncCloseHandler

MustSimpleFile new instance

func MustSizeRotateFile 

func MustSizeRotateFile(logfile string, maxSize int, fns ...ConfigFn) *SyncCloseHandler

MustSizeRotateFile instance

func MustTimeRotateFile 

func MustTimeRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) *SyncCloseHandler

MustTimeRotateFile instance

func NewBuffFileHandler 

func NewBuffFileHandler(logfile string, buffSize int, fns ...ConfigFn) (*SyncCloseHandler, error)

NewBuffFileHandler create file handler with buff size

func NewFileHandler 

func NewFileHandler(logfile string, fns ...ConfigFn) (h *SyncCloseHandler, err error)

NewFileHandler create new FileHandler

func NewRotateFile 

func NewRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)

NewRotateFile instance. alias of NewRotateFileHandler()

func NewRotateFileHandler 

func NewRotateFileHandler(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)

NewRotateFileHandler instance. It supports splitting log files by time and size

func NewSimpleFile 

func NewSimpleFile(filepath string, maxLv ...slog.Level) (*SyncCloseHandler, error)

NewSimpleFile new instance

func NewSimpleFileHandler 

func NewSimpleFileHandler(filePath string, maxLv ...slog.Level) (*SyncCloseHandler, error)

NewSimpleFileHandler instance, default log level is InfoLevel

Usage: 

h, err := NewSimpleFileHandler("/tmp/error.log")

Custom formatter: 

h.SetFormatter(slog.NewJSONFormatter())
slog.PushHandler(h)
slog.Info("log message")

func NewSizeRotateFile 

func NewSizeRotateFile(logfile string, maxSize int, fns ...ConfigFn) (*SyncCloseHandler, error)

NewSizeRotateFile instance

func NewSizeRotateFileHandler 

func NewSizeRotateFileHandler(logfile string, maxSize int, fns ...ConfigFn) (*SyncCloseHandler, error)

NewSizeRotateFileHandler instance, default close rotate by time.

func NewSyncCloseHandler 

func NewSyncCloseHandler(out SyncCloseWriter, levels []slog.Level) *SyncCloseHandler

NewSyncCloseHandler create new SyncCloseHandler with limited log levels

Usage: 

f, err := os.OpenFile("my.log", ...)
h := handler.NewSyncCloseHandler(f, slog.AllLevels)

func NewSyncCloser 

func NewSyncCloser(out SyncCloseWriter, levels []slog.Level) *SyncCloseHandler

NewSyncCloser create new SyncCloseHandler, alias of NewSyncCloseHandler()

func NewSyncCloserWithLF 

func NewSyncCloserWithLF(out SyncCloseWriter, lf slog.LevelFormattable) *SyncCloseHandler

NewSyncCloserWithLF create new SyncCloseHandler, with custom slog.LevelFormattable

func NewTimeRotateFile 

func NewTimeRotateFile(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)

NewTimeRotateFile instance

func NewTimeRotateFileHandler 

func NewTimeRotateFileHandler(logfile string, rt rotatefile.RotateTime, fns ...ConfigFn) (*SyncCloseHandler, error)

NewTimeRotateFileHandler instance, default close rotate by size

func SyncCloserWithLevels 

func SyncCloserWithLevels(out SyncCloseWriter, levels []slog.Level) *SyncCloseHandler

SyncCloserWithLevels create new SyncCloseHandler, alias of NewSyncCloseHandler()

func SyncCloserWithMaxLevel 

func SyncCloserWithMaxLevel(out SyncCloseWriter, maxLevel slog.Level) *SyncCloseHandler

SyncCloserWithMaxLevel create new SyncCloseHandler, with max log level

func (*SyncCloseHandler) Close 

func (h *SyncCloseHandler) Close() error

Close the handler

func (*SyncCloseHandler) Flush 

func (h *SyncCloseHandler) Flush() error

Flush the handler

func (*SyncCloseHandler) Handle 

func (h *SyncCloseHandler) Handle(record *slog.Record) error

Handle log record

func (*SyncCloseHandler) Writer 

func (h *SyncCloseHandler) Writer() io.Writer

Writer of the handler

type SyncCloseWriter 

type SyncCloseWriter interface {
	Sync() error
	// WriteCloser the output writer
	io.WriteCloser
}

SyncCloseWriter is the interface satisfied by logging destinations. such as os.File

type SysLogHandler 

type SysLogHandler struct {
	slog.LevelWithFormatter
	// contains filtered or unexported fields
}

SysLogHandler struct

func NewSysLog 

func NewSysLog(opt *SysLogOpt) (*SysLogHandler, error)

NewSysLog handler instance with all custom options.

func NewSysLogHandler 

func NewSysLogHandler(priority syslog.Priority, tag string) (*SysLogHandler, error)

NewSysLogHandler instance

func (*SysLogHandler) Close 

func (h *SysLogHandler) Close() error

Close handler

func (*SysLogHandler) Flush 

func (h *SysLogHandler) Flush() error

Flush handler

func (*SysLogHandler) Handle 

func (h *SysLogHandler) Handle(record *slog.Record) error

Handle a log record

type SysLogOpt 

type SysLogOpt struct {
	// Tag syslog tag
	Tag string
	// Priority syslog priority
	Priority syslog.Priority
	// Network syslog network
	Network string
	// Raddr syslog address
	Raddr string
}

SysLogOpt for syslog handler

type WriteCloserHandler 

type WriteCloserHandler struct {
	slog.LevelFormattable
	Output io.WriteCloser
}

WriteCloserHandler definition

func NewWriteCloser 

func NewWriteCloser(out io.WriteCloser, levels []slog.Level) *WriteCloserHandler

NewWriteCloser create a new instance

func NewWriteCloserHandler 

func NewWriteCloserHandler(out io.WriteCloser, levels []slog.Level) *WriteCloserHandler

NewWriteCloserHandler create new WriteCloserHandler

Usage: 

buf := new(bytes.Buffer)
h := handler.NewIOWriteCloserHandler(&buf, slog.AllLevels)

f, err := os.OpenFile("my.log", ...)
h := handler.NewIOWriteCloserHandler(f, slog.AllLevels)

func NewWriteCloserWithLF 

func NewWriteCloserWithLF(out io.WriteCloser, lf slog.LevelFormattable) *WriteCloserHandler

NewWriteCloserWithLF create new WriteCloserHandler and with custom slog.LevelFormattable

func WriteCloserWithLevels 

func WriteCloserWithLevels(out io.WriteCloser, levels []slog.Level) *WriteCloserHandler

WriteCloserWithLevels create a new instance and with limited log levels

func WriteCloserWithMaxLevel 

func WriteCloserWithMaxLevel(out io.WriteCloser, maxLevel slog.Level) *WriteCloserHandler

WriteCloserWithMaxLevel create new WriteCloserHandler and with max log level

func (*WriteCloserHandler) Close 

func (h *WriteCloserHandler) Close() error

Close the handler

func (*WriteCloserHandler) Flush 

func (h *WriteCloserHandler) Flush() error

Flush the handler

func (*WriteCloserHandler) Handle 

func (h *WriteCloserHandler) Handle(record *slog.Record) error

Handle log record

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.