logger

Documentation

Overview

Package logger provides functions to log on different levels/severities. Levels have a canonical ordering and there is support silencing log statements with levels below a given threshold.

Index

• func Debug(v ...interface{})
• func Error(v ...interface{})
• func Info(v ...interface{})
• func Success(v ...interface{})
• func Warn(v ...interface{})
• type Level
  • func (l *Level) Set(val string) error
  • func (l *Level) String() string
  • func (l *Level) Type() string

Examples

• Debug
• Error
• Info
• Level
• Level.Set
• Success
• Warn

Functions

func Debug

func Debug(v ...interface{})

Debug logging.

Example

Log on "debug" level.

package main

import (
	"github.com/bpicode/fritzctl/logger"
)

func main() {
	logger.Debug("debug message")
}

func Error

func Error(v ...interface{})

Error logging in red.

Example

Log on "error" level.

package main

import (
	"github.com/bpicode/fritzctl/logger"
)

func main() {
	logger.Error("an error occurred")
}

func Info

func Info(v ...interface{})

Info logging.

Example

Log on "info" level.

package main

import (
	"github.com/bpicode/fritzctl/logger"
)

func main() {
	logger.Info("informational message")
}

func Success

func Success(v ...interface{})

Success logging in green.

Example

Log on "success" level.

package main

import (
	"github.com/bpicode/fritzctl/logger"
)

func main() {
	logger.Success("successfully reached a milestone in my program flow")
}

func Warn

func Warn(v ...interface{})

Warn logging in yellow.

Example

Log on "warn" level.

package main

import (
	"github.com/bpicode/fritzctl/logger"
)

func main() {
	logger.Warn("a warning")
}

Types

type Level

type Level struct {
}

Level represents a Value for different logging configs.

Example

Level can be used with the flag package.

package main

import (
	"flag"

	"github.com/bpicode/fritzctl/logger"
)

func main() {
	l := logger.Level{}
	flag.Var(&l, "log", "logging verbosity, e.g. 'info'")
	flag.Parse()
}

func (*Level) Set

func (l *Level) Set(val string) error

Set configures the loglevel for the application.

Example

Logging can be turned off manually.

package main

import (
	"github.com/bpicode/fritzctl/logger"
)

func main() {
	l := &logger.Level{}
	l.Set("none")
	logger.Warn("log statement")
}

func (*Level) String

func (l *Level) String() string

String represents the default value.

func (*Level) Type

func (l *Level) Type() string

Type returns a name for the value type.