logger

package
v1.0.4 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2024 License: MIT Imports: 12 Imported by: 7

Documentation

Index

Constants

View Source 
const (
	FileLog = 1 << iota
	SysLog
)

Below logger types are supported.

View Source 
const SyslogTagPrefix = "vxos-asum@"

SyslogTagPrefix defines tag name for syslog.

Variables

View Source 
var (
	//ConsoleDebug logger for console and log Debug messages.
	ConsoleDebug ConsoleLogger
	//ConsoleInfo logger for console and log Info messages.
	ConsoleInfo ConsoleLogger
	//ConsoleWarning logger for console and log Warning messages.
	ConsoleWarning ConsoleLogger
	//ConsoleError logger for console and log Error messages.
	ConsoleError ConsoleLogger
	//Debug logger for logging Debug messages.
	Debug *log.Logger
	//Info logger for logging Info messages.
	Info *log.Logger
	//Warning logger for logging Warning messages.
	Warning *log.Logger
	//Error logger for logging Error messages.
	Error *log.Logger
)
View Source 
var DefaultLogDir = "/var/log/asum/"

DefaultLogDir used before reading conf file or cmdline params, and could be overridden by conf file or cmdline params.

View Source 
var DefaultLogFile = progname + ".log"

DefaultLogFile used before reading conf file or cmdline params, and could be overriden by conf file or cmdline params

View Source 
var DefaultLogLevel = "INFO"

DefaultLogLevel used in case if it's not specified in config or cmdline.

View Source 
var DefaultLogPath = DefaultLogDir + DefaultLogFile

DefaultLogPath used in case if path to log file is not specified in config or cmdline.

Functions

func CloseLogHandle added in v1.0.4 

func CloseLogHandle(handle LogHandle) error

CloseLogHandle closes log handler

func DeInitLogger added in v1.0.4 

func DeInitLogger() []error

DeInitLogger closes the log file and syslog handler

func GetLogDir added in v1.0.4 

func GetLogDir() string

GetLogDir provides location for storing logs.

func GetLogFile added in v1.0.4 

func GetLogFile() string

GetLogFile provides name of logfile.

func GetLogLevel added in v1.0.4 

func GetLogLevel() string

GetLogLevel provides log level.

func GetLogTag added in v1.0.4 

func GetLogTag() string

GetLogTag provides syslog tag name.

func InitFileLogger added in v1.0.4 

func InitFileLogger(logFile, logLevel string) error

InitFileLogger initializes logger with given log level.

func InitLogging added in v1.0.4 

func InitLogging()

InitLogging initializes logging to use syslog when its config exists, or to use file logging automatically. This setting might be overridden after reading config or cmdline parameters and by calling InitializeLogger().

func InitSysLogger added in v1.0.4 

func InitSysLogger(module, logLevel string) error

InitSysLogger initializes logger with given log level.

func InitializeLogger added in v1.0.4 

func InitializeLogger(config Config) error

InitializeLogger initializes customized file logger or syslog logger with given log config

func IsFileLogger added in v1.0.4 

func IsFileLogger() bool

IsFileLogger returns true if file log is initialized (and not syslog)

func IsSysLogConfigPresent added in v1.0.4 

func IsSysLogConfigPresent() bool

IsSysLogConfigPresent indicates whether syslog config is present.

func RegisterCommandOptions added in v1.0.4 

func RegisterCommandOptions(f *flag.FlagSet, defaultParams map[string]string)

RegisterCommandOptions registers the command options related to the log options.

Types

type Config added in v1.0.4 

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

Config is used to track user defined configuration.

func FileLogConfig added in v1.0.4 

func FileLogConfig(level, file, module string) Config

FileLogConfig Setup FileLog Config

func SyslogConfig added in v1.0.4 

func SyslogConfig(level, module string) Config

SyslogConfig Setup SysLog Config

type ConsoleLogger added in v1.0.4 

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

ConsoleLogger will print message on screen and write to log file The message will always be printed regardless the log level The writing action depends on the log level

func (*ConsoleLogger) PrintNReturnError added in v1.0.4 

func (consoleLog *ConsoleLogger) PrintNReturnError(msg string, args ...interface{}) error

PrintNReturnError calls Printf and returns wrapped message as error

func (*ConsoleLogger) Printf added in v1.0.4 

func (consoleLog *ConsoleLogger) Printf(msg string, args ...interface{})

Printf prints message in console and writes to log file

type FileLogHandle added in v1.0.4 

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

FileLogHandle the file log handler

func (*FileLogHandle) Close added in v1.0.4 

func (handle *FileLogHandle) Close() error

Close close the FileLog handler.

func (*FileLogHandle) Write added in v1.0.4 

func (handle *FileLogHandle) Write(p []byte) (n int, err error)

type LogHandle added in v1.0.4 

type LogHandle interface {
	Write(p []byte) (n int, err error)
	Close() error
}

LogHandle the log handle interface

type Logger added in v1.0.4 

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

Logger implements functions for all log levels

func Get added in v1.0.4 

func Get() *Logger

Get returns the object of logger type

func (*Logger) Debug added in v1.0.4 

func (logger *Logger) Debug() *log.Logger

Debug returns the debug logger

func (*Logger) Error added in v1.0.4 

func (logger *Logger) Error() *log.Logger

Error returns te error logger

func (*Logger) Info added in v1.0.4 

func (logger *Logger) Info() *log.Logger

Info returns the info logger

func (*Logger) Warning added in v1.0.4 

func (logger *Logger) Warning() *log.Logger

Warning returns the warning logger

type Type added in v1.0.4 

type Type int

Type is used to track logger type

Source Files

View all Source files

Directories

Path Synopsis
module

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.