system

Documentation

Index

• func InitializeServiceLogger(stackFilePath string)
• func Log(msg string)
• func Logf(format string, args ...interface{})
• func PurgeLogs() error
• func SubscribeToLogs(subscription func(string))
• type LogEntry
  • func ReadLogs() ([]LogEntry, error)
• type ServiceLogger
  • func GetServiceLogger() *ServiceLogger
  • func (s *ServiceLogger) WriteLog(level logrus.Level, message, origin string)
• type SystemLogsService

Functions

func InitializeServiceLogger

func InitializeServiceLogger(stackFilePath string)

InitializeLogger sets the file path for the singleton instance This must be called before the singleton is accessed.

func Log

func Log(msg string)

func Logf

func Logf(format string, args ...interface{})

func PurgeLogs

func PurgeLogs() error

PurgeLogs truncates the log file to remove all log entries

func SubscribeToLogs

func SubscribeToLogs(subscription func(string))

Types

type LogEntry

type LogEntry struct {
	Timestamp time.Time    `json:"time"`
	Level     logrus.Level `json:"level"`
	Message   string       `json:"msg"`
	Origin    string       `json:"origin"`
}

func ReadLogs

func ReadLogs() ([]LogEntry, error)

ReadLogs reads the log file from the service's log file path and returns a slice of LogEntry objects

type ServiceLogger

type ServiceLogger struct {
	Logger      *logrus.Logger
	LogFilePath string
}

ServiceLogger struct to encapsulate the logger and file path

func GetServiceLogger

func GetServiceLogger() *ServiceLogger

GetServiceLogger retrieves the singleton instance of the ServiceLogger

func (*ServiceLogger) WriteLog

func (s *ServiceLogger) WriteLog(level logrus.Level, message, origin string)

WriteLog writes a log entry with the specified level and message

type SystemLogsService

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

SystemLogsService - An EventBus service for handling logging of events and exceptions So they can be subscribed to and displayed in the CLI