log

Documentation

Index

• type Loggable
• type Logger
  • func (l *Logger) CreateSystemLogger(systemName string) Logger
  • func (l *Logger) CreateTraceLogger(traceID string) zerolog.Logger
  • func (l *Logger) LogComponents(target Loggable, level zerolog.Level)
  • func (l *Logger) LogEntity(level zerolog.Level, entityID entity.ID, archID archetype.ID, ...)
  • func (l *Logger) LogSystem(target Loggable, level zerolog.Level)
  • func (l *Logger) LogWorld(target Loggable, level zerolog.Level)

Types

type Loggable

type Loggable interface {
	GetComponents() []component.ComponentMetadata
	GetSystemNames() []string
}

type Logger

type Logger struct {
	*zerolog.Logger
}

func (*Logger) CreateSystemLogger

func (l *Logger) CreateSystemLogger(systemName string) Logger

CreateSystemLogger creates a Sub Logger with the entry {"system" : systemName}.

func (*Logger) CreateTraceLogger

func (l *Logger) CreateTraceLogger(traceID string) zerolog.Logger

CreateTraceLogger Creates a trace Logger. Using a single id you can use this Logger to follow and log a data path.

func (*Logger) LogComponents

func (l *Logger) LogComponents(target Loggable, level zerolog.Level)

LogComponents logs all component info related to the world.

func (*Logger) LogEntity

func (l *Logger) LogEntity(
	level zerolog.Level, entityID entity.ID, archID archetype.ID,
	components []component.ComponentMetadata,
)

LogEntity logs entity info given an entityID.

func (*Logger) LogSystem

func (l *Logger) LogSystem(target Loggable, level zerolog.Level)

LogSystem logs all system info related to the world.

func (*Logger) LogWorld

func (l *Logger) LogWorld(target Loggable, level zerolog.Level)

LogWorld Logs everything about the world (components and Systems).