logger

Documentation

Index

• Constants
• func SetGlobalLogger(logger *Logger)
• type LogLevel
  • func LogLevelFromString(level string) LogLevel
  • func (l LogLevel) String() string
• type Logger
  • func GetLogger() *Logger
  • func NewLogger(level LogLevel, prefix string) *Logger
  • func (l *Logger) Close() error
  • func (l *Logger) Debug(format string, args ...interface{})
  • func (l *Logger) DisableFileLogging() error
  • func (l *Logger) EnableFileLogging(logPath string) error
  • func (l *Logger) Error(format string, args ...interface{})
  • func (l *Logger) GetLevel() LogLevel
  • func (l *Logger) Info(format string, args ...interface{})
  • func (l *Logger) Rotate() error
  • func (l *Logger) SetLevel(level LogLevel)
  • func (l *Logger) SetMaxFiles(count int)
  • func (l *Logger) SetMaxSize(size int64)
  • func (l *Logger) Success(format string, args ...interface{})
  • func (l *Logger) Tip(format string, args ...interface{})
  • func (l *Logger) Warning(format string, args ...interface{})

Constants

const (
	// DefaultLogDir 默认日志目录
	DefaultLogDir = "~/.sshx"
	// DefaultLogFile 默认日志文件名
	DefaultLogFile = "sshx.log"
	// DefaultMaxFiles 默认保留的日志文件数量
	DefaultMaxFiles = 3
	// DefaultMaxSize 默认单个日志文件最大大小（10MB）
	DefaultMaxSize = 10 * 1024 * 1024
)

Functions

func SetGlobalLogger

func SetGlobalLogger(logger *Logger)

SetGlobalLogger 设置全局日志记录器

Types

type LogLevel

type LogLevel int

LogLevel 定义日志级别

const (
	// LogLevelDebug 调试级别
	LogLevelDebug LogLevel = iota
	// LogLevelInfo 信息级别
	LogLevelInfo
	// LogLevelWarning 警告级别
	LogLevelWarning
	// LogLevelError 错误级别
	LogLevelError
)

func LogLevelFromString

func LogLevelFromString(level string) LogLevel

LogLevelFromString 从字符串解析日志级别

func (LogLevel) String

func (l LogLevel) String() string

String 返回日志级别的字符串表示

type Logger

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

Logger 统一的日志记录器

func GetLogger

func GetLogger() *Logger

GetLogger 获取全局日志记录器

func NewLogger

func NewLogger(level LogLevel, prefix string) *Logger

NewLogger 创建新的日志记录器 level: 日志级别 prefix: 日志前缀

func (*Logger) Close

func (l *Logger) Close() error

Close 关闭日志记录器

func (*Logger) Debug

func (l *Logger) Debug(format string, args ...interface{})

Debug 记录调试信息

func (*Logger) DisableFileLogging

func (l *Logger) DisableFileLogging() error

DisableFileLogging 禁用文件日志

func (*Logger) EnableFileLogging

func (l *Logger) EnableFileLogging(logPath string) error

EnableFileLogging 启用文件日志 logPath: 日志文件路径，如果为空则使用默认路径 ~/.sshx/sshx.log

func (*Logger) Error

func (l *Logger) Error(format string, args ...interface{})

Error 记录错误信息

func (*Logger) GetLevel

func (l *Logger) GetLevel() LogLevel

GetLevel 获取当前日志级别

func (*Logger) Info

func (l *Logger) Info(format string, args ...interface{})

Info 记录普通信息

func (*Logger) Rotate

func (l *Logger) Rotate() error

Rotate 手动轮换日志文件

func (*Logger) SetLevel

func (l *Logger) SetLevel(level LogLevel)

SetLevel 设置日志级别

func (*Logger) SetMaxFiles

func (l *Logger) SetMaxFiles(count int)

SetMaxFiles 设置最大文件数量

func (*Logger) SetMaxSize

func (l *Logger) SetMaxSize(size int64)

SetMaxSize 设置最大文件大小

func (*Logger) Success

func (l *Logger) Success(format string, args ...interface{})

Success 记录成功信息（带 ✓ 标记）

func (*Logger) Tip

func (l *Logger) Tip(format string, args ...interface{})

Tip 记录提示信息（带 💡 标记）

func (*Logger) Warning

func (l *Logger) Warning(format string, args ...interface{})

Warning 记录警告信息