flogging

package
v0.0.0-...-fbe82ab Latest Latest
Warning

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

Go to latest
Published: Mar 16, 2019 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CONSOLE = iota
	JSON
)
View Source
const (
	//DisabledLevel表示已禁用的日志级别。此级别的日志应
	//永远不要排放。
	DisabledLevel = zapcore.Level(math.MinInt8)

	//payloadLevel用于记录非常详细的消息级别调试
	//信息。
	PayloadLevel = zapcore.Level(zapcore.DebugLevel - 1)
)

Variables

This section is empty.

Functions

func ActivateSpec

func ActivateSpec(spec string)

activatespec用于激活日志规范。

func DefaultLevel

func DefaultLevel() string

DefaultLevel返回分析失败时记录器使用的回退值。

func GetLoggerLevel

func GetLoggerLevel(loggerName string) string

GetLoggerLevel获取具有 提供名称。

func Init

func Init(config Config)

func InitBackend

func InitBackend(formatter logging.Formatter, output io.Writer)

initbackend根据设置日志后端 提供的日志格式化程序和I/O编写器。

func InitFromSpec

func InitFromSpec(spec string) string

initfromspec根据提供的规范初始化日志。它是 暴露在外部,以便flogging包的使用者可以分析 自己的日志规范。日志规范的格式如下: [<logger>[,<logger>…]=]<level>[:[<logger>[,<logger>…]=]<logger>…]

func IsValidLevel

func IsValidLevel(level string) bool

func NameToLevel

func NameToLevel(level string) zapcore.Level

nametoLevel将级别名称转换为zapcore.level。如果级别名称为 未知,返回zapcore.infoLevel。

func NewGRPCLogger

func NewGRPCLogger(l *zap.Logger) *zapgrpc.Logger

newgrpclogger创建委托给zap.logger的grpc.logger。

func NewZapLogger

func NewZapLogger(core zapcore.Core, options ...zap.Option) *zap.Logger

new zap logger围绕一个新的zap.core创建一个zap记录器。核心将使用 提供的编码器和接收器以及与 提供的记录器名称。返回的记录器将被命名为相同的 作为记录器。

func Reset

func Reset()

重置将日志记录设置为此包中定义的默认值。

在测试和包初始化中使用

func SetFormat

func SetFormat(formatSpec string) logging.Formatter

setformat设置日志记录格式。

Types

type Config

type Config struct {
	//格式是日志记录实例的日志记录格式说明符。如果
	//spec是字符串“json”,日志记录将格式化为json。任何
	//其他字符串将提供给格式化编码器。请看
	//fabenc.parseformat获取有关支持的谓词的详细信息。
	//
	//如果未提供格式,则提供基本信息的默认格式将
	//被使用。
	Format string

	//logspec确定为日志系统启用的日志级别。这个
	//规范必须采用可由ActivateSpec处理的格式。
	//
	//如果未提供logspec,将在信息级别启用记录器。
	LogSpec string

	//Writer是编码和格式化日志记录的接收器。
	//
	//如果未提供写入程序,则将使用os.stderr作为日志接收器。
	Writer io.Writer
}

config用于提供日志记录实例的依赖项。

type Core

type Core struct {
	zapcore.LevelEnabler
	Levels   *LoggerLevels
	Encoders map[Encoding]zapcore.Encoder
	Selector EncodingSelector
	Output   zapcore.WriteSyncer
	Observer Observer
}

core是zapcore.core的自定义实现。这是一个可怕的黑客 只存在于与 编码器、隐藏在zapcore中的实现以及隐式的即席记录器 在结构中初始化。

除了将日志条目和字段编码到缓冲区之外,zap编码器 实现还需要维护字段状态。当zapcore.core.with为 使用时,将克隆关联的编码器并将字段添加到 编码器。这意味着编码器实例不能跨核心共享。

在实现隐藏方面,我们的FormatEncoder很难 将Zap中的JSON和控制台实现作为所有方法进行干净包装 需要从zapcore.objectEncoder实现委托给 正确的后端。

此实现通过将多个编码器与一个核心关联来工作。什么时候? 字段添加到核心,字段添加到所有编码器 实施。核心还引用日志配置 确定要使用的正确编码、要委托的编写器和 启用级别。

