lager

Documentation

Overview

Package lager is the package for lager

Index

• Constants
• Variables
• func CopyFile(srcFile, dstFile string) error
• func EscapPath(msg string) string
• func FilterFileList(path, pat string) ([]string, error)
• func Init(option *Options)
• func LogRotate(path string, MaxFileSize int, MaxBackupCount int)
• func NewLog(option *Options) (lager.Logger, error)
• type Options
• type RotateConfig
  • func NewRotateConfig(option *Options) *RotateConfig

Constants

const (
	LogRotateDate     = 1
	LogRotateSize     = 10
	LogBackupCount    = 7
	RollingPolicySize = "size"
)

constant values for logrotate parameters

const (
	LevelDebug = "DEBUG"
	LevelInfo  = "INFO"
	LevelWarn  = "WARN"
	LevelError = "ERROR"
	LevelFatal = "FATAL"
)

log level

const (
	Stdout = "stdout"
	Stderr = "stderr"
	File   = "file"
)

output type

Variables

var Logger lager.Logger

Logger is the global variable for the object of lager.Logger Deprecated. plz use openlogging instead

var Rotators = &rotators{
	logFilePaths: make(map[string]*RotateConfig, 5),
}

Rotators global rotate instance

Functions

func CopyFile

func CopyFile(srcFile, dstFile string) error

CopyFile copy file

func EscapPath

func EscapPath(msg string) string

EscapPath escape path

func FilterFileList

func FilterFileList(path, pat string) ([]string, error)

FilterFileList function for filter file list path : where the file will be filtered pat : regexp pattern to filter the matched file

func Init

func Init(option *Options)

Init Build constructs a *Lager.Logger with the configured parameters.

func LogRotate

func LogRotate(path string, MaxFileSize int, MaxBackupCount int)

LogRotate function for log rotate path: where log files need rollover MaxFileSize: MaxSize of a file before rotate. By M Bytes. MaxBackupCount: Max counts to keep of a log's backup files.

func NewLog

func NewLog(option *Options) (lager.Logger, error)

NewLog returns a logger

Types

type Options

type Options struct {
	Writers        string `yaml:"writers"`
	LoggerLevel    string `yaml:"logger_level"`
	LoggerFile     string `yaml:"logger_file"`
	LogFormatText  bool   `yaml:"log_format_text"`
	RollingPolicy  string `yaml:"rollingPolicy"`
	LogRotateDate  int    `yaml:"log_rotate_date"`
	LogRotateSize  int    `yaml:"log_rotate_size"`
	LogBackupCount int    `yaml:"log_backup_count"`

	AccessLogFile string `yaml:"access_log_file"`
}

Options is the struct for lager information(lager.yaml)

type RotateConfig

type RotateConfig struct {
	Policy      string
	Size        int
	BackupCount int
	CheckCycle  time.Duration

	RotateDate int
	// contains filtered or unexported fields
}

RotateConfig rotate config

func NewRotateConfig

func NewRotateConfig(option *Options) *RotateConfig

NewRotateConfig return config