logging

Documentation

Overview

Package logging is a thread-safe way to log video device information to a file. On startup, this package creates a unique filename and uses that filename throughout the lifetime of the program to log information such as which video devices are V4L2 compatible and the current operating system.

Index

• type InfoMap
• type Logger
  • func NewLogger() (*Logger, error)
  • func (l *Logger) Log(title string, m InfoMap) error
  • func (l *Logger) Start(ctx context.Context) error
• type UnsupportedError
  • func (e UnsupportedError) Error() string

Types

type InfoMap

type InfoMap = map[string]string

InfoMap is a map of information to be written to the log.

type Logger

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

Logger is a thread-safe logger that manages a single log file in config.ViamDotDir.

var (
	// GLoggerCamComp is the global logger-to-file for camera components.
	GLoggerCamComp *Logger
)

func NewLogger

func NewLogger() (*Logger, error)

NewLogger creates a new logger. Call Logger.Start to start logging.

func (*Logger) Log

func (l *Logger) Log(title string, m InfoMap) error

Log emits the data stored in the given InfoMap with the given title to the log file. This method is thread-safe.

func (*Logger) Start

func (l *Logger) Start(ctx context.Context) error

Start creates and initializes the logging file and periodically emits logs to it. This method is thread-safe.

type UnsupportedError

type UnsupportedError struct{}

UnsupportedError indicates this feature is not supported on the current platform.

func (UnsupportedError) Error

func (e UnsupportedError) Error() string