logstream

Documentation

Overview

logstream contains functionality for streaming logs for an entire application from Kubernetes. This functionality is based on github.com/stern/stern.

Package logstream is a generated GoMock package.

Index

• type Impl
  • func (i *Impl) Stream(ctx context.Context, options Options) error
• type Interface
• type MockInterface
  • func NewMockInterface(ctrl *gomock.Controller) *MockInterface
  • func (m *MockInterface) EXPECT() *MockInterfaceMockRecorder
  • func (m *MockInterface) Stream(arg0 context.Context, arg1 Options) error
• type MockInterfaceMockRecorder
  • func (mr *MockInterfaceMockRecorder) Stream(arg0, arg1 any) *gomock.Call
• type Options

Types

type Impl

type Impl struct {
}

Impl is the implementation of logstream.Interface.

func (*Impl) Stream

func (i *Impl) Stream(ctx context.Context, options Options) error

Stream() configures and runs Stern, a library for streaming logs from Kubernetes pods, with custom filters and output formats based on the provided parameters. It returns an error if there is an issue configuring or running Stern.

type Interface

type Interface interface {
	// Stream opens a log stream and writes the application's log to the provided writer.
	// This function will block until the context is cancelled.
	Stream(ctx context.Context, options Options) error
}

Interface is the interface type for streaming application logs.

type MockInterface

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

MockInterface is a mock of Interface interface.

func NewMockInterface

func NewMockInterface(ctrl *gomock.Controller) *MockInterface

NewMockInterface creates a new mock instance.

func (*MockInterface) EXPECT

func (m *MockInterface) EXPECT() *MockInterfaceMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockInterface) Stream

func (m *MockInterface) Stream(arg0 context.Context, arg1 Options) error

Stream mocks base method.

type MockInterfaceMockRecorder

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

MockInterfaceMockRecorder is the mock recorder for MockInterface.

func (*MockInterfaceMockRecorder) Stream

func (mr *MockInterfaceMockRecorder) Stream(arg0, arg1 any) *gomock.Call

Stream indicates an expected call of Stream.

type Options

type Options struct {
	// ApplicationName is the name of the application.
	ApplicationName string

	// Namespace is the kubernetes namespace of the application.
	Namespace string

	// KubeClient is the kubernetes client to use for connection.
	KubeClient kubernetes.Interface

	// Out is where output will be written.
	Out io.Writer
}

Options specifies the options for streaming application logs.