logstream

Documentation

Overview

Package logstream provides functionality for saving and retrieving logs

Index

• type LogEvent
• type Manager
  • func New(store Store, dbClient *db.Client, eventManager *events.EventManager, ...) Manager
• type MockManager
  • func NewMockManager(t mockConstructorTestingTNewMockManager) *MockManager
  • func (_m *MockManager) ReadLogs(ctx context.Context, logStreamID string, startOffset int, limit int) ([]byte, error)
  • func (_m *MockManager) Subscribe(ctx context.Context, options *SubscriptionOptions) (<-chan *LogEvent, error)
  • func (_m *MockManager) WriteLogs(ctx context.Context, logStreamID string, startOffset int, buffer []byte) (*models.LogStream, error)
• type MockStore
  • func NewMockStore(t mockConstructorTestingTNewMockStore) *MockStore
  • func (_m *MockStore) ReadLogs(ctx context.Context, logStreamID string, startOffset int, limit int) ([]byte, error)
  • func (_m *MockStore) WriteLogs(ctx context.Context, logStreamID string, startOffset int, buffer []byte) error
• type Store
  • func NewLogStore(objectStore objectstore.ObjectStore, dbClient *db.Client) Store
• type SubscriptionOptions

Types

type LogEvent

type LogEvent struct {
	Size      int
	Completed bool
}

LogEvent represents a log stream event

type Manager

type Manager interface {
	WriteLogs(ctx context.Context, logStreamID string, startOffset int, buffer []byte) (*models.LogStream, error)
	ReadLogs(ctx context.Context, logStreamID string, startOffset int, limit int) ([]byte, error)
	Subscribe(ctx context.Context, options *SubscriptionOptions) (<-chan *LogEvent, error)
}

Manager interface encapsulates the logic for saving and retrieving logs

func New

func New(store Store, dbClient *db.Client, eventManager *events.EventManager, logger logger.Logger) Manager

New creates an instance of the Manager interface

type MockManager

type MockManager struct {
	mock.Mock
}

MockManager is an autogenerated mock type for the Manager type

func NewMockManager

func NewMockManager(t mockConstructorTestingTNewMockManager) *MockManager

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

func (*MockManager) ReadLogs

func (_m *MockManager) ReadLogs(ctx context.Context, logStreamID string, startOffset int, limit int) ([]byte, error)

ReadLogs provides a mock function with given fields: ctx, logStreamID, startOffset, limit

func (*MockManager) Subscribe

func (_m *MockManager) Subscribe(ctx context.Context, options *SubscriptionOptions) (<-chan *LogEvent, error)

Subscribe provides a mock function with given fields: ctx, options

func (*MockManager) WriteLogs

func (_m *MockManager) WriteLogs(ctx context.Context, logStreamID string, startOffset int, buffer []byte) (*models.LogStream, error)

WriteLogs provides a mock function with given fields: ctx, logStreamID, startOffset, buffer

type MockStore

type MockStore struct {
	mock.Mock
}

MockStore is an autogenerated mock type for the Store type

func NewMockStore

func NewMockStore(t mockConstructorTestingTNewMockStore) *MockStore

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

func (*MockStore) ReadLogs

func (_m *MockStore) ReadLogs(ctx context.Context, logStreamID string, startOffset int, limit int) ([]byte, error)

ReadLogs provides a mock function with given fields: ctx, logStreamID, startOffset, limit

func (*MockStore) WriteLogs

func (_m *MockStore) WriteLogs(ctx context.Context, logStreamID string, startOffset int, buffer []byte) error

WriteLogs provides a mock function with given fields: ctx, logStreamID, startOffset, buffer

type Store

type Store interface {
	WriteLogs(ctx context.Context, logStreamID string, startOffset int, buffer []byte) error
	ReadLogs(ctx context.Context, logStreamID string, startOffset int, limit int) ([]byte, error)
}

Store interface encapsulates the logic for saving and retrieving logs

func NewLogStore

func NewLogStore(objectStore objectstore.ObjectStore, dbClient *db.Client) Store

NewLogStore creates an instance of the LogStore interface

type SubscriptionOptions

type SubscriptionOptions struct {
	LastSeenLogSize *int
	LogStreamID     string
}

SubscriptionOptions includes options for setting up a log event subscription