log

package
v1.13.0-beta.2 Latest Latest
Warning

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

 Go to latest Published: May 29, 2025 License: Apache-2.0 Imports: 5 Imported by: 6

Documentation

Overview

Package log provides structured logging functionality with support for different log levels. It offers a unified logging interface with context support and structured output.

Package log is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoLogger 

type GoLogger struct {
	Level LogLevel
	// contains filtered or unexported fields
}

GoLogger is the Go built-in (log) implementation of Logger interface.

func (*GoLogger) Debug 

func (l *GoLogger) Debug(args ...any)

Debug implements Debug Logger interface function.

func (*GoLogger) Debugf 

func (l *GoLogger) Debugf(format string, args ...any)

Debugf implements Debugf Logger interface function.

func (*GoLogger) Debugln 

func (l *GoLogger) Debugln(args ...any)

Debugln implements Debugln Logger interface function.

func (*GoLogger) Error 

func (l *GoLogger) Error(args ...any)

Error implements Error Logger interface function.

func (*GoLogger) Errorf 

func (l *GoLogger) Errorf(format string, args ...any)

Errorf implements Errorf Logger interface function.

func (*GoLogger) Errorln 

func (l *GoLogger) Errorln(args ...any)

Errorln implements Errorln Logger interface function.

func (*GoLogger) Fatal 

func (l *GoLogger) Fatal(args ...any)

Fatal implements Fatal Logger interface function.

func (*GoLogger) Fatalf 

func (l *GoLogger) Fatalf(format string, args ...any)

Fatalf implements Fatalf Logger interface function.

func (*GoLogger) Fatalln 

func (l *GoLogger) Fatalln(args ...any)

Fatalln implements Fatalln Logger interface function.

func (*GoLogger) Info 

func (l *GoLogger) Info(args ...any)

Info implements Info Logger interface function.

func (*GoLogger) Infof 

func (l *GoLogger) Infof(format string, args ...any)

Infof implements Infof Logger interface function.

func (*GoLogger) Infoln 

func (l *GoLogger) Infoln(args ...any)

Infoln implements Infoln Logger interface function.

func (*GoLogger) IsLevelEnabled 

func (l *GoLogger) IsLevelEnabled(level LogLevel) bool

IsLevelEnabled checks if the given level is enabled.

func (*GoLogger) Sync 

func (l *GoLogger) Sync() error

Sync implements Sync Logger interface function.

func (*GoLogger) Warn 

func (l *GoLogger) Warn(args ...any)

Warn implements Warn Logger interface function.

func (*GoLogger) Warnf 

func (l *GoLogger) Warnf(format string, args ...any)

Warnf implements Warnf Logger interface function.

func (*GoLogger) Warnln 

func (l *GoLogger) Warnln(args ...any)

Warnln implements Warnln Logger interface function.

func (*GoLogger) WithDefaultMessageTemplate 

func (l *GoLogger) WithDefaultMessageTemplate(message string) Logger

WithDefaultMessageTemplate sets a default message template for the logger and returns a new instance.

func (*GoLogger) WithFields 

func (l *GoLogger) WithFields(fields ...any) Logger

WithFields implements WithFields Logger interface function

type LogLevel 

type LogLevel int8

LogLevel represents the level of log system (fatal, error, warn, info and debug). The type name intentionally matches the package name for clarity in external usage. 

const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel LogLevel = iota
	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
)

These are the different log levels. You can set the logging level to log.

func ParseLevel 

func ParseLevel(lvl string) (LogLevel, error)

ParseLevel takes a string level and returns a LogLevel constant.

type Logger 

type Logger interface {
	Info(args ...any)
	Infof(format string, args ...any)
	Infoln(args ...any)

	Error(args ...any)
	Errorf(format string, args ...any)
	Errorln(args ...any)

	Warn(args ...any)
	Warnf(format string, args ...any)
	Warnln(args ...any)

	Debug(args ...any)
	Debugf(format string, args ...any)
	Debugln(args ...any)

	Fatal(args ...any)
	Fatalf(format string, args ...any)
	Fatalln(args ...any)

	WithFields(fields ...any) Logger

	WithDefaultMessageTemplate(message string) Logger

	Sync() error
}

