joblogger

Documentation

Overview

Package joblogger is used to handle job logs

Index

• type LogBuffer
  • func NewLogBuffer() (*LogBuffer, error)
  • func (b *LogBuffer) Bytes(offset, n int) ([]byte, error)
  • func (b *LogBuffer) Checksum() string
  • func (b *LogBuffer) Close()
  • func (b *LogBuffer) SetLimit(size int)
  • func (b *LogBuffer) Size() int
  • func (b *LogBuffer) Write(p []byte) (int, error)
• type Logger
  • func NewLogger(jobID string, client jobclient.Client, logger logger.Logger) (Logger, error)
• type MockLogger
  • func NewMockLogger(t mockConstructorTestingTNewMockLogger) *MockLogger
  • func (_m *MockLogger) Close()
  • func (_m *MockLogger) Errorf(format string, a ...interface{})
  • func (_m *MockLogger) Flush()
  • func (_m *MockLogger) Infof(format string, a ...interface{})
  • func (_m *MockLogger) Start()
  • func (_m *MockLogger) Warningf(format string, a ...interface{})
  • func (_m *MockLogger) Write(data []byte) (int, error)

Types

type LogBuffer

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

LogBuffer stores logs in a file and limits the amount of logs written

func NewLogBuffer

func NewLogBuffer() (*LogBuffer, error)

NewLogBuffer returns a new LogBuffer

func (*LogBuffer) Bytes

func (b *LogBuffer) Bytes(offset, n int) ([]byte, error)

Bytes returns a chunk of bytes from the log file

func (*LogBuffer) Checksum

func (b *LogBuffer) Checksum() string

Checksum returns the checksum for the log data

func (*LogBuffer) Close

func (b *LogBuffer) Close()

Close removes the underlying log file

func (*LogBuffer) SetLimit

func (b *LogBuffer) SetLimit(size int)

SetLimit sets the limit for log data in bytes

func (*LogBuffer) Size

func (b *LogBuffer) Size() int

Size returns the number of bytes written

func (*LogBuffer) Write

func (b *LogBuffer) Write(p []byte) (int, error)

type Logger

type Logger interface {
	// Close flushes the logger
	Close()
	// Infof writes an info log to the job's log output
	Infof(format string, a ...interface{})
	// Errorf writes an error log to the job's log output
	Errorf(format string, a ...interface{})
	// Warningf writes a warning log to the job's log output
	Warningf(format string, a ...interface{})
	// Write will append the data to the log buffer
	Write(data []byte) (n int, err error)
	// Start starts the logger
	Start()
	// Flush flushes the logger
	Flush()
}

Logger is an interface for logging job output

func NewLogger

func NewLogger(jobID string, client jobclient.Client, logger logger.Logger) (Logger, error)

NewLogger creates a new Logger

type MockLogger

type MockLogger struct {
	mock.Mock
}

MockLogger is an autogenerated mock type for the Logger type

func NewMockLogger

func NewMockLogger(t mockConstructorTestingTNewMockLogger) *MockLogger

NewMockLogger creates a new instance of MockLogger. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.

func (*MockLogger) Close

func (_m *MockLogger) Close()

Close provides a mock function with given fields:

func (*MockLogger) Errorf

func (_m *MockLogger) Errorf(format string, a ...interface{})

Errorf provides a mock function with given fields: format, a

func (*MockLogger) Flush

func (_m *MockLogger) Flush()

Flush provides a mock function with given fields:

func (*MockLogger) Infof

func (_m *MockLogger) Infof(format string, a ...interface{})

Infof provides a mock function with given fields: format, a

func (*MockLogger) Start

func (_m *MockLogger) Start()

Start provides a mock function with given fields:

func (*MockLogger) Warningf

func (_m *MockLogger) Warningf(format string, a ...interface{})

Warningf provides a mock function with given fields: format, a

func (*MockLogger) Write

func (_m *MockLogger) Write(data []byte) (int, error)

Write provides a mock function with given fields: data