log

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Dec 31, 2025 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BoldEndOptions 

func BoldEndOptions(opts types.LogProcessOptionsInterface)

func BoldFailOptions 

func BoldFailOptions(opts types.LogProcessOptionsInterface)

func BoldOptions 

func BoldOptions(opts types.LogProcessOptionsInterface)

func BoldStartOptions 

func BoldStartOptions(opts types.LogProcessOptionsInterface)

func InfrastructureOptions 

func InfrastructureOptions(opts types.LogProcessOptionsInterface)

func InitKlog 

func InitKlog(logger Logger, opts ...KlogOpt) error

Types

type DummyLogger 

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

func NewDummyLogger 

func NewDummyLogger(isDebug bool) *DummyLogger

func (*DummyLogger) BufferLogger 

func (d *DummyLogger) BufferLogger(buffer *bytes.Buffer) Logger

func (*DummyLogger) DebugF 

func (d *DummyLogger) DebugF(format string, a ...interface{})

func (DummyLogger) DebugFLn 

func (w DummyLogger) DebugFLn(format string, a ...any)

func (*DummyLogger) DebugLn 

func (d *DummyLogger) DebugLn(a ...interface{})

func (*DummyLogger) ErrorF 

func (d *DummyLogger) ErrorF(format string, a ...interface{})

func (DummyLogger) ErrorFLn 

func (w DummyLogger) ErrorFLn(format string, a ...any)

func (*DummyLogger) ErrorLn 

func (d *DummyLogger) ErrorLn(a ...interface{})

func (*DummyLogger) Fail 

func (d *DummyLogger) Fail(l string)

func (*DummyLogger) FailRetry 

func (d *DummyLogger) FailRetry(l string)

func (*DummyLogger) FlushAndClose 

func (d *DummyLogger) FlushAndClose() error

func (*DummyLogger) InfoF 

func (d *DummyLogger) InfoF(format string, a ...interface{})

func (DummyLogger) InfoFLn 

func (w DummyLogger) InfoFLn(format string, a ...any)

func (*DummyLogger) InfoLn 

func (d *DummyLogger) InfoLn(a ...interface{})

func (*DummyLogger) JSON 

func (d *DummyLogger) JSON(content []byte)

func (*DummyLogger) Process 

func (d *DummyLogger) Process(_ Process, t string, run func() error) error

func (*DummyLogger) ProcessLogger 

func (d *DummyLogger) ProcessLogger() ProcessLogger

func (*DummyLogger) SilentLogger 

func (d *DummyLogger) SilentLogger() *SilentLogger

func (*DummyLogger) Success 

func (d *DummyLogger) Success(l string)

func (*DummyLogger) WarnF 

func (d *DummyLogger) WarnF(format string, a ...interface{})

func (DummyLogger) WarnFLn 

func (w DummyLogger) WarnFLn(format string, a ...any)

func (*DummyLogger) WarnLn 

func (d *DummyLogger) WarnLn(a ...interface{})

func (*DummyLogger) Write 

func (d *DummyLogger) Write(content []byte) (int, error)

type InMemoryLogger 

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

func NewInMemoryLogger 

func NewInMemoryLogger() *InMemoryLogger

func NewInMemoryLoggerWithParent 

func NewInMemoryLoggerWithParent(parent Logger) *InMemoryLogger

func (*InMemoryLogger) AllMatches 

func (l *InMemoryLogger) AllMatches(m *Match) ([]string, error)

func (*InMemoryLogger) BufferLogger 

func (l *InMemoryLogger) BufferLogger(buffer *bytes.Buffer) Logger

func (*InMemoryLogger) DebugF 

func (l *InMemoryLogger) DebugF(format string, a ...interface{})

func (InMemoryLogger) DebugFLn 

func (w InMemoryLogger) DebugFLn(format string, a ...any)

func (*InMemoryLogger) DebugLn 

func (l *InMemoryLogger) DebugLn(a ...interface{})

func (*InMemoryLogger) ErrorF 

func (l *InMemoryLogger) ErrorF(format string, a ...interface{})

func (InMemoryLogger) ErrorFLn 

func (w InMemoryLogger) ErrorFLn(format string, a ...any)

func (*InMemoryLogger) ErrorLn 

