# Kafka Topic Analyzer

[![Build Status](https://travis-ci.org/xenji/kafka-topic-analyzer.svg?branch=master)](https://travis-ci.org/xenji/kafka-topic-analyzer)
[![Current version on crates.io](https://img.shields.io/crates/v/kafka-topic-analyzer.svg)](https://crates.io/crates/kafka-topic-analyzer)

A CLI tool that gathers statistics about a Apache Kafka topic by reading
it from beginning to end and counting various metrics.

## Usage
    $> ./kafka-topic-analyzer -h
         Kafka Topic Analyzer

         USAGE:
             kafka-topic-analyzer [FLAGS] --bootstrap-server <BOOTSTRAP_SERVER> --topic <TOPIC>

         FLAGS:
             -c, --count-alive-keys    Counts the effective number of alive keys in a log compacted topic by saving the state for
                                       each key in a local file and counting the result at the end of the read operation.A key is
                                       'alive' when it is present and has a non-null value in it's latest-offset version
             -h, --help                Prints help information
             -V, --version             Prints version information

         OPTIONS:
             -b, --bootstrap-server <BOOTSTRAP_SERVER>    Bootstrap server(s) to work with, comma separated
             -t, --topic <TOPIC>                          The topic to analyze

## Example output
![Screenshot from a terminal that shows an example of the output](demo_output.png "Shows a sample output of the tool")

## Installation

By now, the only way of installing it is building it from source or
via `cargo install kafka-topic-analyzer`. In both cases you need to
have the rust toolchain installed via [http://rustup.rs/](http://rustup.rs/).

### Dependencies

#### librdkafka
When installed from source, the binary can build librdkafka as part of the
dependency resolution process. Please see the [rdkafka-rust dependency documentation](https://github.com/fede1024/rust-rdkafka/#installation)
for the detailed requirements.

The `rdkafka-rust` dependency exports a feature flag, which enables
dynamic linking of the librdkafa dependency.

You can compile this project with `cargo build --features "dynamic_linking"`
in order to use the shared library instead of building it with the dependencies.