logs

Documentation

Index

• Constants
• func Load(ctx context.Context) logs.Logger
• func With(ctx context.Context, v logs.Logger)
• type Config
  • func (config *Config) GetWriter(name string) (writer configures.Config, err error)
• type ConsoleFormatter
  • func (formatter ConsoleFormatter) Code() logs.ConsoleWriterFormatter
• type ConsoleWriterOutType
  • func (ot ConsoleWriterOutType) Code() logs.ConsoleWriterOutType
• type Level
  • func (level Level) Code() logs.Level
• type Logger
  • func New(config Config, writers []Writer) (v Logger, err error)
• type Writer
• type WriterConfig
  • func (writer WriterConfig) Config() (v configures.Config, err error)
• type WriterOptions

Constants

const (
	TextConsoleFormatter         = ConsoleFormatter("text")
	TextColorfulConsoleFormatter = ConsoleFormatter("text_colorful")
	JsonConsoleFormatter         = ConsoleFormatter("json")
)

const (
	Stdout = ConsoleWriterOutType("stdout")
	Stderr = ConsoleWriterOutType("stderr")
	Stdmix = ConsoleWriterOutType("stdout_stderr")
)

const (
	Debug = Level("debug")
	Info  = Level("info")
	Warn  = Level("warn")
	Error = Level("error")
)

Functions

func Load

func Load(ctx context.Context) logs.Logger

func With

func With(ctx context.Context, v logs.Logger)

Types

type Config

type Config struct {
	Level           Level                `json:"level,omitempty" yaml:"level,omitempty"`
	Formatter       ConsoleFormatter     `json:"formatter,omitempty" yaml:"formatter,omitempty"`
	Console         ConsoleWriterOutType `json:"console,omitempty" yaml:"console,omitempty"`
	DisableConsole  bool                 `json:"disableConsole,omitempty" yaml:"disableConsole,omitempty"`
	Consumes        int                  `json:"consumes,omitempty" yaml:"consumes,omitempty"`
	Buffer          int                  `json:"buffer,omitempty" yaml:"buffer,omitempty"`
	SendTimeout     string               `json:"sendTimeout,omitempty" yaml:"sendTimeout,omitempty"`
	ShutdownTimeout string               `json:"shutdownTimeout,omitempty" yaml:"shutdownTimeout,omitempty"`
	Writers         []WriterConfig       `json:"writers,omitempty" yaml:"writer,omitempty"`
}

func (*Config) GetWriter

func (config *Config) GetWriter(name string) (writer configures.Config, err error)

type ConsoleFormatter

type ConsoleFormatter string

func (ConsoleFormatter) Code

func (formatter ConsoleFormatter) Code() logs.ConsoleWriterFormatter

type ConsoleWriterOutType

type ConsoleWriterOutType string

func (ConsoleWriterOutType) Code

func (ot ConsoleWriterOutType) Code() logs.ConsoleWriterOutType

type Level

type Level string

func (Level) Code

func (level Level) Code() logs.Level

type Logger

type Logger interface {
	logs.Logger
}

func New

func New(config Config, writers []Writer) (v Logger, err error)

type Writer

type Writer interface {
	logs.Writer
	Name() string
	Shutdown(ctx context.Context)
	Construct(options WriterOptions) (err error)
}

type WriterConfig

type WriterConfig struct {
	Name    string          `json:"name,omitempty" yaml:"name,omitempty"`
	Options json.RawMessage `json:"options,omitempty" yaml:"options,omitempty"`
}

func (WriterConfig) Config

func (writer WriterConfig) Config() (v configures.Config, err error)

type WriterOptions

type WriterOptions struct {
	Config configures.Config
}