log

README

ion-log

QuickStart

package main

import (
	log "github.com/pion/ion-log"
)

func init() {
	log.Init("debug")
}

func main() {
	log.Infof("Hello ION!")
}

Feature

GoodFormat:

[date time]  [Level] [Prefix]: [file:line] [Func] YourLog fields=value

[2021-05-06 09:54:49.658]  INFO default: [log_test.go:19] [ion-log_test.TestDefaultLogger] log with format ION somefield=foo

Documentation

Index

• func Debugf(format string, v ...interface{})
• func Errorf(format string, v ...interface{})
• func GetLoggers() map[string]*MyLogger
• func Infof(format string, v ...interface{})
• func Init(level string)
• func NewLogger(level Level, prefix string) *logrus.Logger
• func NewLoggerWithFields(level Level, prefix string, fields Fields) *logrus.Logger
• func Panicf(format string, v ...interface{})
• func SetLogLevel(prefix string, level Level) error
• func Tracef(format string, v ...interface{})
• func Warnf(format string, v ...interface{})
• type ColorScheme
• type Fields
• type Level
  • func StringToLevel(level string) Level
• type MyLogger
  • func (ml *MyLogger) Level() string
  • func (ml *MyLogger) Prefix() string
  • func (ml *MyLogger) SetLevel(level Level)
• type TextFormatter
  • func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error)
  • func (f *TextFormatter) SetColorScheme(colorScheme *ColorScheme)

Functions

func Debugf

func Debugf(format string, v ...interface{})

Debugf logs a formatted debug level log to the console

func Errorf

func Errorf(format string, v ...interface{})

Errorf logs a formatted error level log to the console

func GetLoggers

func GetLoggers() map[string]*MyLogger

func Infof

func Infof(format string, v ...interface{})

Infof logs a formatted info level log to the console

func Init

func Init(level string)

func NewLogger

func NewLogger(level Level, prefix string) *logrus.Logger

func NewLoggerWithFields

func NewLoggerWithFields(level Level, prefix string, fields Fields) *logrus.Logger

func Panicf

func Panicf(format string, v ...interface{})

Panicf logs a formatted panic level log to the console. The panic() function is called, which stops the ordinary flow of a goroutine.

func SetLogLevel

func SetLogLevel(prefix string, level Level) error

func Tracef

func Tracef(format string, v ...interface{})

Tracef logs a formatted debug level log to the console

func Warnf

func Warnf(format string, v ...interface{})

Warnf logs a formatted warn level log to the console

Types

type ColorScheme

type ColorScheme struct {
	InfoLevelStyle  string
	WarnLevelStyle  string
	ErrorLevelStyle string
	FatalLevelStyle string
	PanicLevelStyle string
	DebugLevelStyle string
	PrefixStyle     string
	TimestampStyle  string
}

type Fields

type Fields map[string]interface{}

type Level

type Level uint32

Level type

const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel Level = iota
	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
	// TraceLevel level. Designates finer-grained informational events than the Debug.
	TraceLevel
)

These are the different logging levels. You can set the logging level to log on your instance of logger, obtained with `logrus.New()`.

func StringToLevel

func StringToLevel(level string) Level

type MyLogger

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

func (*MyLogger) Level

func (ml *MyLogger) Level() string

func (*MyLogger) Prefix

func (ml *MyLogger) Prefix() string

func (*MyLogger) SetLevel

func (ml *MyLogger) SetLevel(level Level)

type TextFormatter

type TextFormatter struct {
	Prefix string

	Fields Fields

	// Set to true to bypass checking for a TTY before outputting colors.
	ForceColors bool

	// Force disabling colors. For a TTY colors are enabled by default.
	DisableColors bool

	// Force formatted layout, even for non-TTY output.
	ForceFormatting bool

	// Disable timestamp logging. useful when output is redirected to logging
	// system that already adds timestamps.
	DisableTimestamp bool

	// Disable the conversion of the log levels to uppercase
	DisableUppercase bool

	// Enable logging the full timestamp when a TTY is attached instead of just
	// the time passed since beginning of execution.
	FullTimestamp bool

	// Timestamp format to use for display when a full timestamp is printed.
	TimestampFormat string

	// The fields are sorted by default for a consistent output. For applications
	// that log extremely frequently and don't use the JSON formatter this may not
	// be desired.
	DisableSorting bool

	// Wrap empty fields in quotes if true.
	QuoteEmptyFields bool

	// Can be set to the override the default quoting character "
	// with something else. For example: ', or `.
	QuoteCharacter string

	// Pad msg field with spaces on the right for display.
	// The value for this parameter will be the size of padding.
	// Its default value is zero, which means no padding will be applied for msg.
	SpacePadding int

	sync.Once
	// contains filtered or unexported fields
}

func (*TextFormatter) Format

func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error)

func (*TextFormatter) SetColorScheme

func (f *TextFormatter) SetColorScheme(colorScheme *ColorScheme)