logger

Documentation

Index

• Variables
• func OpenLogFile(config LogFileConfig) (*os.File, error)
• type LogFileConfig
• type Logger
  • func NewLogger(args NewLoggerArgs) Logger
• type NewLoggerArgs

Variables

var (
	// Default is the default logger used by the application.
	Default = NewLogger(NewLoggerArgs{
		Format: "text",
	})
)

Functions

func OpenLogFile

func OpenLogFile(config LogFileConfig) (*os.File, error)

OpenLogFile opens a log file for the workflow.

Types

type LogFileConfig

type LogFileConfig struct {
	Prefix    string
	LogDir    string
	DAGLogDir string
	DAGName   string
	RequestID string
}

LogFileConfig holds the configuration for opening a log file

type Logger

type Logger interface {
	Debug(msg string, tags ...any)
	Info(msg string, tags ...any)
	Warn(msg string, tags ...any)
	Error(msg string, tags ...any)
	Fatal(msg string, tags ...any)

	Debugf(format string, v ...any)
	Infof(format string, v ...any)
	Warnf(format string, v ...any)
	Errorf(format string, v ...any)
	Fatalf(format string, v ...any)

	With(attrs ...any) Logger
	WithGroup(name string) Logger

	// Write writes a free-form message to the logger.
	// It writes to the standard output and to the log file if present.
	// If the log file is not present, it writes only to the standard output.
	Write(string)
}

func NewLogger

func NewLogger(args NewLoggerArgs) Logger

type NewLoggerArgs

type NewLoggerArgs struct {
	Debug   bool
	Format  string
	LogFile *os.File
	Quiet   bool
}