inspector

Documentation

Index

• Constants
• type Inspector
  • func New(logger log.CtxLogger, bufferSize int) *Inspector
  • func (i *Inspector) Close()
  • func (i *Inspector) NewSession(ctx context.Context, componentID string) *Session
  • func (i *Inspector) Send(ctx context.Context, r record.Record)
• type Session

Constants

const DefaultBufferSize = 1000

Types

type Inspector

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

Inspector is attached to an inspectable pipeline component and makes returns records coming in or out of the component. An Inspector is a "proxy" between the pipeline component being inspected and the API, which broadcasts records to all clients.

func New

func New(logger log.CtxLogger, bufferSize int) *Inspector

func (*Inspector) Close

func (i *Inspector) Close()

func (*Inspector) NewSession

func (i *Inspector) NewSession(ctx context.Context, componentID string) *Session

NewSession creates a new session in given inspector. componentID is the ID of the component being inspected (connector or processor). The session will be closed and removed from the inspector when the context is closed.

func (*Inspector) Send

func (i *Inspector) Send(ctx context.Context, r record.Record)

Send the given record to all registered sessions. The method does not wait for consumers to get the records.

type Session

type Session struct {
	C chan record.Record
	// contains filtered or unexported fields
}

Session represents a single inspector session. Records are continuously sent into channel C. If the buffer of C is full, records will be dropped. C will be closed once the session is removed from the inspector.