Skip to content

Commit

Permalink
Rename topicConsumer tool to just consumer
Browse files Browse the repository at this point in the history
Add a flag to support arbitrary partitions. Deprecate (but do not remove, yet)
partitionConsumer tool.
  • Loading branch information
eapache committed May 1, 2015
1 parent a732324 commit 9008214
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 31 deletions.
4 changes: 2 additions & 2 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This folder contains applications that are useful for exploration of your Kafka
Some of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function.

- [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer.
- [kafka-console-partitionconsumer](./kafka-console-partitionconsumer): a command line tool to consume a single partition of a topic on your Kafka cluster.
- [kafka-console-topicconsumer](./kafka-console-topicconsumer): a command line tool to consume all partition of a topic on your Kafka cluster.
- [kafka-console-partitionconsumer](./kafka-console-partitionconsumer): (deprecated) a command line tool to consume a single partition of a topic on your Kafka cluster.
- [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume arbitrary partitions of a topic on your Kafka cluster.

To install all tools, run `go get github.com/Shopify/sarama/tools/...`
2 changes: 2 additions & 0 deletions tools/kafka-console-consumer/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
kafka-console-consumer
kafka-console-consumer.test
29 changes: 29 additions & 0 deletions tools/kafka-console-consumer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# kafka-console-consumer

A simple command line tool to consume partitions of a topic and print the
messages on the standard output.

### Installation

go get github.com/Shopify/sarama/tools/kafka-console-consumer

### Usage

# Minimum invocation
kafka-console-consumer -topic=test -brokers=kafka1:9092

# It will pick up a KAFKA_PEERS environment variable
export KAFKA_PEERS=kafka1:9092,kafka2:9092,kafka3:9092
kafka-console-consumer -topic=test

# You can specify the offset you want to start at. It can be either
# `oldest`, `newest`. The default is `newest`.
kafka-console-consumer -topic=test -offset=oldest
kafka-console-consumer -topic=test -offset=newest

# You can specify the partition(s) you want to consume as a comma-separated
# list. The default is `all`.
kafka-console-consumer -topic=test -partitions=1,2,3

# Display all command line options
kafka-console-consumer -help
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"log"
"os"
"os/signal"
"strconv"
"strings"
"sync"

Expand All @@ -15,6 +16,7 @@ import (
var (
brokerList = flag.String("brokers", os.Getenv("KAFKA_PEERS"), "The comma separated list of brokers in the Kafka cluster")
topic = flag.String("topic", "", "REQUIRED: the topic to consume")
partitions = flag.String("partitions", "all", "The partitions to consume, can be 'all' or comma-separated numbers")
offset = flag.String("offset", "newest", "The offset to start with. Can be `oldest`, `newest`")
verbose = flag.Bool("verbose", false, "Whether to turn on sarama logging")
bufferSize = flag.Int("buffer-size", 256, "The buffer size of the message channel.")
Expand Down Expand Up @@ -52,7 +54,7 @@ func main() {
printErrorAndExit(69, "Failed to start consumer: %s", err)
}

partitions, err := c.Partitions(*topic)
partitionList, err := getPartitions(c)
if err != nil {
printErrorAndExit(69, "Failed to get the list of partitions: %s", err)
}
Expand All @@ -71,7 +73,7 @@ func main() {
close(closing)
}()

for _, partition := range partitions {
for _, partition := range partitionList {
pc, err := c.ConsumePartition(*topic, partition, initialOffset)
if err != nil {
printErrorAndExit(69, "Failed to start consumer for partition %d: %s", partition, err)
Expand Down Expand Up @@ -110,6 +112,24 @@ func main() {
}
}

func getPartitions(c sarama.Consumer) ([]int32, error) {
if *partitions == "all" {
return c.Partitions(*topic)
}

tmp := strings.Split(*partitions, ",")
var pList []int32
for i := range tmp {
val, err := strconv.ParseInt(tmp[i], 10, 32)
if err != nil {
return nil, err
}
pList = append(pList, int32(val))
}

return pList, nil
}

func printErrorAndExit(code int, format string, values ...interface{}) {
fmt.Fprintf(os.Stderr, "ERROR: %s\n", fmt.Sprintf(format, values...))
fmt.Fprintln(os.Stderr)
Expand Down
3 changes: 3 additions & 0 deletions tools/kafka-console-partitionconsumer/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# kafka-console-partitionconsumer

NOTE: this tool is deprecated in favour of the more general and more powerful
`kafka-console-consumer`.

A simple command line tool to consume a partition of a topic and print the messages
on the standard output.

Expand Down
2 changes: 0 additions & 2 deletions tools/kafka-console-topicconsumer/.gitignore

This file was deleted.

25 changes: 0 additions & 25 deletions tools/kafka-console-topicconsumer/README.md

This file was deleted.

0 comments on commit 9008214

Please sign in to comment.