luciano/kinesis-consumer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix position of input params for Options

Browse source
This commit is contained in:
Harlow Ward 2017-11-22 17:54:47 -08:00
parent 4ffe3ec55a
commit 3f081bd05a
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -18,7 +18,7 @@ Get the package source:
The consumer leverages a handler func that accepts a Kinesis record. The `Scan` method will consume all shards concurrently and call the callback func as it receives records from the stream. The consumer leverages a handler func that accepts a Kinesis record. The `Scan` method will consume all shards concurrently and call the callback func as it receives records from the stream.
Important: The default Log, Counter, and Checkpoint are no-op which means no logs, counts, or checkpoints will be emitted when scanning the stream. See the options below to override these defaults. _Important: The default Log, Counter, and Checkpoint are no-op which means no logs, counts, or checkpoints will be emitted when scanning the stream. See the options below to override these defaults._
```go ```go
import( import(
@ -113,9 +113,7 @@ Override the Kinesis client if there is any special config needed:
client := kinesis.New(session.New(aws.NewConfig())) client := kinesis.New(session.New(aws.NewConfig()))
// consumer // consumer
c, err := consumer.New( c, err := consumer.New(appName, streamName,
appName,
streamName,
consumer.WithClient(client), consumer.WithClient(client),
) )
``` ```
@ -129,7 +127,7 @@ Add optional counter for exposing counts for checkpoints and records processed:
counter := expvar.NewMap("counters") counter := expvar.NewMap("counters")
// consumer // consumer
c, err := consumer.New(checkpoint, appName, streamName, c, err := consumer.New(appName, streamName,
consumer.WithCounter(counter), consumer.WithCounter(counter),
) )
``` ```
@ -152,7 +150,7 @@ The package defaults to `ioutil.Discard` so swallow all logs. This can be custom
logger := log.New(os.Stdout, "consumer-example: ", log.LstdFlags) logger := log.New(os.Stdout, "consumer-example: ", log.LstdFlags)
// consumer // consumer
c, err := consumer.New(checkpoint, appName, streamName, c, err := consumer.New(appName, streamName,
consumer.WithLogger(logger), consumer.WithLogger(logger),
) )
``` ```