Golang library for consuming Kinesis stream data
Find a file
2016-05-07 18:10:31 -07:00
emitter Update S3 emitter initialization 2016-05-01 15:07:58 -07:00
examples Add required fields to Config 2016-05-07 18:10:31 -07:00
vendor Bump gvt vendored libraries 2016-05-01 14:56:50 -07:00
.gitignore Add benchmark test to buffer 2016-05-01 10:42:51 -07:00
buffer.go Add required fields to Config 2016-05-07 18:10:31 -07:00
buffer_test.go Add required fields to Config 2016-05-07 18:10:31 -07:00
checkpoint.go Refactor to use handler func 2016-02-06 17:50:17 -08:00
checkpoint_test.go Refactor to use handler func 2016-02-06 17:50:17 -08:00
config.go Add required fields to Config 2016-05-07 18:10:31 -07:00
consumer.go Add required fields to Config 2016-05-07 18:10:31 -07:00
CONTRIBUTING.md Rename License file and add Contributing sections 2015-05-23 10:24:53 -07:00
handler.go Refactor to use handler func 2016-02-06 17:50:17 -08:00
MIT-LICENSE Rename License file and add Contributing sections 2015-05-23 10:24:53 -07:00
README.md Add required fields to Config 2016-05-07 18:10:31 -07:00

Golang Kinesis Connectors

Kinesis connector applications written in Go

With the new release of Kinesis Firehose I'd recommend using the Lambda Streams to Firehose project for loading data directly into S3 and Redshift.

Inspired by the Amazon Kinesis Connector Library. This library is intended to be a lightweight wrapper around the Kinesis API to handle batching records, setting checkpoints, respecting ratelimits, and recovering from network errors.

golang_kinesis_connector

Overview

The consumer expects a handler func that will process a buffer of incoming records.

func main() {
  var(
    app = flag.String("app", "", "The app name")
    stream = flag.String("stream", "", "The stream name")
  )
  flag.Parse()

  // override library defaults
  cfg := connector.Config{
    MaxRecordCount: 400,
  }

  // create new consumer
  c := connector.NewConsumer(*app, *stream, cfg)

  // process records from the stream
  c.Start(connector.HandlerFunc(func(b connector.Buffer) {
    fmt.Println(b.GetRecords())
  }))

  select {}
}

Logging

Apex Log is used for logging Info. The default handler is "discard" which is a no-op logging handler (i.e. no logs produced).

If you'd like to have the libaray produce logs the default can be overridden with other Log Handlers. For example using the "text" log handler:

import(
  "github.com/apex/log/handlers/text"
)

func main() {
  // ...

  cfg := connector.Config{
    LogHandler: text.New(os.Stderr),
  }
}

Which will producde the following logs:

  INFO[0000] processing                app=test shard=shardId-000000000000 stream=test
  INFO[0008] emitted                   app=test count=500 shard=shardId-000000000000 stream=test
  INFO[0012] emitted                   app=test count=500 shard=shardId-000000000000 stream=test

Installation

Get the package source:

$ go get github.com/harlow/kinesis-connectors

Fetching Dependencies

Install gvt:

$ export GO15VENDOREXPERIMENT=1
$ go get github.com/FiloSottile/gvt

Install dependencies into ./vendor/:

$ gvt restore

Examples

Use the seed stream code to put sample data onto the stream.

Contributing

Please see CONTRIBUTING.md for more information. Thank you, contributors!

License

Copyright (c) 2015 Harlow Ward. It is free software, and may be redistributed under the terms specified in the LICENSE file.

www.hward.com  ·  GitHub @harlow  ·  Twitter @harlow_ward