log

package

v0.0.0-...-862e07f Latest Latest Go to latest Published: Jan 23, 2019 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.ppdv.net/go/util

Links

Open Source Insights

README ¶

Simple logging framework for go with SystemD support

Supports logging to file, syslog, systemd or stderr. Switchable loglevels. Alpha stage.

Documentation ¶

Overview ¶

Other drivers written from scratch and MIT-licensed.

simple logging framework for go with support for syslog, file (including os.Stderr) and SystemD journal.

Index ¶

func Alert(message string) error
func Alertf(format string, args ...interface{}) error
func Configured() bool
func Crit(message string) error
func Critf(format string, args ...interface{}) error
func Debug(message string) error
func Debugf(format string, args ...interface{}) error
func Emerg(message string) error
func Emergf(format string, args ...interface{}) error
func Err(message string) error
func Errf(format string, args ...interface{}) error
func Info(message string) error
func Infof(format string, args ...interface{}) error
func Log(priority Priority, depth int, message string) error
func Logf(priority Priority, depth int, format string, args ...interface{}) error
func Must(args ...interface{}) check.Values
func Must2(arg0, arg1 interface{}) interface{}
func Notice(message string) error
func Noticef(format string, args ...interface{}) error
func Panic(condition interface{}, args ...interface{})
func Trace(depth int) (file string, line int, fun string, ok bool)
func Warning(message string) error
func Warningf(format string, args ...interface{}) error
type Driver
- func ConfigureFile(path string, stdPriority Priority) (Driver, error)
- func ConfigureJournal(stdPriority Priority) (Driver, error)
- func ConfigureSyslog(network, raddr string, stdPriority syslog.Priority, tag string) (Driver, error)
- func ConfigureSyslogDefault() (Driver, error)
type DrvFile
- func (d *DrvFile) Close() error
- func (d *DrvFile) Rotate() error
- func (d *DrvFile) Write(p []byte) (n int, err error)
type DrvJournal
- func (d *DrvJournal) Close() error
- func (d *DrvJournal) Rotate() error
- func (d *DrvJournal) Write(p []byte) (n int, err error)
type DrvSyslog
- func (d DrvSyslog) Close() error
- func (d DrvSyslog) Rotate() error
type Priority
- func SetLevel(level Priority) Priority
- func (p Priority) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Alert ¶

func Alert(message string) error

Non-Sprintf variant of Alert, actually you can use Alertf without 3rd arg

func Alertf ¶

func Alertf(format string, args ...interface{}) error

Sends message with P_Alert if current loglevel permits, uses Sprintf

func Configured ¶

func Configured() bool

returns true if framework has configured driver

func Crit ¶

func Crit(message string) error

Non-Sprintf variant of Critf, actually you can use Critf without 3rd arg

func Critf ¶

func Critf(format string, args ...interface{}) error

Sends message with P_Crit if current loglevel permits, uses Sprintf

func Debug ¶

func Debug(message string) error

Non-Sprintf variant of Debugf, actually you can use Debugf without 3rd arg

func Debugf ¶

func Debugf(format string, args ...interface{}) error

Sends message with P_Debug if current loglevel permits, uses Sprintf

func Emerg ¶

func Emerg(message string) error

Non-Sprintf variant of Emergf, actually you can use Emerg without 3rd arg

func Emergf ¶

func Emergf(format string, args ...interface{}) error

Sends message with P_Emerg if current loglevel permits, uses Sprintf

func Err ¶

func Err(message string) error

Non-Sprintf variant of Errf, actually you can use Errf without 3rd arg

func Errf ¶

func Errf(format string, args ...interface{}) error

Sends message with P_Err if current loglevel permits, uses Sprintf

func Info ¶

func Info(message string) error

Non-Sprintf variant of Infof, actually you can use Infof without 3rd arg

func Infof ¶

func Infof(format string, args ...interface{}) error

Sends message with P_Info if current loglevel permits, uses Sprintf

func Log ¶

func Log(priority Priority, depth int, message string) error

non-sprintf variant of Logf()

func Logf ¶

func Logf(priority Priority, depth int, format string,
	args ...interface{}) error

Common function for sending log message with selected priority.

depth used for trace as in log.Output in standard logger. Uses fmt.Sprintf()

func Must ¶

func Must(args ...interface{}) check.Values

calls Panic() on last arg, returns remaining does nothing if no args given, returns nil if less than 2 args

func Must2 ¶

func Must2(arg0, arg1 interface{}) interface{}

calls Panic(arg1), returns arg0, useful for one-line type-assertion

func Notice ¶

func Notice(message string) error

Non-Sprintf variant of Noticef, actually you can use Noticef without 3rd arg

func Noticef ¶

func Noticef(format string, args ...interface{}) error

Sends message with P_Notice if current loglevel permits, uses Sprintf

func Panic ¶

func Panic(condition interface{}, args ...interface{})

Logs error and calls panic() if condition is non-nil error, true bool or any other type.

optional arguments, if given, must start from string and will be passed to fmt.Sprintf

func Warning ¶

func Warning(message string) error

Non-Sprintf variant of Warningf, actually you can use Warningf without 3rd arg

func Warningf ¶

func Warningf(format string, args ...interface{}) error

Sends message with P_Warning if current loglevel permits, uses Sprintf

Types ¶

type Driver ¶

type Driver interface {
	Close() error
	Rotate() error
	// contains filtered or unexported methods
}

Common driver type. Rotate() implemented only for file drivers. On other drivers Rotate() always returns nil and does nothing.

func ConfigureFile ¶

func ConfigureFile(path string, stdPriority Priority) (Driver, error)

Configures file log output. Uses os.Stderr if path is "", stdPriority is used for redirected standard logger. Output format is syslog-like, but shows priority instead of tag and pid. Output columns delimited by \t, so you can easily parse output with cut and other such tools.

func ConfigureJournal ¶

func ConfigureJournal(stdPriority Priority) (Driver, error)

Configures output to systemd journal, stdPriority used for standard logger

func ConfigureSyslog ¶

func ConfigureSyslog(network, raddr string, stdPriority syslog.Priority,
	tag string) (Driver, error)

Configures output to syslog, args passed to syslog.Dial(), stdPriority used for redirected standard logger

func ConfigureSyslogDefault ¶

func ConfigureSyslogDefault() (Driver, error)

Configures output to syslog with default values (LOG_DAEMON facility, LOG_WARNING priority for standard logger)

type DrvFile ¶

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

file driver type

func (*DrvFile) Close ¶

func (d *DrvFile) Close() error

Closes output file and switches output to stderr, does nothing if it's already stderr

func (*DrvFile) Rotate ¶

func (d *DrvFile) Rotate() error

Reopens log file if it is a file, switches logging to stderr if operation fails

func (*DrvFile) Write ¶

func (d *DrvFile) Write(p []byte) (n int, err error)

Used only for redirected standard logger, do not use directly

type DrvJournal ¶

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

type for journal driver

func (*DrvJournal) Close ¶

func (d *DrvJournal) Close() error

Closes journal connection

func (*DrvJournal) Rotate ¶

func (d *DrvJournal) Rotate() error

Does nothing

func (*DrvJournal) Write ¶

func (d *DrvJournal) Write(p []byte) (n int, err error)

Used only for standard logger, do not use directly

type DrvSyslog ¶

type DrvSyslog struct {
	*syslog.Writer
}

syslog driver type

func (DrvSyslog) Close ¶

func (d DrvSyslog) Close() error

Closes syslog connection

func (DrvSyslog) Rotate ¶

func (d DrvSyslog) Rotate() error