func (*Core) Check

func (*Core) Sync

func (c *Core) Sync() error

func (*Core) With

func (c *Core) With(fields []zapcore.Field) zapcore.Core

func (*Core) Write

func (c *Core) Write(e zapcore.Entry, fields []zapcore.Field) error

type Encoding

type Encoding int8

type EncodingSelector

type EncodingSelector interface {
	Encoding() Encoding
}

encodingselector用于确定日志记录是否 编码为JSON或人类可读的控制台格式。

type FabricLogger

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

FabricLogger是围绕zap.sugaredLogger的适配器,它提供

行为。

FabricLogger和 zap.sugaredlogger是没有格式后缀(f或w)构建的方法 使用fmt.sprintln而不是fmt.sprint的日志条目消息。没有这个 更改,参数不由空格分隔。

func MustGetLogger

func MustGetLogger(loggerName string) *FabricLogger

MustGetLogger创建具有指定名称的记录器。如果名称无效 如有提供,操作会恐慌。

func NewFabricLogger

func NewFabricLogger(l *zap.Logger, options ...zap.Option) *FabricLogger

newFabricLogger创建一个委托给zap.sugaredLogger的记录器。

func (*FabricLogger) Critical

func (f *FabricLogger) Critical(args ...interface{})

为了向后兼容

func (*FabricLogger) Criticalf

func (f *FabricLogger) Criticalf(template string, args ...interface{})

func (*FabricLogger) DPanic

func (f *FabricLogger) DPanic(args ...interface{})

func (*FabricLogger) DPanicf

func (f *FabricLogger) DPanicf(template string, args ...interface{})

func (*FabricLogger) DPanicw

func (f *FabricLogger) DPanicw(msg string, kvPairs ...interface{})

func (*FabricLogger) Debug

func (f *FabricLogger) Debug(args ...interface{})

func (*FabricLogger) Debugf

func (f *FabricLogger) Debugf(template string, args ...interface{})

func (*FabricLogger) Debugw

func (f *FabricLogger) Debugw(msg string, kvPairs ...interface{})

func (*FabricLogger) Error

func (f *FabricLogger) Error(args ...interface{})

func (*FabricLogger) Errorf

func (f *FabricLogger) Errorf(template string, args ...interface{})

func (*FabricLogger) Errorw

func (f *FabricLogger) Errorw(msg string, kvPairs ...interface{})

func (*FabricLogger) Fatal

func (f *FabricLogger) Fatal(args ...interface{})

func (*FabricLogger) Fatalf

func (f *FabricLogger) Fatalf(template string, args ...interface{})

func (*FabricLogger) Fatalw

func (f *FabricLogger) Fatalw(msg string, kvPairs ...interface{})

func (*FabricLogger) Info

func (f *FabricLogger) Info(args ...interface{})

func (*FabricLogger) Infof

func (f *FabricLogger) Infof(template string, args ...interface{})

func (*FabricLogger) Infow

func (f *FabricLogger) Infow(msg string, kvPairs ...interface{})

func (*FabricLogger) IsEnabledFor

func (f *FabricLogger) IsEnabledFor(level zapcore.Level) bool

func (*FabricLogger) Named

func (f *FabricLogger) Named(name string) *FabricLogger

func (*FabricLogger) Notice

func (f *FabricLogger) Notice(args ...interface{})

func (*FabricLogger) Noticef

func (f *FabricLogger) Noticef(template string, args ...interface{})

func (*FabricLogger) Panic

func (f *FabricLogger) Panic(args ...interface{})

func (*FabricLogger) Panicf

func (f *FabricLogger) Panicf(template string, args ...interface{})

func (*FabricLogger) Panicw

func (f *FabricLogger) Panicw(msg string, kvPairs ...interface{})

func (*FabricLogger) Sync

func (f *FabricLogger) Sync() error

func (*FabricLogger) Warn

func (f *FabricLogger) Warn(args ...interface{})

func (*FabricLogger) Warnf

func (f *FabricLogger) Warnf(template string, args ...interface{})

func (*FabricLogger) Warning