func (l *InMemoryLogger) ErrorLn(a ...interface{})

func (*InMemoryLogger) Fail 

func (l *InMemoryLogger) Fail(s string)

func (*InMemoryLogger) FailRetry 

func (l *InMemoryLogger) FailRetry(s string)

func (*InMemoryLogger) FirstMatch 

func (l *InMemoryLogger) FirstMatch(m *Match) (string, error)

func (*InMemoryLogger) FlushAndClose 

func (l *InMemoryLogger) FlushAndClose() error

func (*InMemoryLogger) InfoF 

func (l *InMemoryLogger) InfoF(format string, a ...interface{})

func (InMemoryLogger) InfoFLn 

func (w InMemoryLogger) InfoFLn(format string, a ...any)

func (*InMemoryLogger) InfoLn 

func (l *InMemoryLogger) InfoLn(a ...interface{})

func (*InMemoryLogger) JSON 

func (l *InMemoryLogger) JSON(s []byte)

func (*InMemoryLogger) Parent 

func (l *InMemoryLogger) Parent() Logger

func (*InMemoryLogger) Process 

func (l *InMemoryLogger) Process(p Process, t string, action func() error) error

func (*InMemoryLogger) ProcessEnd 

func (l *InMemoryLogger) ProcessEnd()

func (*InMemoryLogger) ProcessFail 

func (l *InMemoryLogger) ProcessFail()

func (*InMemoryLogger) ProcessLogger 

func (l *InMemoryLogger) ProcessLogger() ProcessLogger

func (*InMemoryLogger) ProcessStart 

func (l *InMemoryLogger) ProcessStart(name string)

func (*InMemoryLogger) SilentLogger 

func (l *InMemoryLogger) SilentLogger() *SilentLogger

func (*InMemoryLogger) Success 

func (l *InMemoryLogger) Success(s string)

func (*InMemoryLogger) WarnF 

func (l *InMemoryLogger) WarnF(format string, a ...interface{})

func (InMemoryLogger) WarnFLn 

func (w InMemoryLogger) WarnFLn(format string, a ...any)

func (*InMemoryLogger) WarnLn 

func (l *InMemoryLogger) WarnLn(a ...interface{})

func (*InMemoryLogger) WithBuffer 

func (l *InMemoryLogger) WithBuffer(buffer *bytes.Buffer) *InMemoryLogger

func (*InMemoryLogger) WithDebugPrefix 

func (l *InMemoryLogger) WithDebugPrefix(prefix string) *InMemoryLogger

func (*InMemoryLogger) WithErrorPrefix 

func (l *InMemoryLogger) WithErrorPrefix(prefix string) *InMemoryLogger

func (*InMemoryLogger) WithNoDebug 

func (l *InMemoryLogger) WithNoDebug(f bool) *InMemoryLogger

func (*InMemoryLogger) Write 

func (l *InMemoryLogger) Write(s []byte) (int, error)

type KeywordSanitizer 

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

func NewKeywordSanitizer 

func NewKeywordSanitizer() *KeywordSanitizer

func (*KeywordSanitizer) Filter 

func (l *KeywordSanitizer) Filter(args []any) []any

func (*KeywordSanitizer) FilterF 

func (l *KeywordSanitizer) FilterF(format string, args []any) (string, []any)

func (*KeywordSanitizer) FilterS 

func (l *KeywordSanitizer) FilterS(msg string, keysAndValues []any) (string, []any)

func (*KeywordSanitizer) WithAdditionalKeywords 

func (l *KeywordSanitizer) WithAdditionalKeywords(keywords []string) *KeywordSanitizer

type KlogOpt 

type KlogOpt func(opts *KlogOptions)

func WithKlogSanitizer 

func WithKlogSanitizer(sanitizer Sanitizer) KlogOpt

func WithKlogVerbose 

func WithKlogVerbose(v string) KlogOpt

type KlogOptions 

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

type Logger 

type Logger interface {
	// contains filtered or unexported methods
}

func NewLogger 

func NewLogger(loggerType Type, isDebug bool) (Logger, error)

NewLogger do not init Klog use InitKlog for initialize Klog wrapper

func NewLoggerWithOptions 

func NewLoggerWithOptions(loggerType Type, opts LoggerOptions) (Logger, error)

