logging

package
v1.30.0 Latest Latest
Warning

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

 Go to latest Published: Jul 26, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	LogFieldsContextKey = contextKey("log_fields")

	ProjectDirectoryName = "lakefs"
	ModuleName           = "github.com/treeverse/lakefs"
)
View Source 
const (
	// RepositoryFieldKey repository name (string)
	RepositoryFieldKey = "repository"
	// MatchedHostFieldKey matched host (bool) true when domain extracted from host
	MatchedHostFieldKey = "matched_host"
	// RefHostFieldKey reference id (string)
	RefHostFieldKey = "ref"
	// PathFieldKey path / request URI (string)
	PathFieldKey = "path"
	// UploadIDFieldKey s3 multipart upload ID (string) "upload_id"
	UploadIDFieldKey = "upload_id"
	// ListTypeFieldKey s3 list type version (string, ex: v1 or v2)
	ListTypeFieldKey = "list_type"
	// PhysicalAddressFieldKey object physical address (string)
	PhysicalAddressFieldKey = "physical_address"
	// PartNumberFieldKey s3 multipart upload part number (string)
	PartNumberFieldKey = "part_number"
	// RequestIDFieldKey request ID (string) based on the request ID found on context
	RequestIDFieldKey = "request_id"
	// HostFieldKey request's host (string)
	HostFieldKey = "host"
	// MethodFieldKey request's method (string)
	MethodFieldKey = "method"
	// UserFieldKey user's name associated with the request (string)
	UserFieldKey = "user"
	// ServiceNameFieldKey service name (string, ex: rest_api)
	ServiceNameFieldKey = "service_name"
	// LogAudit kind of information to audit (string, ex: API)
	LogAudit = "log_audit"
)

log_fields keys

Variables

This section is empty.

Functions

func AddFields 

func AddFields(ctx context.Context, fields Fields) context.Context

func CloseWriters added in v1.2.0 

func CloseWriters() error

func GetLogFileOutputPath added in v1.28.0 

func GetLogFileOutputPath(outputs []string) string

func HasLogFileOutput added in v1.28.0 

func HasLogFileOutput(outputs []string) bool

func Level 

func Level() string

func SetLevel added in v0.40.2 

func SetLevel(level string)

func SetOutputFormat added in v0.40.2 

func SetOutputFormat(format string, opts ...OutputFormatOptionFunc)

func SetOutputs added in v0.60.1 

func SetOutputs(outputs []string, fileMaxSizeMB, filesKeep int) error

Types

type AWSAdapter added in v0.40.2 

type AWSAdapter struct {
	Logger Logger
}

func (*AWSAdapter) Logf added in v0.110.0 

func (l *AWSAdapter) Logf(classification logging.Classification, format string, v ...interface{})

type DummyLogger 

type DummyLogger struct{}

func (DummyLogger) Debug 

func (d DummyLogger) Debug(args ...interface{})

func (DummyLogger) Debugf 

func (d DummyLogger) Debugf(format string, args ...interface{})

func (DummyLogger) Error 

func (d DummyLogger) Error(args ...interface{})

func (DummyLogger) Errorf 

func (d DummyLogger) Errorf(format string, args ...interface{})

func (DummyLogger) Fatal 

func (d DummyLogger) Fatal(args ...interface{})

func (DummyLogger) Fatalf 

func (d DummyLogger) Fatalf(format string, args ...interface{})

func (DummyLogger) Info 

func (d DummyLogger) Info(args ...interface{})

func (DummyLogger) Infof 

func (d DummyLogger) Infof(format string, args ...interface{})

func (DummyLogger) IsDebugging added in v0.93.0 

func (d DummyLogger) IsDebugging() bool

func (DummyLogger) IsError added in v0.93.0 

func (d DummyLogger) IsError() bool

func (DummyLogger) IsInfo added in v0.93.0 

func (d DummyLogger) IsInfo() bool

func (DummyLogger) IsTracing 

func (d DummyLogger) IsTracing() bool

func (DummyLogger) IsWarn added in v0.93.0 

func (d DummyLogger) IsWarn() bool

func (DummyLogger) Log added in v0.68.0 

func (d DummyLogger) Log(level logrus.Level, args ...interface{})

func (DummyLogger) Logf added in v0.68.0 

func (d DummyLogger) Logf(level logrus.Level, format string, args ...interface{})

func (DummyLogger) Panic 

func (d DummyLogger) Panic(args ...interface{})

func (DummyLogger) Panicf 

func (d DummyLogger) Panicf(format string, args ...interface{})

func (DummyLogger) Trace 

func (d DummyLogger) Trace(args ...interface{})

func (DummyLogger) Tracef 

func (d DummyLogger) Tracef(format string, args ...interface{})

func (DummyLogger) Warn 

func (d DummyLogger) Warn(args ...interface{})

func (DummyLogger) Warnf 

func (d DummyLogger) Warnf(format string, args ...interface{})

func (DummyLogger) Warning 

func (d DummyLogger) Warning(args ...interface{})

func (DummyLogger) Warningf 

func (d DummyLogger) Warningf(format string, args ...interface{})

func (DummyLogger) WithContext 

func (d DummyLogger) WithContext(ctx context.Context) Logger

func (DummyLogger) WithError 

func (d DummyLogger) WithError(err error) Logger

func (DummyLogger) WithField 

func (d DummyLogger) WithField(key string, value interface{}) Logger

func (DummyLogger) WithFields 

func (d DummyLogger) WithFields(fields Fields) Logger

type Fields 

type Fields map[string]interface{}

func GetFieldsFromContext added in v1.12.0 

func GetFieldsFromContext(ctx context.Context) Fields

GetFieldsFromContext returns the logging fields on ctx or nil.

type Logger 

type Logger interface {
	WithContext(ctx context.Context) Logger
	WithField(key string, value interface{}) Logger
	WithFields(fields Fields) Logger
	WithError(err error) Logger
	Trace(args ...interface{})
	Debug(args ...interface{})
	Info(args ...interface{})
	Warn(args ...interface{})
	Warning(args ...interface{})
	Error(args ...interface{})
	Fatal(args ...interface{})
	Panic(args ...interface{})
	Log(level logrus.Level, args ...interface{})
	Tracef(format string, args ...interface{})
	Debugf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Warnf(format string, args ...interface{})
	Warningf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Fatalf(format string, args ...interface{})
	Panicf(format string, args ...interface{})
	Logf(level logrus.Level, format string, args ...interface{})
	IsTracing() bool
	IsDebugging() bool
	IsInfo() bool
	IsError() bool
	IsWarn() bool
}

func ContextUnavailable added in v0.105.0 

func ContextUnavailable() Logger

ContextUnavailable returns a Logger when no context is available. It should be used only in code during startup, teardown, or tests. Prefer to use Default().

func Dummy 

func Dummy() Logger

func FromContext 

func FromContext(ctx context.Context) Logger

FromContext returns a Logger for reporting logs during ctx. This logger will typically include request IDs from the context.

type OutputFormatOptionFunc added in v0.104.0 

type OutputFormatOptionFunc func(options *OutputFormatOptions)

type OutputFormatOptions added in v0.104.0 

type OutputFormatOptions struct {
	CallerPrettyfier func(*runtime.Frame) (function string, file string)
}

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.