func (f *FabricLogger) Warning(args ...interface{})

func (*FabricLogger) Warningf

func (f *FabricLogger) Warningf(template string, args ...interface{})

func (*FabricLogger) Warnw

func (f *FabricLogger) Warnw(msg string, kvPairs ...interface{})

func (*FabricLogger) With

func (f *FabricLogger) With(args ...interface{}) *FabricLogger

func (*FabricLogger) WithOptions

func (f *FabricLogger) WithOptions(opts ...zap.Option) *FabricLogger

func (*FabricLogger) Zap

func (f *FabricLogger) Zap() *zap.Logger

type LoggerLevels

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

loggerlevels跟踪已命名记录器的日志级别。

func (*LoggerLevels) ActivateSpec

func (l *LoggerLevels) ActivateSpec(spec string) error

activatespec用于修改日志记录级别。

日志规范的格式如下: [<logger>[,<logger>…]=]<level>[:[<logger>[,<logger>…]=]<level>…]

func (*LoggerLevels) DefaultLevel

func (l *LoggerLevels) DefaultLevel() zapcore.Level

DefaultLevel返回不具有的记录器的默认日志记录级别 显式级别集。

func (*LoggerLevels) Level

func (l *LoggerLevels) Level(loggerName string) zapcore.Level

LEVEL返回记录器的有效日志记录级别。如果一个级别没有 已为记录器显式设置,默认日志级别将为 返回。

func (*LoggerLevels) Spec

func (l *LoggerLevels) Spec() string

spec返回活动日志规范的规范化版本。

type Logging

type Logging struct {
	*LoggerLevels
	// contains filtered or unexported fields
}

日志记录维护与结构日志记录系统关联的状态。它是

Go日志和Zap提供的结构化、级别日志。

var Global *Logging

func New

func New(c Config) (*Logging, error)

新建创建一个新的日志记录系统,并用提供的 配置。

func (*Logging) Apply

func (s *Logging) Apply(c Config) error

应用将提供的配置应用于日志记录系统。

func (*Logging) Check

func (s *Logging) Check(e zapcore.Entry, ce *zapcore.CheckedEntry)

func (*Logging) Encoding

func (s *Logging) Encoding() Encoding

编码满足编码接口。它决定JSON还是 写日志记录时,内核应该使用控制台编码器。

func (*Logging) Logger

func (s *Logging) Logger(name string) *FabricLogger

Logger用指定的名称实例化新的FabricLogger。名字是 用于确定启用了哪些日志级别。

func (*Logging) SetFormat

func (s *Logging) SetFormat(format string) error

setformat更新日志记录的格式和编码方式。日志条目 此方法完成后创建的将使用新格式。

如果无法分析日志格式规范,则返回错误。

func (*Logging) SetObserver

func (s *Logging) SetObserver(observer Observer)

setobserver用于提供将被称为日志的日志观察器 检查或书写级别。只支持一个观察者。

func (*Logging) SetWriter

func (s *Logging) SetWriter(w io.Writer)

setwriter控制写入哪些编写器格式的日志记录。 除了*os.file之外,编写器需要对并发安全。 由多个go例程使用。

func (*Logging) Sync

func (s *Logging) Sync() error

同步满足zapcore.writesyncer接口。它被核心用来 终止进程前刷新日志记录。

func (*Logging) Write

func (s *Logging) Write(b []byte) (int, error)

写满足IO。写合同。它委托给作者论点 设置编写器或配置的编写器字段。核心在编码时使用这个 日志记录。

func (*Logging) WriteEntry

func (s *Logging) WriteEntry(e zapcore.Entry, fields []zapcore.Field)

func (*Logging) ZapLogger

func (s *Logging) ZapLogger(name string) *zap.Logger

zap logger用指定的名称实例化新的zap.logger。名字是 用于确定启用了哪些日志级别。

type Observer

type Observer interface {
	Check(e zapcore.Entry, ce *zapcore.CheckedEntry)
	WriteEntry(e zapcore.Entry, fields []zapcore.Field)
}

Directories

Path Synopsis
fakes
伪造者生成的代码。
伪造者生成的代码。
伪造者生成的代码。
伪造者生成的代码。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL