logger

package

v2.0.1 Latest Latest Go to latest Published: Jul 3, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/c2pc/go-pkg

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Debug(stdout bool, msg string)
func DebugLog(ctx context.Context, module string, msg string)
func Debugf(stdout bool, msg string, args ...interface{})
func DebugfLog(ctx context.Context, module string, msg string, args ...interface{})
func Error(stdout bool, msg string)
func ErrorLog(ctx context.Context, module string, msg string)
func Errorf(stdout bool, msg string, args ...interface{})
func ErrorfLog(ctx context.Context, module string, msg string, args ...interface{})
func Fatal(stdout bool, msg string)
func FatalLog(ctx context.Context, module string, msg string)
func Fatalf(stdout bool, msg string, args ...interface{})
func FatalfLog(ctx context.Context, module string, msg string, args ...interface{})
func HandleWarningMessages(stdout bool, warnings []string)
func HandleWarningMessagesLog(ctx context.Context, module string, warnings []string)
func Info(stdout bool, msg string)
func InfoLog(ctx context.Context, module string, msg string)
func Infof(stdout bool, msg string, args ...interface{})
func InfofLog(ctx context.Context, module string, msg string, args ...interface{})
func Initialize(mr bool, logLevel string, customLogsDir string)
func Warning(stdout bool, msg string)
func WarningLog(ctx context.Context, module string, msg string)
func Warningf(stdout bool, msg string, args ...interface{})
func WarningfLog(ctx context.Context, module string, msg string, args ...interface{})
func WithOperationID(ctx context.Context, msg string) string
type LogInfo
type LogWriter
- func NewLogWriter(LoggerID string, stdout bool, stream int) *LogWriter
type OutMessage
- func (out *OutMessage) ToJSON() (string, error)
type Writer
- func (w Writer) Write(p []byte) (int, error)

Constants ¶

View Source

const (
	ModuleID = "LOG"
)

Variables ¶

View Source

var ActiveLogFile string

ActiveLogFile log file represents the file which will be used for the backend logging

Functions ¶

func Debug ¶

func Debug(stdout bool, msg string)

Debug logs DEBUG messages. stdout flag indicates if message is to be written to stdout in addition to log.

func DebugLog ¶

func DebugLog(ctx context.Context, module string, msg string)

func Debugf ¶

func Debugf(stdout bool, msg string, args ...interface{})

Debugf logs DEBUG messages. stdout flag indicates if message is to be written to stdout in addition to log.

func DebugfLog ¶

func DebugfLog(ctx context.Context, module string, msg string, args ...interface{})

func Error ¶

func Error(stdout bool, msg string)

Error logs ERROR messages. stdout flag indicates if message is to be written to stdout in addition to log.

func ErrorLog ¶

func ErrorLog(ctx context.Context, module string, msg string)

func Errorf ¶

func Errorf(stdout bool, msg string, args ...interface{})

Errorf logs ERROR messages. stdout flag indicates if message is to be written to stdout in addition to log.

func ErrorfLog ¶

func ErrorfLog(ctx context.Context, module string, msg string, args ...interface{})

func Fatal ¶

func Fatal(stdout bool, msg string)

Fatal logs CRITICAL messages and exits. stdout flag indicates if message is to be written to stdout in addition to log.

func FatalLog ¶

func FatalLog(ctx context.Context, module string, msg string)

func Fatalf ¶

func Fatalf(stdout bool, msg string, args ...interface{})

Fatalf logs CRITICAL messages and exits. stdout flag indicates if message is to be written to stdout in addition to log.

func FatalfLog ¶

func FatalfLog(ctx context.Context, module string, msg string, args ...interface{})

func HandleWarningMessages ¶

func HandleWarningMessages(stdout bool, warnings []string)

HandleWarningMessages logs multiple messages in WARNING mode

func HandleWarningMessagesLog ¶

func HandleWarningMessagesLog(ctx context.Context, module string, warnings []string)

func Info ¶

func Info(stdout bool, msg string)

Info logs INFO messages. stdout flag indicates if message is to be written to stdout in addition to log.

func InfoLog ¶

func InfoLog(ctx context.Context, module string, msg string)

func Infof ¶

func Infof(stdout bool, msg string, args ...interface{})

Infof logs INFO messages. stdout flag indicates if message is to be written to stdout in addition to log.

func InfofLog ¶

func InfofLog(ctx context.Context, module string, msg string, args ...interface{})

func Initialize ¶

func Initialize(mr bool, logLevel string, customLogsDir string)

Initialize logger with given level

func Warning ¶

func Warning(stdout bool, msg string)

Warning logs WARNING messages. stdout flag indicates if message is to be written to stdout in addition to log.

func WarningLog ¶

func WarningLog(ctx context.Context, module string, msg string)

func Warningf ¶

func Warningf(stdout bool, msg string, args ...interface{})

Warningf logs WARNING messages. stdout flag indicates if message is to be written to stdout in addition to log.

func WarningfLog ¶

func WarningfLog(ctx context.Context, module string, msg string, args ...interface{})

func WithOperationID ¶

func WithOperationID(ctx context.Context, msg string) string

Types ¶

type LogInfo ¶

type LogInfo struct {
	LogLevel string `json:"logLevel"`
	Message  string `json:"message"`
}

LogInfo represents the log message structure for plugins

type LogWriter ¶

type LogWriter struct {
	Stderr io.Writer
	Stdout io.Writer
}

LogWriter represents the type which consists of two custom writers

func NewLogWriter ¶

func NewLogWriter(LoggerID string, stdout bool, stream int) *LogWriter

NewLogWriter creates a new logWriter for given id

type OutMessage ¶

type OutMessage struct {
	MessageType string `json:"type"`
	Message     string `json:"message"`
}

OutMessage contains information for output log

func (*OutMessage) ToJSON ¶

func (out *OutMessage) ToJSON() (string, error)

ToJSON converts OutMessage into JSON

type Writer ¶

type Writer struct {
	LoggerID            string
	ShouldWriteToStdout bool

	File io.Writer
	// contains filtered or unexported fields
}

Writer represents to a custom writer. It intercepts the log messages and redirects them to logger according the log level given in info

func (Writer) Write ¶

func (w Writer) Write(p []byte) (int, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL