tasklogger

Documentation

Index

• Variables
• func CreateLogFromMaster(taskID model.TaskID, level, log string) *model.TaskLog
• func Insert(l *model.TaskLog)
• func SetDefaultLogger(l *Logger)
• type Logger
  • func New(backend Writer) *Logger
  • func (l *Logger) Insert(tl *model.TaskLog)
• type Writer

Variables

var (
	// FlushInterval is the longest time that the logger will buffer logs in memory before
	// flushing them to the database. This is set low to ensure a good user experience.
	FlushInterval = 20 * time.Millisecond
	// BufferSize is the largest number of logs lines that can be buffered before flushing them to
	// the database. For the strategy of many-rows-per-insert, performance was significantly worse
	// below 500, and no improvements after 1000.
	BufferSize = 1000
)

Functions

func CreateLogFromMaster

func CreateLogFromMaster(taskID model.TaskID, level, log string) *model.TaskLog

CreateLogFromMaster creates a tasklog of the format that we expect when it comes from master.

func Insert

func Insert(l *model.TaskLog)

Insert a log with the default task logger.

func SetDefaultLogger

func SetDefaultLogger(l *Logger)

SetDefaultLogger sets the task.Logger singleton used by package-level functions.

Types

type Logger

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

Logger is an abstraction for inserting master-side inserted task logs, such as scheduling and provisioning information, or container exit statuses. TODO(DET-9537): Add graceful shutdown for the tasklogger, so that when we intentionally blip the master for something like a configuration update we do not lose logs.

func New

func New(backend Writer) *Logger

New creates an logger which can buffer up task logs and flush them periodically. There should only be one logger shared across the entire system.

func (*Logger) Insert

func (l *Logger) Insert(tl *model.TaskLog)

Insert a log into the buffer to be flush within some interval.

type Writer

type Writer interface {
	AddTaskLogs([]*model.TaskLog) error
}

Writer stores task logs in a backend.