NewLoggerWithOptions do not init Klog use InitKlog for initialize Klog wrapper

func ProvideSafe added in v0.3.0 

func ProvideSafe(provider LoggerProvider, defaultLogger Logger) Logger

func SafeProvideLogger 

func SafeProvideLogger(provider LoggerProvider) Logger

func WrapWithTeeLogger 

func WrapWithTeeLogger(logger Logger, writer io.WriteCloser, bufSize int) (Logger, error)

type LoggerOptions 

type LoggerOptions struct {
	OutStream   io.Writer
	Width       int
	IsDebug     bool
	DebugStream io.Writer

	AdditionalProcesses Processes
}

type LoggerProvider 

type LoggerProvider func() Logger

func SilentLoggerProvider 

func SilentLoggerProvider() LoggerProvider

func SimpleLoggerProvider 

func SimpleLoggerProvider(logger Logger) LoggerProvider

type Match 

type Match struct {
	Prefix []string
	Suffix []string
	Regex  []*regexp.Regexp
}

Match if Regex passed Prefix and Suffix will be ignored

func (*Match) IsValid 

func (m *Match) IsValid() error

type PrettyLogger 

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

func NewPrettyLogger 

func NewPrettyLogger(opts LoggerOptions) *PrettyLogger

func (*PrettyLogger) BufferLogger 

func (d *PrettyLogger) BufferLogger(buffer *bytes.Buffer) Logger

func (*PrettyLogger) DebugF 

func (d *PrettyLogger) DebugF(format string, a ...interface{})

func (PrettyLogger) DebugFLn 

func (w PrettyLogger) DebugFLn(format string, a ...any)

func (*PrettyLogger) DebugLn 

func (d *PrettyLogger) DebugLn(a ...interface{})

func (*PrettyLogger) ErrorF 

func (d *PrettyLogger) ErrorF(format string, a ...interface{})

func (PrettyLogger) ErrorFLn 

func (w PrettyLogger) ErrorFLn(format string, a ...any)

func (*PrettyLogger) ErrorLn 

func (d *PrettyLogger) ErrorLn(a ...interface{})

func (*PrettyLogger) Fail 

func (d *PrettyLogger) Fail(l string)

func (*PrettyLogger) FailRetry 

func (d *PrettyLogger) FailRetry(l string)

func (*PrettyLogger) FlushAndClose 

func (d *PrettyLogger) FlushAndClose() error

func (*PrettyLogger) InfoF 

func (d *PrettyLogger) InfoF(format string, a ...interface{})

func (PrettyLogger) InfoFLn 

func (w PrettyLogger) InfoFLn(format string, a ...any)

func (*PrettyLogger) InfoLn 

func (d *PrettyLogger) InfoLn(a ...interface{})

func (*PrettyLogger) JSON 

func (d *PrettyLogger) JSON(content []byte)

func (*PrettyLogger) Process 

func (d *PrettyLogger) Process(p Process, t string, run func() error) error

func (*PrettyLogger) ProcessLogger 

func (d *PrettyLogger) ProcessLogger() ProcessLogger

func (*PrettyLogger) SilentLogger 

func (d *PrettyLogger) SilentLogger() *SilentLogger

func (*PrettyLogger) Success 

func (d *PrettyLogger) Success(l string)

func (*PrettyLogger) WarnF 

func (d *PrettyLogger) WarnF(format string, a ...interface{})

func (PrettyLogger) WarnFLn 

func (w PrettyLogger) WarnFLn(format string, a ...any)

func (*PrettyLogger) WarnLn 

func (d *PrettyLogger) WarnLn(a ...interface{})

func (*PrettyLogger) Write 

func (d *PrettyLogger) Write(content []byte) (int, error)

type Process 

type Process string
const (
	ProcessDefault        Process = "default"
	ProcessCommon         Process = "common"
	ProcessInfrastructure Process = "infrastructure"
	ProcessConverge       Process = "converge"
	ProcessBootstrap      Process = "bootstrap"
)
const (
	ProcessMirror          Process = "mirror"
	ProcessCommanderAttach Process = "commander/attach"
	ProcessCommanderDetach Process = "commander/detach"
)

Deprecated: add additional processes via opts

type ProcessLogger 

