zapm

README

zapm (zap mate) provides helpers for zap library.

Documentation

Index

• Constants
• Variables
• func InitDefault(f string, opts ...zap.Option) error
• func NewDiffCore(enc zapcore.Encoder, ws zapcore.WriteSyncer, enab zapcore.LevelEnabler, ...) zapcore.Core
• type Config
  • func LoadConfig(bs []byte) (*Config, error)
  • func LoadConfigFile(f string) (*Config, error)
  • func (cfg *Config) Build(opts ...zap.Option) (*zap.Logger, error)
• type LogMux
• type Option
  • func EnableGlogMux() Option

Constants

const (
	// MsgUKey defines this message uniq key to make diff
	MsgUKey = "ukey"
)

Variables

var (
	// Logger is the default logger
	Logger *zap.Logger
)

Functions

func InitDefault

func InitDefault(f string, opts ...zap.Option) error

InitDefault init default logger

func NewDiffCore

func NewDiffCore(enc zapcore.Encoder, ws zapcore.WriteSyncer, enab zapcore.LevelEnabler, cacheSize int, opts ...Option) zapcore.Core

NewDiffCore creates a Core only output logs when different.

Types

type Config

type Config struct {
	Level         zap.AtomicLevel       `json:"level"`
	Sink          lumberjack.Logger     `json:"sink"`
	Encoding      string                `json:"encoding"`
	EncoderConfig zapcore.EncoderConfig `json:"encoderConfig"`
	// Whether to use diffCore
	DiffCore      bool `json:"diffCore"`
	DiffCacheSize int  `json:"diffCacheSize"`
	GlogMux       bool `json:"glogMux"`
}

Config configs for zap logger

func LoadConfig

func LoadConfig(bs []byte) (*Config, error)

LoadConfig load config

func LoadConfigFile

func LoadConfigFile(f string) (*Config, error)

LoadConfigFile load config from file

func (*Config) Build

func (cfg *Config) Build(opts ...zap.Option) (*zap.Logger, error)

Build constructs a logger from the Config and Options.

type LogMux

type LogMux interface {
	Write(lvl zapcore.Level, b []byte)
}

LogMux receives log messages

type Option

type Option func(*diffCore)

Option options to set diffCore

func EnableGlogMux

func EnableGlogMux() Option

EnableGlogMux enable glog mux