kinesis-consumer/examples/consumer/cp-redis/README.md

# Consumer

Read records from the Kinesis stream

### Environment Variables

Export the required environment vars for connecting to the Kinesis stream and Redis for checkpoint:

```
export AWS_PROFILE=
export AWS_REGION=
export REDIS_URL=
```

### Run the consumer

    $  go run main.go --app appName --stream streamName
Remove the client wrapper (#58) Having an additional Client has added some confusion (https://github.com/harlow/kinesis-consumer/issues/45) on how to provide a custom kinesis client. Allowing `WithClient` to accept a Kinesis client it cleans up the interface. Major changes: * Remove the Client wrapper; prefer using kinesis client directly * Change `ScanError` to `ScanStatus` as the return value isn't necessarily an error Note: these are breaking changes, if you need last stable release please see here: https://github.com/harlow/kinesis-consumer/releases/tag/v0.2.0 2018-07-29 05:53:33 +00:00			`# Consumer`

			`Read records from the Kinesis stream`

			`### Environment Variables`

			`Export the required environment vars for connecting to the Kinesis stream and Redis for checkpoint:`

			```
Use shard broker to monitor and process new shards (#85) * Use shard broker to start processing new shards The addition of a shard broker will allow the consumer to be notified when new shards are added to the stream so it can consume them. Fixes: https://github.com/harlow/kinesis-consumer/issues/36 2019-04-10 05:03:12 +00:00			`export AWS_PROFILE=`
Remove the client wrapper (#58) Having an additional Client has added some confusion (https://github.com/harlow/kinesis-consumer/issues/45) on how to provide a custom kinesis client. Allowing `WithClient` to accept a Kinesis client it cleans up the interface. Major changes: * Remove the Client wrapper; prefer using kinesis client directly * Change `ScanError` to `ScanStatus` as the return value isn't necessarily an error Note: these are breaking changes, if you need last stable release please see here: https://github.com/harlow/kinesis-consumer/releases/tag/v0.2.0 2018-07-29 05:53:33 +00:00			`export AWS_REGION=`
			`export REDIS_URL=`
			```

			`### Run the consumer`

Use shard broker to monitor and process new shards (#85) * Use shard broker to start processing new shards The addition of a shard broker will allow the consumer to be notified when new shards are added to the stream so it can consume them. Fixes: https://github.com/harlow/kinesis-consumer/issues/36 2019-04-10 05:03:12 +00:00			`$ go run main.go --app appName --stream streamName`