type ProcessLogger interface {
	ProcessStart(name string)
	ProcessFail()
	ProcessEnd()
}

type Processes 

type Processes map[Process]StyleEntry

func AdditionalProcesses 

func AdditionalProcesses(processes map[string]StyleEntry) Processes

type Sanitizer 

type Sanitizer interface {
	klog.LogFilter
}

func NewDummySanitizer 

func NewDummySanitizer() Sanitizer

type SilentLogger 

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

func NewSilentLogger 

func NewSilentLogger() *SilentLogger

func (*SilentLogger) BufferLogger 

func (d *SilentLogger) BufferLogger(buffer *bytes.Buffer) Logger

func (*SilentLogger) DebugF 

func (d *SilentLogger) DebugF(format string, a ...interface{})

func (SilentLogger) DebugFLn 

func (w SilentLogger) DebugFLn(format string, a ...any)

func (*SilentLogger) DebugLn 

func (d *SilentLogger) DebugLn(a ...interface{})

func (*SilentLogger) ErrorF 

func (d *SilentLogger) ErrorF(format string, a ...interface{})

func (SilentLogger) ErrorFLn 

func (w SilentLogger) ErrorFLn(format string, a ...any)

func (*SilentLogger) ErrorLn 

func (d *SilentLogger) ErrorLn(a ...interface{})

func (*SilentLogger) Fail 

func (d *SilentLogger) Fail(l string)

func (*SilentLogger) FailRetry 

func (d *SilentLogger) FailRetry(l string)

func (*SilentLogger) FlushAndClose 

func (d *SilentLogger) FlushAndClose() error

func (*SilentLogger) InfoF 

func (d *SilentLogger) InfoF(format string, a ...interface{})

func (SilentLogger) InfoFLn 

func (w SilentLogger) InfoFLn(format string, a ...any)

func (*SilentLogger) InfoLn 

func (d *SilentLogger) InfoLn(a ...interface{})

func (*SilentLogger) JSON 

func (d *SilentLogger) JSON(content []byte)

func (*SilentLogger) Process 

func (d *SilentLogger) Process(_ Process, t string, run func() error) error

func (*SilentLogger) ProcessLogger 

func (d *SilentLogger) ProcessLogger() ProcessLogger

func (*SilentLogger) SilentLogger 

func (d *SilentLogger) SilentLogger() *SilentLogger

func (*SilentLogger) Success 

func (d *SilentLogger) Success(l string)

func (*SilentLogger) WarnF 

func (d *SilentLogger) WarnF(format string, a ...interface{})

func (SilentLogger) WarnFLn 

func (w SilentLogger) WarnFLn(format string, a ...any)

func (*SilentLogger) WarnLn 

func (d *SilentLogger) WarnLn(a ...interface{})

func (*SilentLogger) Write 

func (d *SilentLogger) Write(content []byte) (int, error)

type SimpleLogger 

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

func NewJSONLogger 

func NewJSONLogger(opts LoggerOptions) *SimpleLogger

func NewSimpleLogger 

func NewSimpleLogger(opts LoggerOptions) *SimpleLogger

func (*SimpleLogger) BufferLogger 

func (d *SimpleLogger) BufferLogger(buffer *bytes.Buffer) Logger

func (*SimpleLogger) DebugF 

func (d *SimpleLogger) DebugF(format string, a ...interface{})

func (SimpleLogger) DebugFLn 

func (w SimpleLogger) DebugFLn(format string, a ...any)

func (*SimpleLogger) DebugLn 

func (d *SimpleLogger) DebugLn(a ...interface{})

func (*SimpleLogger) ErrorF 

func (d *SimpleLogger) ErrorF(format string, a ...interface{})

func (SimpleLogger) ErrorFLn 

func (w SimpleLogger) ErrorFLn(format string, a ...any)

func (*SimpleLogger) ErrorLn 

func (d *SimpleLogger) ErrorLn(a ...interface{})

func (*SimpleLogger) Fail 

func (d *SimpleLogger) Fail(l string)

func (*SimpleLogger) FailRetry 

func (d *SimpleLogger) FailRetry(l string)

func (*SimpleLogger) FlushAndClose 

func (d *SimpleLogger) FlushAndClose() error

func (*SimpleLogger) InfoF 

