hlog

Documentation

Index

• Constants
• func CtxDebugf(ctx context.Context, format string, v ...interface{})
• func CtxErrorf(ctx context.Context, format string, v ...interface{})
• func CtxFatalf(ctx context.Context, format string, v ...interface{})
• func CtxInfof(ctx context.Context, format string, v ...interface{})
• func CtxNoticef(ctx context.Context, format string, v ...interface{})
• func CtxTracef(ctx context.Context, format string, v ...interface{})
• func CtxWarnf(ctx context.Context, format string, v ...interface{})
• func Debug(v ...interface{})
• func Debugf(format string, v ...interface{})
• func Error(v ...interface{})
• func Errorf(format string, v ...interface{})
• func Fatal(v ...interface{})
• func Fatalf(format string, v ...interface{})
• func Info(v ...interface{})
• func Infof(format string, v ...interface{})
• func Notice(v ...interface{})
• func Noticef(format string, v ...interface{})
• func SetLevel(lv Level)
• func SetLogger(v FullLogger)
• func SetOutput(w io.Writer)
• func SetSilentMode(s bool)
• func SetSystemLogger(v FullLogger)
• func Trace(v ...interface{})
• func Tracef(format string, v ...interface{})
• func Warn(v ...interface{})
• func Warnf(format string, v ...interface{})
• type Control
• type CtxLogger
• type FormatLogger
• type FullLogger
  • func DefaultLogger() FullLogger
  • func SystemLogger() FullLogger
• type Level
• type Logger

Constants

const (
	EngineErrorFormat = "Error=%s, remoteAddr=%s"
)

Functions

func CtxDebugf

func CtxDebugf(ctx context.Context, format string, v ...interface{})

CtxDebugf calls the default logger's CtxDebugf method.

func CtxErrorf

func CtxErrorf(ctx context.Context, format string, v ...interface{})

CtxErrorf calls the default logger's CtxErrorf method.

func CtxFatalf

func CtxFatalf(ctx context.Context, format string, v ...interface{})

CtxFatalf calls the default logger's CtxFatalf method and then os.Exit(1).

func CtxInfof

func CtxInfof(ctx context.Context, format string, v ...interface{})

CtxInfof calls the default logger's CtxInfof method.

func CtxNoticef

func CtxNoticef(ctx context.Context, format string, v ...interface{})

CtxNoticef calls the default logger's CtxNoticef method.

func CtxTracef

func CtxTracef(ctx context.Context, format string, v ...interface{})

CtxTracef calls the default logger's CtxTracef method.

func CtxWarnf

func CtxWarnf(ctx context.Context, format string, v ...interface{})

CtxWarnf calls the default logger's CtxWarnf method.

func Debug

func Debug(v ...interface{})

Debug calls the default logger's Debug method.

func Debugf

func Debugf(format string, v ...interface{})

Debugf calls the default logger's Debugf method.

func Error

func Error(v ...interface{})

Error calls the default logger's Error method.

func Errorf

func Errorf(format string, v ...interface{})

Errorf calls the default logger's Errorf method.

func Fatal

func Fatal(v ...interface{})

Fatal calls the default logger's Fatal method and then os.Exit(1).

func Fatalf

func Fatalf(format string, v ...interface{})

Fatalf calls the default logger's Fatalf method and then os.Exit(1).

func Info

func Info(v ...interface{})

Info calls the default logger's Info method.

func Infof

func Infof(format string, v ...interface{})

Infof calls the default logger's Infof method.

func Notice

func Notice(v ...interface{})

Notice calls the default logger's Notice method.

func Noticef

func Noticef(format string, v ...interface{})

Noticef calls the default logger's Noticef method.

func SetLevel

func SetLevel(lv Level)

SetLevel sets the level of logs below which logs will not be output. The default logger and system logger level is LevelTrace. Note that this method is not concurrent-safe.

func SetLogger

func SetLogger(v FullLogger)

SetLogger sets the default logger and the system logger. Note that this method is not concurrent-safe and must not be called after the use of DefaultLogger and global functions in this package.

func SetOutput

func SetOutput(w io.Writer)

SetOutput sets the output of default logger and system logger. By default, it is stderr.

func SetSilentMode

func SetSilentMode(s bool)

SetSilentMode is used to mute engine error log, for example: error when reading request headers. If true, hertz engine will mute it.

func SetSystemLogger

func SetSystemLogger(v FullLogger)

SetSystemLogger sets the system logger. Note that this method is not concurrent-safe and must not be called This function is not recommended for users to use.

func Trace

func Trace(v ...interface{})

Trace calls the default logger's Trace method.

func Tracef

func Tracef(format string, v ...interface{})

Tracef calls the default logger's Tracef method.

func Warn

func Warn(v ...interface{})

Warn calls the default logger's Warn method.

func Warnf

func Warnf(format string, v ...interface{})

Warnf calls the default logger's Warnf method.

Types

type Control

type Control interface {
	SetLevel(Level)
	SetOutput(io.Writer)
}

Control provides methods to config a logger.

type CtxLogger

type CtxLogger interface {
	CtxTracef(ctx context.Context, format string, v ...interface{})
	CtxDebugf(ctx context.Context, format string, v ...interface{})
	CtxInfof(ctx context.Context, format string, v ...interface{})
	CtxNoticef(ctx context.Context, format string, v ...interface{})
	CtxWarnf(ctx context.Context, format string, v ...interface{})
	CtxErrorf(ctx context.Context, format string, v ...interface{})
	CtxFatalf(ctx context.Context, format string, v ...interface{})
}

CtxLogger is a logger interface that accepts a context argument and output logs with a format.

type FormatLogger

type FormatLogger interface {
	Tracef(format string, v ...interface{})
	Debugf(format string, v ...interface{})
	Infof(format string, v ...interface{})
	Noticef(format string, v ...interface{})
	Warnf(format string, v ...interface{})
	Errorf(format string, v ...interface{})
	Fatalf(format string, v ...interface{})
}

FormatLogger is a logger interface that output logs with a format.

type FullLogger

type FullLogger interface {
	Logger
	FormatLogger
	CtxLogger
	Control
}

FullLogger is the combination of Logger, FormatLogger, CtxLogger and Control.

func DefaultLogger

func DefaultLogger() FullLogger

DefaultLogger return the default logger for hertz.

func SystemLogger

func SystemLogger() FullLogger

SystemLogger return the system logger for hertz to print system log. This function is not recommended for users to use.

type Level

type Level int

Level defines the priority of a log message. When a logger is configured with a level, any log message with a lower log level (smaller by integer comparison) will not be output.

const (
	LevelTrace Level = iota
	LevelDebug
	LevelInfo
	LevelNotice
	LevelWarn
	LevelError
	LevelFatal
)

The levels of logs.

type Logger

type Logger interface {
	Trace(v ...interface{})
	Debug(v ...interface{})
	Info(v ...interface{})
	Notice(v ...interface{})
	Warn(v ...interface{})
	Error(v ...interface{})
	Fatal(v ...interface{})
}

Logger is a logger interface that provides logging function with levels.