log

Documentation

Overview

Package log provides the both file and console (general) logging capabilities to spacemesh modules such as app and identity.

Index

• Variables
• func Debug(msg string, args ...interface{})
• func DebugMode(mode bool)
• func Error(msg string, args ...interface{})
• func Info(msg string, args ...interface{})
• func InitSpacemeshLoggingSystemWithHooks(hooks ...func(zapcore.Entry) error)
• func JSONLog(b bool)
• func Level() zapcore.Level
• func Panic(msg string, args ...interface{})
• func Warning(msg string, args ...interface{})
• type Field
  • func Bool(name string, val bool) Field
  • func Duration(name string, val time.Duration) Field
  • func Err(v error) Field
  • func FieldNamed(name string, field LoggableField) Field
  • func Int(name string, val int) Field
  • func Int32(name string, val int32) Field
  • func Namespace(name string) Field
  • func String(name, val string) Field
  • func Uint32(name string, val uint32) Field
  • func Uint64(name string, val uint64) Field
  • func (f Field) Field() Field
• type FieldLogger
  • func Event() FieldLogger
  • func With() FieldLogger
  • func (fl FieldLogger) Debug(msg string, fields ...LoggableField)
  • func (fl FieldLogger) Error(msg string, fields ...LoggableField)
  • func (fl FieldLogger) Info(msg string, fields ...LoggableField)
  • func (fl FieldLogger) Warning(msg string, fields ...LoggableField)
• type Log
  • func NewDefault(module string) Log
  • func NewFromLog(l *zap.Logger) Log
  • func NewWithLevel(module string, level zap.AtomicLevel, hooks ...func(zapcore.Entry) error) Log
  • func (l Log) Debug(format string, args ...interface{})
  • func (l Log) Error(format string, args ...interface{})
  • func (l Log) Event() FieldLogger
  • func (l Log) Info(format string, args ...interface{})
  • func (l Log) Panic(format string, args ...interface{})
  • func (l Log) SetLevel(level *zap.AtomicLevel) Log
  • func (l Log) Warning(format string, args ...interface{})
  • func (l Log) With() FieldLogger
  • func (l Log) WithFields(fields ...LoggableField) Log
  • func (l Log) WithName(prefix string) Log
  • func (l Log) WithOptions(opts ...zap.Option) Log
• type LoggableField
• type Logger

Variables

var Nop = zap.WrapCore(func(zapcore.Core) zapcore.Core {
	return zapcore.NewNopCore()
})

Nop is an option that disables this logger.

Functions

func Debug

func Debug(msg string, args ...interface{})

Debug prints formatted debug level log message.

func DebugMode

func DebugMode(mode bool)

DebugMode sets log debug level

func Error

func Error(msg string, args ...interface{})

Error prints formatted error level log message.

func Info

func Info(msg string, args ...interface{})

Info prints formatted info level log message.

func InitSpacemeshLoggingSystemWithHooks

func InitSpacemeshLoggingSystemWithHooks(hooks ...func(zapcore.Entry) error)

InitSpacemeshLoggingSystemWithHooks sets up a logging system with one or more registered hooks

func JSONLog

func JSONLog(b bool)

JSONLog turns JSON format on or off

func Level

func Level() zapcore.Level

Level returns the zapcore level of logging.

func Panic

func Panic(msg string, args ...interface{})

Panic writes the log message and then panics.

func Warning

func Warning(msg string, args ...interface{})

Warning prints formatted warning level log message.

Types

type Field

type Field zap.Field

Field is a log field holding a name and value

func Bool

func Bool(name string, val bool) Field

Bool returns a bool field

func Duration

func Duration(name string, val time.Duration) Field

Duration returns a duration field

func Err

func Err(v error) Field

Err returns an error field

func FieldNamed

func FieldNamed(name string, field LoggableField) Field

FieldNamed returns a field with the provided name instead of the default.

func Int

func Int(name string, val int) Field

Int returns an int Field.

func Int32

func Int32(name string, val int32) Field

Int32 returns an int32 Field.

func Namespace

func Namespace(name string) Field

Namespace make next fields be inside a namespace.

func String

func String(name, val string) Field

String returns a string Field

func Uint32

func Uint32(name string, val uint32) Field

Uint32 returns an uint32 Field.

func Uint64

func Uint64(name string, val uint64) Field

Uint64 returns an uint64 Field

func (Field) Field

func (f Field) Field() Field

Field satisfy loggable field interface.

type FieldLogger

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

FieldLogger is a logger that only logs messages with fields. It does not support formatting.

func Event

func Event() FieldLogger

Event returns a field logger with the Event field set to true.

func With

func With() FieldLogger

With returns a FieldLogger which you can append fields to.

func (FieldLogger) Debug

func (fl FieldLogger) Debug(msg string, fields ...LoggableField)

Debug prints message with fields

func (FieldLogger) Error

func (fl FieldLogger) Error(msg string, fields ...LoggableField)

Error prints message with fields

func (FieldLogger) Info

func (fl FieldLogger) Info(msg string, fields ...LoggableField)

Info prints message with fields

func (FieldLogger) Warning

func (fl FieldLogger) Warning(msg string, fields ...LoggableField)

Warning prints message with fields

type Log

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

Log is an exported type that embeds our logger.

var AppLog Log

AppLog is the local app singleton logger.

func NewDefault

func NewDefault(module string) Log

NewDefault creates a Log with the default log level

func NewFromLog

func NewFromLog(l *zap.Logger) Log

NewFromLog creates a Log from an existing zap-compatible log.

func NewWithLevel

func NewWithLevel(module string, level zap.AtomicLevel, hooks ...func(zapcore.Entry) error) Log

NewWithLevel creates a logger with a fixed level and with a set of (optional) hooks

func (Log) Debug

func (l Log) Debug(format string, args ...interface{})

Debug prints formatted debug level log message.

func (Log) Error

func (l Log) Error(format string, args ...interface{})

Error prints formatted error level log message.

func (Log) Event

func (l Log) Event() FieldLogger

Event returns a logger with the Event field appended to it.

func (Log) Info

func (l Log) Info(format string, args ...interface{})

Info prints formatted info level log message.

func (Log) Panic

func (l Log) Panic(format string, args ...interface{})

Panic prints the log message and then panics.

func (Log) SetLevel

func (l Log) SetLevel(level *zap.AtomicLevel) Log

SetLevel returns a logger with level as the log level derived from l.

func (Log) Warning

func (l Log) Warning(format string, args ...interface{})

Warning prints formatted warning level log message.

func (Log) With

func (l Log) With() FieldLogger

With returns a logger object that logs fields

func (Log) WithFields

func (l Log) WithFields(fields ...LoggableField) Log

WithFields returns a logger with fields permanently appended to it.

func (Log) WithName

func (l Log) WithName(prefix string) Log

WithName returns a logger with the given name

func (Log) WithOptions

func (l Log) WithOptions(opts ...zap.Option) Log

WithOptions clones the current Logger, applies the supplied Options, and returns the resulting Logger. It's safe to use concurrently.

type LoggableField

type LoggableField interface {
	Field() Field
}

LoggableField as an interface to enable every type to be used as a log field.

type Logger

type Logger interface {
	Info(format string, args ...interface{})
	Debug(format string, args ...interface{})
	Error(format string, args ...interface{})
	Warning(format string, args ...interface{})
	WithName(prefix string) Log
}

Logger is an interface for our logging API.