joblogger

Documentation

Index

• type Logger
  • func New(ds datastore.Datastore) *Logger
  • func (cl *Logger) Close() error
  • func (cl *Logger) GetByCid(ctx context.Context, c cid.Cid) ([]ffs.LogEntry, error)
  • func (cl *Logger) Log(ctx context.Context, format string, a ...interface{})
  • func (cl *Logger) Watch(ctx context.Context, c chan<- ffs.LogEntry) error

Types

type Logger

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

Logger is a datastore backed implementation of ffs.Logger.

func New

func New(ds datastore.Datastore) *Logger

New returns a new CidLogger.

func (*Logger) Close

func (cl *Logger) Close() error

Close closes and cancels all watchers that might be active.

func (*Logger) GetByCid

func (cl *Logger) GetByCid(ctx context.Context, c cid.Cid) ([]ffs.LogEntry, error)

GetByCid returns history logs for a Cid.

func (*Logger) Log

func (cl *Logger) Log(ctx context.Context, format string, a ...interface{})

Log logs a log entry for a Cid. The ctx can contain an optional ffs.CtxKeyJid to add additional metadata about the log entry being part of a Job execution.

func (*Logger) Watch

func (cl *Logger) Watch(ctx context.Context, c chan<- ffs.LogEntry) error

Watch is a blocking function that writes to the channel all new created log entries. The client should cancel the ctx to signal stopping writing to the channel and free resources.