logger

Documentation

Index

• Constants
• Variables
• func Debug(stdout bool, msg string)
• func Debugf(stdout bool, msg string, args ...interface{})
• func Error(stdout bool, msg string)
• func Errorf(stdout bool, msg string, args ...interface{})
• func Fatal(stdout bool, msg string)
• func Fatalf(stdout bool, msg string, args ...interface{})
• func HandleWarningMessages(stdout bool, warnings []string)
• func Info(stdout bool, msg string)
• func Infof(stdout bool, msg string, args ...interface{})
• func Initialize(mr bool, logLevel string, c int)
• func Warning(stdout bool, msg string)
• func Warningf(stdout bool, msg string, args ...interface{})
• type CustomWriter
  • func NewCustomWriter(portChan chan string, outFile io.Writer, id string, isErrorStream bool) CustomWriter
  • func (w CustomWriter) Write(p []byte) (n int, err error)
• 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

const (

	// CLI indicates gauge is used as a CLI.
	CLI = iota
	// API indicates gauge is in daemon mode. Used in IDEs.
	API
	// LSP indicates that gauge is acting as an LSP server.
	LSP
)

Variables

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 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 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 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 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 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 HandleWarningMessages

func HandleWarningMessages(stdout bool, warnings []string)

HandleWarningMessages logs multiple messages in WARNING mode

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 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 Initialize

func Initialize(mr bool, logLevel string, c int)

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 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.

Types

type CustomWriter

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

func NewCustomWriter

func NewCustomWriter(portChan chan string, outFile io.Writer, id string, isErrorStream bool) CustomWriter

func (CustomWriter) Write

func (w CustomWriter) Write(p []byte) (n int, err error)

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)