Logger is the pkg interface for log implementation.

type MockLogger 

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

MockLogger is a mock of Logger interface.

func NewMockLogger 

func NewMockLogger(ctrl *gomock.Controller) *MockLogger

NewMockLogger creates a new mock instance.

func (*MockLogger) Debug 

func (m *MockLogger) Debug(args ...any)

Debug mocks base method.

func (*MockLogger) Debugf 

func (m *MockLogger) Debugf(format string, args ...any)

Debugf mocks base method.

func (*MockLogger) Debugln 

func (m *MockLogger) Debugln(args ...any)

Debugln mocks base method.

func (*MockLogger) EXPECT 

func (m *MockLogger) EXPECT() *MockLoggerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockLogger) Error 

func (m *MockLogger) Error(args ...any)

Error mocks base method.

func (*MockLogger) Errorf 

func (m *MockLogger) Errorf(format string, args ...any)

Errorf mocks base method.

func (*MockLogger) Errorln 

func (m *MockLogger) Errorln(args ...any)

Errorln mocks base method.

func (*MockLogger) Fatal 

func (m *MockLogger) Fatal(args ...any)

Fatal mocks base method.

func (*MockLogger) Fatalf 

func (m *MockLogger) Fatalf(format string, args ...any)

Fatalf mocks base method.

func (*MockLogger) Fatalln 

func (m *MockLogger) Fatalln(args ...any)

Fatalln mocks base method.

func (*MockLogger) Info 

func (m *MockLogger) Info(args ...any)

Info mocks base method.

func (*MockLogger) Infof 

func (m *MockLogger) Infof(format string, args ...any)

Infof mocks base method.

func (*MockLogger) Infoln 

func (m *MockLogger) Infoln(args ...any)

Infoln mocks base method.

func (*MockLogger) Sync 

func (m *MockLogger) Sync() error

Sync mocks base method.

func (*MockLogger) Warn 

func (m *MockLogger) Warn(args ...any)

Warn mocks base method.

func (*MockLogger) Warnf 

func (m *MockLogger) Warnf(format string, args ...any)

Warnf mocks base method.

func (*MockLogger) Warnln 

func (m *MockLogger) Warnln(args ...any)

Warnln mocks base method.

func (*MockLogger) WithDefaultMessageTemplate 

func (m *MockLogger) WithDefaultMessageTemplate(message string) Logger

WithDefaultMessageTemplate mocks base method.

func (*MockLogger) WithFields 

func (m *MockLogger) WithFields(fields ...any) Logger

WithFields mocks base method.

type MockLoggerMockRecorder 

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

MockLoggerMockRecorder is the mock recorder for MockLogger.

func (*MockLoggerMockRecorder) Debug 

func (mr *MockLoggerMockRecorder) Debug(args ...any) *gomock.Call

Debug indicates an expected call of Debug.

func (*MockLoggerMockRecorder) Debugf 

func (mr *MockLoggerMockRecorder) Debugf(format any, args ...any) *gomock.Call

Debugf indicates an expected call of Debugf.

func (*MockLoggerMockRecorder) Debugln 

func (mr *MockLoggerMockRecorder) Debugln(args ...any) *gomock.Call

Debugln indicates an expected call of Debugln.

func (*MockLoggerMockRecorder) Error 

func (mr *MockLoggerMockRecorder) Error(args ...any) *gomock.Call

Error indicates an expected call of Error.

func (*MockLoggerMockRecorder) Errorf 

func (mr *MockLoggerMockRecorder) Errorf(format any, args ...any) *gomock.Call

Errorf indicates an expected call of Errorf.

func (*MockLoggerMockRecorder) Errorln 

func (mr *MockLoggerMockRecorder) Errorln(args ...any) *gomock.Call

Errorln indicates an expected call of Errorln.

func (*MockLoggerMockRecorder) Fatal 

func (mr *MockLoggerMockRecorder) Fatal(args ...any) *gomock.Call

Fatal indicates an expected call of Fatal.

func (*MockLoggerMockRecorder) Fatalf 

func (mr *MockLoggerMockRecorder) Fatalf(format any, args ...any) *gomock.Call

Fatalf indicates an expected call of Fatalf.

func (*MockLoggerMockRecorder) Fatalln 

func (mr *MockLoggerMockRecorder) Fatalln(args ...any) *gomock.Call

Fatalln indicates an expected call of Fatalln.

func (*MockLoggerMockRecorder) Info 

func (mr *MockLoggerMockRecorder) Info(args ...any) *gomock.Call

Info indicates an expected call of Info.

func (*MockLoggerMockRecorder) Infof 

func (mr *MockLoggerMockRecorder) Infof(format any, args ...any) *gomock.Call

Infof indicates an expected call of Infof.

func (*MockLoggerMockRecorder) Infoln 

func (mr *MockLoggerMockRecorder) Infoln(args ...any) *gomock.Call

Infoln indicates an expected call of Infoln.

func (*MockLoggerMockRecorder) Sync 

func (mr *MockLoggerMockRecorder) Sync() *gomock.Call

Sync indicates an expected call of Sync.

func (*MockLoggerMockRecorder) Warn 

func (mr *MockLoggerMockRecorder) Warn(args ...any) *gomock.Call

Warn indicates an expected call of Warn.

func (*MockLoggerMockRecorder) Warnf 

func (mr *MockLoggerMockRecorder) Warnf(format any, args ...any) *gomock.Call

Warnf indicates an expected call of Warnf.

func (*MockLoggerMockRecorder) Warnln 

func (mr *MockLoggerMockRecorder) Warnln(args ...any) *gomock.Call

Warnln indicates an expected call of Warnln.

func (*MockLoggerMockRecorder) WithDefaultMessageTemplate 

func (mr *MockLoggerMockRecorder) WithDefaultMessageTemplate(message any) *gomock.Call

WithDefaultMessageTemplate indicates an expected call of WithDefaultMessageTemplate.

func (*MockLoggerMockRecorder) WithFields 

func (mr *MockLoggerMockRecorder) WithFields(fields ...any) *gomock.Call

WithFields indicates an expected call of WithFields.

type NoneLogger 

type NoneLogger struct{}

NoneLogger is a wrapper for log nothing.

func (*NoneLogger) Debug 

func (l *NoneLogger) Debug(_ ...any)

Debug implements Debug Logger interface function.

func (*NoneLogger) Debugf 

func (l *NoneLogger) Debugf(_ string, _ ...any)

Debugf implements Debugf Logger interface function.

func (*NoneLogger) Debugln 

func (l *NoneLogger) Debugln(_ ...any)

Debugln implements Debugln Logger interface function.

func (*NoneLogger) Error 

func (l *NoneLogger) Error(_ ...any)

Error implements Error Logger interface function.

func (*NoneLogger) Errorf 

func (l *NoneLogger) Errorf(_ string, _ ...any)

Errorf implements Errorf Logger interface function.

func (*NoneLogger) Errorln 

func (l *NoneLogger) Errorln(_ ...any)

Errorln implements Errorln Logger interface function.

func (*NoneLogger) Fatal 

func (l *NoneLogger) Fatal(_ ...any)

Fatal implements Fatal Logger interface function.

func (*NoneLogger) Fatalf 

func (l *NoneLogger) Fatalf(_ string, _ ...any)

Fatalf implements Fatalf Logger interface function.

func (*NoneLogger) Fatalln 

func (l *NoneLogger) Fatalln(_ ...any)

Fatalln implements Fatalln Logger interface function.

func (*NoneLogger) Info 

func (l *NoneLogger) Info(_ ...any)

Info implements Info Logger interface function.

func (*NoneLogger) Infof 

