docker

Documentation

Index

• type MessageReader
  • func (dls *MessageReader) MessageRead(ctx context.Context) (*logspray.Message, error)
• type Opt
  • func WithDockerClient(cli *client.Client) Opt
  • func WithEnvVarWhiteList(evwl []*regexp.Regexp) Opt
  • func WithPoll(poll bool) Opt
  • func WithRoot(root string) Opt
• type Watcher
  • func New(opts ...Opt) (*Watcher, error)
  • func (w *Watcher) Next(ctx context.Context) ([]*sources.Update, error)
  • func (w *Watcher) ReadTarget(ctx context.Context, id string, fromStart bool) (sources.MessageReader, error)

Types

type MessageReader

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

MessageReader is a reder log source that reads docker logs.

func (*MessageReader) MessageRead

func (dls *MessageReader) MessageRead(ctx context.Context) (*logspray.Message, error)

MessageRead implements the LogSourcer interface

type Opt

type Opt func(*Watcher) error

Opt is a type for configuration options for the docker Watcher

func WithDockerClient

func WithDockerClient(cli *client.Client) Opt

WithDockerClient sets the default docker client

func WithEnvVarWhiteList

func WithEnvVarWhiteList(evwl []*regexp.Regexp) Opt

WithEnvVarWhiteList lets you set a selection of regular experessions to match against the container environment variables

func WithPoll

func WithPoll(poll bool) Opt

WithPoll sets the default docker client

func WithRoot

func WithRoot(root string) Opt

WithRoot sets the docker root to read files from

type Watcher

type Watcher struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Watcher watches for files being added and removed from a filesystem

func New

func New(opts ...Opt) (*Watcher, error)

New creates a watcher that reports on the apperance, and dissapearance of sources

func (*Watcher) Next

func (w *Watcher) Next(ctx context.Context) ([]*sources.Update, error)

Next should be called each time you wish to watch for an update.

func (*Watcher) ReadTarget

func (w *Watcher) ReadTarget(ctx context.Context, id string, fromStart bool) (sources.MessageReader, error)

ReadTarget creates a new docker log source