sink

README

sink

Contains interfaces and methods for sinking data to external services. As a general rule, sinks should support all formats of data if possible.

Each sink must use a select statement to read data from its channel and check if context was cancelled to prevent goroutine leaks (learn more about goroutine leaks here).

Information for each sink is available in the GoDoc.

Documentation

Index

• func NewFileExtension(format config.Config, compression config.Config) (ext string)
• func NewFileWrapper(f *os.File, format config.Config, compression config.Config) (*fw, error)
• type Sink
  • func New(ctx context.Context, cfg config.Config) (Sink, error)

Functions

func NewFileExtension

func NewFileExtension(format config.Config, compression config.Config) (ext string)

NewFileExtension returns a file extension based on file format and compression settings. The file extensions constructed by this function match this regular expression: `(\.json|\.txt)?(\.gz|\.zst)?`.

func NewFileWrapper

func NewFileWrapper(f *os.File, format config.Config, compression config.Config) (*fw, error)

Types

type Sink

type Sink interface {
	Send(context.Context, *config.Channel) error
}

func New

func New(ctx context.Context, cfg config.Config) (Sink, error)

New returns a configured Sink from a sink configuration.