func (d *SimpleLogger) InfoF(format string, a ...interface{})

func (SimpleLogger) InfoFLn 

func (w SimpleLogger) InfoFLn(format string, a ...any)

func (*SimpleLogger) InfoLn 

func (d *SimpleLogger) InfoLn(a ...interface{})

func (*SimpleLogger) JSON 

func (d *SimpleLogger) JSON(content []byte)

func (*SimpleLogger) Process 

func (d *SimpleLogger) Process(p Process, t string, run func() error) error

func (*SimpleLogger) ProcessLogger 

func (d *SimpleLogger) ProcessLogger() ProcessLogger

func (*SimpleLogger) SilentLogger 

func (d *SimpleLogger) SilentLogger() *SilentLogger

func (*SimpleLogger) Success 

func (d *SimpleLogger) Success(l string)

func (*SimpleLogger) WarnF 

func (d *SimpleLogger) WarnF(format string, a ...interface{})

func (SimpleLogger) WarnFLn 

func (w SimpleLogger) WarnFLn(format string, a ...any)

func (*SimpleLogger) WarnLn 

func (d *SimpleLogger) WarnLn(a ...interface{})

func (*SimpleLogger) Write 

func (d *SimpleLogger) Write(content []byte) (int, error)

type StyleEntry 

type StyleEntry struct {
	Title         string
	OptionsSetter StyleEntryOptionsSetter
}

type StyleEntryOptionsSetter 

type StyleEntryOptionsSetter func(opts types.LogProcessOptionsInterface)

type TeeLogger 

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

func NewTeeLogger 

func NewTeeLogger(l Logger, writer io.WriteCloser, bufferSize int) (*TeeLogger, error)

func (*TeeLogger) BufferLogger 

func (d *TeeLogger) BufferLogger(buffer *bytes.Buffer) Logger

func (*TeeLogger) DebugF 

func (d *TeeLogger) DebugF(format string, a ...interface{})

func (TeeLogger) DebugFLn 

func (w TeeLogger) DebugFLn(format string, a ...any)

func (*TeeLogger) DebugLn 

func (d *TeeLogger) DebugLn(a ...interface{})

func (*TeeLogger) ErrorF 

func (d *TeeLogger) ErrorF(format string, a ...interface{})

func (TeeLogger) ErrorFLn 

func (w TeeLogger) ErrorFLn(format string, a ...any)

func (*TeeLogger) ErrorLn 

func (d *TeeLogger) ErrorLn(a ...interface{})

func (*TeeLogger) Fail 

func (d *TeeLogger) Fail(l string)

func (*TeeLogger) FailRetry 

func (d *TeeLogger) FailRetry(l string)

func (*TeeLogger) FlushAndClose 

func (d *TeeLogger) FlushAndClose() error

func (*TeeLogger) InfoF 

func (d *TeeLogger) InfoF(format string, a ...interface{})

func (TeeLogger) InfoFLn 

func (w TeeLogger) InfoFLn(format string, a ...any)

func (*TeeLogger) InfoLn 

func (d *TeeLogger) InfoLn(a ...interface{})

func (*TeeLogger) JSON 

func (d *TeeLogger) JSON(content []byte)

func (*TeeLogger) Process 

func (d *TeeLogger) Process(p Process, t string, run func() error) error

func (*TeeLogger) ProcessLogger 

func (d *TeeLogger) ProcessLogger() ProcessLogger

func (*TeeLogger) SilentLogger 

func (d *TeeLogger) SilentLogger() *SilentLogger

func (*TeeLogger) Success 

func (d *TeeLogger) Success(l string)

func (*TeeLogger) WarnF 

func (d *TeeLogger) WarnF(format string, a ...interface{})

func (TeeLogger) WarnFLn 

func (w TeeLogger) WarnFLn(format string, a ...any)

func (*TeeLogger) WarnLn 

func (d *TeeLogger) WarnLn(a ...interface{})

func (*TeeLogger) Write 

func (d *TeeLogger) Write(content []byte) (int, error)

type Type 

type Type string
const (
	Pretty Type = "pretty"
	JSON   Type = "json"
	Empty  Type = "silent"
	Simple Type = "simple"
)

func ConvertType 

func ConvertType(t string) (Type, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.