sinks

Documentation

Index

• type MessageWriter
• type Sinker

Types

type MessageWriter

type MessageWriter interface {
	WriteMessage(ctx context.Context, msg *logspray.Message) error
	Close() error
}

A MessageWriter is used ot add new messages to an existing log stream. Each message should have a unique numerical Index within the stream.

type Sinker

type Sinker interface {
	// AddSource should return a MessageWriter that log messages can then be
	// written to. All Messages written to the returned writer are associated with
	// the StreamID given. The Labels passed here are sent once at the start of a
	// stream and are associated with every message written to the MessageWriter.
	// StreamID should be a UUID that is uniq to this call to AddSource
	AddSource(StreamID string, Labels map[string]string) (MessageWriter, error)
}

A Sinker accepts new sources of messages.