joblogger

package
v0.28.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package joblogger is used to handle job logs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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{})
	// 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 MockJobLogger

type MockJobLogger struct {
	mock.Mock
}

MockJobLogger is an autogenerated mock type for the JobLogger type

func NewMockJobLogger

func NewMockJobLogger(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockJobLogger

NewMockJobLogger creates a new instance of MockJobLogger. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockJobLogger) Close

func (_m *MockJobLogger) Close()

Close provides a mock function with given fields:

func (*MockJobLogger) Errorf

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

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

func (*MockJobLogger) Flush

func (_m *MockJobLogger) Flush()

Flush provides a mock function with given fields:

func (*MockJobLogger) Infof

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

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

func (*MockJobLogger) Start

func (_m *MockJobLogger) Start()

Start provides a mock function with given fields:

func (*MockJobLogger) Write

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

Write provides a mock function with given fields: data

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) Write

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

Write provides a mock function with given fields: data

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL