kinesis

README

go-kinesis

Batch producer for Kinesis built on top of the official Go AWS SDK.

License

MIT

Documentation

Overview

Package kinesis implements a batch producer built on top of the official AWS SDK.

Index

• Variables
• type Config
• type Producer
  • func New(config Config) *Producer
  • func (p *Producer) Put(data []byte, partitionKey string) error
  • func (p *Producer) Start()
  • func (p *Producer) Stop()

Variables

var (
	ErrRecordSizeExceeded = errors.New("kinesis: record size exceeded")
)

Errors.

Types

type Config

type Config struct {
	// StreamName is the Kinesis stream.
	StreamName string

	// FlushInterval is a regular interval for flushing the buffer. Defaults to 1s.
	FlushInterval time.Duration

	// BufferSize determines the batch request size. Must not exceed 500. Defaults to 500.
	BufferSize int

	// BacklogSize determines the channel capacity before Put() will begin blocking. Defaults to 500.
	BacklogSize int

	// Backoff determines the backoff strategy for record failures.
	Backoff backoff.Backoff

	// Logger is the logger used. Defaults to log.Log.
	Logger log.Interface

	// Client is the Kinesis API implementation.
	Client kinesisiface.KinesisAPI
}

type Producer

type Producer struct {
	Config
	// contains filtered or unexported fields
}

Producer batches records.

func New

func New(config Config) *Producer

New producer with the given config.

func (*Producer) Put

func (p *Producer) Put(data []byte, partitionKey string) error

Put record `data` using `partitionKey`. This method is thread-safe.

func (*Producer) Start

func (p *Producer) Start()

Start the producer.

func (*Producer) Stop

func (p *Producer) Stop()

Stop the producer. Flushes any in-flight data.