Skip to content

Latest commit

 

History

History
111 lines (97 loc) · 3.7 KB

README.md

File metadata and controls

111 lines (97 loc) · 3.7 KB
Raw

franz

Your Swiss-Army Knife tool for interacting with Kafka.

franz provides you various helper tools to work with and debug Kafka such as consuming or producing messages and managing topics or ACLs.

Installation

go get github.com/open-ch/franz

Usage

To connect to your Kafka cluster and optionally to a schema registry, franz reads from a configuration file that can be placed in one of the following paths

  • ~/.config/franz
  • /opt/franz/etc
  • any path you wish, passed in using --config /path/to/config A configuration file has roughly the form of config.yml.sample.
$ franz help
Usage:
  franz [command]

Available Commands:
  acls        List and Set Kafka ACLs
  consume     Consume a specific kafka topic
  help        Help about any command
  produce     Produce messages in the specified topic.
  registry    Interact with the schema registry
  status      Show the status of Kafka System
  topics      Manage topics

You can get more information about any command by running franz help [command].

Examples

List relevant information for all Kafka brokers

$ franz status --table
+-------------------------------------------+-----------+--------+---------------------+---------------------+----------+
|                   TOPIC                   | PARTITION | LEADER |      REPLICAS       |         ISR         | INTERNAL |
+-------------------------------------------+-----------+--------+---------------------+---------------------+----------+
| notifications.users                       | 0         | 10364  | 10364, 10363        | 10363, 10364        | false    |
| notifications.users                       | 2         | 10363  | 10363, 10365        | 10363, 10365        | false    |
| notifications.users                       | 1         | 10365  | 10365, 10364        | 10364, 10365        | false    |
| analytics.avro.pageviews                  | 0         | 10365  | 10365, 10363        | 10363, 10365        | false    |
...

Continuously read from a topic

$ franz consume notifications.users --follow
{
  "Topic": "notifications.users",
  "Timestamp": "2020-06-24T09:43:32.443Z",
  "Partition": 3,
  "Key": "...",
  "Value": "...",
  "Offset": 5755325
}
{
  "Topic": "notifications.users",
  "Timestamp": "2020-06-24T09:43:32.443Z",
  "Partition": 2,
  "Key": "...",
  "Value": "...",
  "Offset": 5755326
}
...

Produce Avro Serialized Messages

Find the name of the schema that corresponds to the topic you wish to publish to. By default this is the topic name with a '-value' suffix if it wasn't specified by the Serde.

You can check the schema name by listing the schemas in the registry:

$ franz registry list
[
  "users-value",
  "pageviews-value",
  ...
]

As with the JSON String serialized produce command, start franz reading from stdin by specifying the topic but also specify the schema name with the --encode option Then on subsequent lines submit the JSON equivalent of the messages:

$ franz produce pageviews --encode pageviews-value
{"viewtime": 248888, "userid": "User_99", "pageid": "Page_99"}
...

Contributors

Due to a migration of the codebase, some authors might not show up in the git history even though they contributed to this project:

License

Please see LICENSE.