package log
import "log"
Package log 实现了一个简单的日志记录包。它定义了一个类型 Logger, 该类型带有用于格式化输出的方法。它还通过辅助函数 Print[f|ln]、Fatal[f|ln] 和 Panic[f|ln] 提供了一个预定义的“标准” Logger,这些函数比手动创建 Logger 更易于使用。 该 logger 写入标准错误,并打印每条日志消息的 日期和时间。 每条日志消息输出在单独的一行:如果正在打印的消息 不以换行符结尾,logger 会添加一个。 Fatal 系列函数在写入日志消息后调用 os.Exit(1)。 Panic 系列函数在写入日志消息后调用 panic。
Index
- Constants
- func Fatal(v ...any)
- func Fatalf(format string, v ...any)
- func Fatalln(v ...any)
- func Flags() int
- func Output(calldepth int, s string) error
- func Panic(v ...any)
- func Panicf(format string, v ...any)
- func Panicln(v ...any)
- func Prefix() string
- func Print(v ...any)
- func Printf(format string, v ...any)
- func Println(v ...any)
- func SetFlags(flag int)
- func SetOutput(w io.Writer)
- func SetPrefix(prefix string)
- func Writer() io.Writer
-
type Logger
- func Default() *Logger
- func New(out io.Writer, prefix string, flag int) *Logger
- func (l *Logger) Fatal(v ...any)
- func (l *Logger) Fatalf(format string, v ...any)
- func (l *Logger) Fatalln(v ...any)
- func (l *Logger) Flags() int
- func (l *Logger) Output(calldepth int, s string) error
- func (l *Logger) Panic(v ...any)
- func (l *Logger) Panicf(format string, v ...any)
- func (l *Logger) Panicln(v ...any)
- func (l *Logger) Prefix() string
- func (l *Logger) Print(v ...any)
- func (l *Logger) Printf(format string, v ...any)
- func (l *Logger) Println(v ...any)
- func (l *Logger) SetFlags(flag int)
- func (l *Logger) SetOutput(w io.Writer)
- func (l *Logger) SetPrefix(prefix string)
- func (l *Logger) Writer() io.Writer
Examples
Constants
const ( Ldate = 1 << iota // 本地时区的日期:2009/01/23 Ltime // 本地时区的时间:01:23:23 Lmicroseconds // 微秒级分辨率:01:23:23.123123。假定已设置 Ltime。 Llongfile // 完整文件名和行号:/a/b/c/d.go:23 Lshortfile // 文件名最后一项和行号:d.go:23。会覆盖 Llongfile LUTC // 如果设置了 Ldate 或 Ltime,则使用 UTC 而非本地时区 Lmsgprefix // 将“prefix”从行首移到消息之前 LstdFlags = Ldate | Ltime // 标准 logger 的初始值 )
这些标志(flag)定义 Logger 生成的每条日志条目要添加什么前缀文本。 各位通过按位或组合在一起,以控制打印的内容。 除 Lmsgprefix 标志外,无法控制它们出现的顺序(即此处列出的顺序) 或它们呈现的格式(如注释中所述)。 仅当指定了 Llongfile 或 Lshortfile 时,前缀后才会跟一个冒号。 例如,标志 Ldate | Ltime(或 LstdFlags)产生:
2009/01/23 01:23:23 message
而标志 Ldate | Ltime | Lmicroseconds | Llongfile 产生:
2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
Functions
func Fatal
func Fatal(v ...any)
Fatal 等价于 Print 后接一次 os.Exit(1) 调用。
func Fatalf
func Fatalf(format string, v ...any)
Fatalf 等价于 Printf 后接一次 os.Exit(1) 调用。
func Fatalln
func Fatalln(v ...any)
Fatalln 等价于 Println 后接一次 os.Exit(1) 调用。
func Flags
func Flags() int
Flags 返回标准 logger 的输出标志。 标志位包括 Ldate、Ltime 等。
func Output
func Output(calldepth int, s string) error
Output 为一次日志事件写入输出。字符串 s 包含要打印在 Logger 各标志所指定前缀之后的文本。 如果 s 的最后一个字符不是换行符,则追加一个换行符。 当设置了 Llongfile 或 Lshortfile 时,Calldepth 是 在计算文件名和行号时要跳过的帧数; 值为 1 时将打印 Output 调用者的详细信息。
func Panic
func Panic(v ...any)
Panic 等价于 Print 后接一次 panic() 调用。
func Panicf
func Panicf(format string, v ...any)
Panicf 等价于 Printf 后接一次 panic() 调用。
func Panicln
func Panicln(v ...any)
Panicln 等价于 Println 后接一次 panic() 调用。
func Prefix
func Prefix() string
Prefix 返回标准 logger 的输出前缀。
func Print
func Print(v ...any)
Print 调用 Output 输出到标准 logger。 参数的处理方式与 fmt.Print 相同。
func Printf
func Printf(format string, v ...any)
Printf 调用 Output 输出到标准 logger。 参数的处理方式与 fmt.Printf 相同。
func Println
func Println(v ...any)
Println 调用 Output 输出到标准 logger。 参数的处理方式与 fmt.Println 相同。
func SetFlags
func SetFlags(flag int)
SetFlags 设置标准 logger 的输出标志。 标志位包括 Ldate、Ltime 等。
func SetOutput
func SetOutput(w io.Writer)
SetOutput 设置标准 logger 的输出目标。
func SetPrefix
func SetPrefix(prefix string)
SetPrefix 设置标准 logger 的输出前缀。
func Writer
func Writer() io.Writer
Writer 返回标准 logger 的输出目标。
Types
type Logger
type Logger struct { // contains filtered or unexported fields }
Logger 表示一个活动的日志记录对象,它向 io.Writer 生成若干行输出。
每次日志记录操作都会对 Writer 的 Write 方法进行一次调用。
一个 Logger 可同时被多个 goroutine 使用;
它保证对 Writer 的访问是串行化的。
Output:Example
package main
import (
"bytes"
"fmt"
"log"
)
func main() {
var (
buf bytes.Buffer
logger = log.New(&buf, "logger: ", log.Lshortfile)
)
logger.Print("Hello, log file!")
fmt.Print(&buf)
}
logger: example_test.go:19: Hello, log file!
func Default
func Default() *Logger
Default 返回包级输出函数所用的标准 logger。
func New
func New(out io.Writer, prefix string, flag int) *Logger
New 创建一个新的 Logger。变量 out 设置日志数据 将写入的目标。 prefix 出现在生成的每条日志行的开头,或者 如果提供了 Lmsgprefix 标志,则出现在日志头部之后。 flag 参数定义日志记录属性。
func (*Logger) Fatal
func (l *Logger) Fatal(v ...any)
Fatal 等价于 l.Print() 后接一次 os.Exit(1) 调用。
func (*Logger) Fatalf
func (l *Logger) Fatalf(format string, v ...any)
Fatalf 等价于 l.Printf() 后接一次 os.Exit(1) 调用。
func (*Logger) Fatalln
func (l *Logger) Fatalln(v ...any)
Fatalln 等价于 l.Println() 后接一次 os.Exit(1) 调用。
func (*Logger) Flags
func (l *Logger) Flags() int
Flags 返回 logger 的输出标志。 标志位包括 Ldate、Ltime 等。
func (*Logger) Output
func (l *Logger) Output(calldepth int, s string) error
Output 为一次日志事件写入输出。字符串 s 包含要打印在
Logger 各标志所指定前缀之后的文本。
如果 s 的最后一个字符不是换行符,则追加一个换行符。
Calldepth 用于恢复 PC,提供它是出于通用性考虑,
尽管目前在所有预定义路径上它都是 2。
Output:Example
package main
import (
"bytes"
"fmt"
"log"
)
func main() {
var (
buf bytes.Buffer
logger = log.New(&buf, "INFO: ", log.Lshortfile)
infof = func(info string) {
logger.Output(2, info)
}
)
infof("Hello world")
fmt.Print(&buf)
}
INFO: example_test.go:36: Hello world
func (*Logger) Panic
func (l *Logger) Panic(v ...any)
Panic 等价于 l.Print() 后接一次 panic() 调用。
func (*Logger) Panicf
func (l *Logger) Panicf(format string, v ...any)
Panicf 等价于 l.Printf() 后接一次 panic() 调用。
func (*Logger) Panicln
func (l *Logger) Panicln(v ...any)
Panicln 等价于 l.Println() 后接一次 panic() 调用。
func (*Logger) Prefix
func (l *Logger) Prefix() string
Prefix 返回 logger 的输出前缀。
func (*Logger) Print
func (l *Logger) Print(v ...any)
Print 调用 l.Output 输出到 logger。 参数的处理方式与 fmt.Print 相同。
func (*Logger) Printf
func (l *Logger) Printf(format string, v ...any)
Printf 调用 l.Output 输出到 logger。 参数的处理方式与 fmt.Printf 相同。
func (*Logger) Println
func (l *Logger) Println(v ...any)
Println 调用 l.Output 输出到 logger。 参数的处理方式与 fmt.Println 相同。
func (*Logger) SetFlags
func (l *Logger) SetFlags(flag int)
SetFlags 设置 logger 的输出标志。 标志位包括 Ldate、Ltime 等。
func (*Logger) SetOutput
func (l *Logger) SetOutput(w io.Writer)
SetOutput 设置 logger 的输出目标。
func (*Logger) SetPrefix
func (l *Logger) SetPrefix(prefix string)
SetPrefix 设置 logger 的输出前缀。
func (*Logger) Writer
func (l *Logger) Writer() io.Writer
Writer 返回 logger 的输出目标。
Directories
| slog | Package slog 提供结构化日志, 其中日志记录包含一条消息、 一个严重级别,以及以键值对形式 表达的各种其他属性。 |
| syslog | Package syslog 为系统日志服务提供了一个简单的接口。 |