logstream

Documentation

Index

• type Provider
• type Reader
• type Writer

Types

type Provider

type Provider interface {

	// StartWriter starts a new log writer. Requires state to persist logs.
	StartWriter(ctx context.Context, log hclog.Logger, state serverstate.Interface, job *serverstate.Job) (Writer, error)

	// StartReader starts a new log reader.
	StartReader(ctx context.Context, log hclog.Logger, job *serverstate.Job) (Reader, error)

	// ReadCompleted returns all the log entries for a job that has been completed,
	// by reading them out of persistent storage.
	ReadCompleted(ctx context.Context, log hclog.Logger, state serverstate.Interface, job *serverstate.Job) ([]*pb.GetJobStreamResponse_Terminal_Event, error)
}

Provider provides a log stream tracker

type Reader

type Reader interface {

	// ReadStream returns a batch of log entries for a job that's currenly active.
	// If zero exist and block is true, this will block waiting for
	// available entries. If block is false and no more log entries exist,
	// this will return nil.
	ReadStream(ctx context.Context, block bool) ([]*pb.GetJobStreamResponse_Terminal_Event, error)
}

Reader reads terminal events for a given

type Writer

type Writer interface {
	Flush(ctx context.Context)
	NewEvent(ctx context.Context, event *pb.RunnerJobStreamRequest_Terminal) error
}

Writer collects and tracks loggable events