func (l *NoneLogger) Infof(_ string, _ ...any)

Infof implements Infof Logger interface function.

func (*NoneLogger) Infoln 

func (l *NoneLogger) Infoln(_ ...any)

Infoln implements Infoln Logger interface function.

func (*NoneLogger) Sync 

func (l *NoneLogger) Sync() error

Sync implements Sync Logger interface function.

func (*NoneLogger) Warn 

func (l *NoneLogger) Warn(_ ...any)

Warn implements Warn Logger interface function.

func (*NoneLogger) Warnf 

func (l *NoneLogger) Warnf(_ string, _ ...any)

Warnf implements Warnf Logger interface function.

func (*NoneLogger) Warnln 

func (l *NoneLogger) Warnln(_ ...any)

Warnln implements Warnln Logger interface function.

func (*NoneLogger) WithDefaultMessageTemplate 

func (l *NoneLogger) WithDefaultMessageTemplate(_ string) Logger

WithDefaultMessageTemplate sets the default message template for the logger.

func (*NoneLogger) WithFields 

func (l *NoneLogger) WithFields(_ ...any) Logger

WithFields implements WithFields Logger interface function

type StructuredLogger added in v1.12.1 

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

StructuredLogger provides structured logging with fields

func NewStructuredLogger added in v1.12.1 

func NewStructuredLogger(logger Logger) *StructuredLogger

NewStructuredLogger creates a new structured logger

func (*StructuredLogger) Debug added in v1.12.1 

func (sl *StructuredLogger) Debug(msg string)

Debug logs a debug message

func (*StructuredLogger) Debugf added in v1.12.1 

func (sl *StructuredLogger) Debugf(format string, args ...any)

Debugf logs a formatted debug message

func (*StructuredLogger) Error added in v1.12.1 

func (sl *StructuredLogger) Error(msg string)

Error logs an error message

func (*StructuredLogger) Errorf added in v1.12.1 

func (sl *StructuredLogger) Errorf(format string, args ...any)

Errorf logs a formatted error message

func (*StructuredLogger) Fatal added in v1.12.1 

func (sl *StructuredLogger) Fatal(msg string)

Fatal logs a fatal message

func (*StructuredLogger) Fatalf added in v1.12.1 

func (sl *StructuredLogger) Fatalf(format string, args ...any)

Fatalf logs a formatted fatal message

func (*StructuredLogger) Info added in v1.12.1 

func (sl *StructuredLogger) Info(msg string)

Info logs an info message

func (*StructuredLogger) Infof added in v1.12.1 

func (sl *StructuredLogger) Infof(format string, args ...any)

Infof logs a formatted info message

func (*StructuredLogger) Warn added in v1.12.1 

func (sl *StructuredLogger) Warn(msg string)

Warn logs a warning message

func (*StructuredLogger) Warnf added in v1.12.1 

func (sl *StructuredLogger) Warnf(format string, args ...any)

Warnf logs a formatted warning message

func (*StructuredLogger) WithBusinessContext added in v1.12.1 

func (sl *StructuredLogger) WithBusinessContext(organizationID, ledgerID string) *StructuredLogger

WithBusinessContext adds business context

func (*StructuredLogger) WithError added in v1.12.1 

func (sl *StructuredLogger) WithError(err error) *StructuredLogger

WithError adds error context

func (*StructuredLogger) WithField added in v1.12.1 

func (sl *StructuredLogger) WithField(key string, value any) *StructuredLogger

WithField adds a single field to the logger

func (*StructuredLogger) WithFields added in v1.12.1 

func (sl *StructuredLogger) WithFields(fields map[string]any) *StructuredLogger

WithFields adds fields to the logger

func (*StructuredLogger) WithOperation added in v1.12.1 

func (sl *StructuredLogger) WithOperation(operationName string) *StructuredLogger

WithOperation adds operation context

func (*StructuredLogger) WithService added in v1.12.1 

func (sl *StructuredLogger) WithService(serviceName string) *StructuredLogger

WithService adds service context

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.