logging

Documentation

Index

• Constants
• func AddFields(ctx context.Context, fields Fields) context.Context
• func Level() string
• func SetLevel(level string)
• func SetOutputFormat(format string)
• func SetOutputs(outputs []string, fileMaxSizeMB, filesKeep int)
• type AWSAdapter
  • func (l *AWSAdapter) Log(vars ...interface{})
• type DummyLogger
  • func (d DummyLogger) Debug(args ...interface{})
  • func (d DummyLogger) Debugf(format string, args ...interface{})
  • func (d DummyLogger) Error(args ...interface{})
  • func (d DummyLogger) Errorf(format string, args ...interface{})
  • func (d DummyLogger) Fatal(args ...interface{})
  • func (d DummyLogger) Fatalf(format string, args ...interface{})
  • func (d DummyLogger) Info(args ...interface{})
  • func (d DummyLogger) Infof(format string, args ...interface{})
  • func (d DummyLogger) IsTracing() bool
  • func (d DummyLogger) Log(level logrus.Level, args ...interface{})
  • func (d DummyLogger) Logf(level logrus.Level, format string, args ...interface{})
  • func (d DummyLogger) Panic(args ...interface{})
  • func (d DummyLogger) Panicf(format string, args ...interface{})
  • func (d DummyLogger) Trace(args ...interface{})
  • func (d DummyLogger) Tracef(format string, args ...interface{})
  • func (d DummyLogger) Warn(args ...interface{})
  • func (d DummyLogger) Warnf(format string, args ...interface{})
  • func (d DummyLogger) Warning(args ...interface{})
  • func (d DummyLogger) Warningf(format string, args ...interface{})
  • func (d DummyLogger) WithContext(ctx context.Context) Logger
  • func (d DummyLogger) WithError(err error) Logger
  • func (d DummyLogger) WithField(key string, value interface{}) Logger
  • func (d DummyLogger) WithFields(fields Fields) Logger
• type Fields
• type Logger
  • func Default() Logger
  • func Dummy() Logger
  • func FromContext(ctx context.Context) Logger

Constants

const (
	LogFieldsContextKey = contextKey("log_fields")

	ProjectDirectoryName = "lakefs"
	ModuleName           = "github.com/treeverse/lakefs"
)

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

Functions

func AddFields

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

func Level

func Level() string

func SetLevel

func SetLevel(level string)

func SetOutputFormat

func SetOutputFormat(format string)

func SetOutputs

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

Types

type AWSAdapter

type AWSAdapter struct {
	Logger Logger
}

func (*AWSAdapter) Log

func (l *AWSAdapter) Log(vars ...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) IsTracing

func (d DummyLogger) IsTracing() bool

func (DummyLogger) Log

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

func (DummyLogger) Logf

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{}

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
}

func Default

func Default() Logger

func Dummy

func Dummy() Logger

func FromContext

func FromContext(ctx context.Context) Logger