Skip to main content

A usable kafka tool.

Project description

esque - an operational kafka tool.

pypi Version Python Versions Build Status License: MIT

In the Kafka world nothing is easy, but esque (pronounced esk) is an attempt at it.

Why should you care?

Some stuff is hard, and that is okay, listing your kafka topics shouldn't be.

While adopting kafka at real.digital we noticed the immense entry barrier it poses to newcomers. We can't recount how often we wrote Slack messages asking for the script to check the status of topics or consumergroups. This is partly (but not only) due to a fragmented and unclear definition of tooling and APIs for kafka.

esque tries to become a human-friendly point of first contact for your kafka cluster by exposing a kubectl-like interface to it.

Main Features

  • List Resources (Topics, Consumergroups, Brokers)
  • Get detailed Overviews of Resources (Topics, Consumergroups, Brokers)
  • Create/Delete Topics
  • Context Switch (Easily Switch between pre-defined Clusters)
  • Kafka Ping (Test roundtrip time to your kafka cluster)
  • and many more planned...

Installation and Usage

Installation

esque is available at pypi.org and can be installed with pip install esque. esque requires Python 3.6+ to run.

Enable Autocompletion

esque uses Magic Environment Variables to provide autocompletion to you. You can enable autocompletion by adding the one of the following snippets to your .bashrc/.zshrc

Bash

eval "$(_ESQUE_COMPLETE=source esque)"

ZSH

eval "$(_ESQUE_COMPLETE=source_zsh esque)"

Usage

Config Definition

When starting esque for the first time the following message will appear:

No config provided in ~/.esque
Should a sample file be created in ~/.esque [y/N]:

When answering with y esque will copy over the sample config to ~/.esque/esque.cfg. Afterwards you can modify that file to fit your cluster definitions.

Alternatively might just provide a config file following the sample config's file in that path.

Command Overview

$ esque
Usage: esque [OPTIONS] COMMAND [ARGS]...

  (Kafka-)esque.

Options:
  --help  Show this message and exit.

Commands:
  apply     Apply a configuration
  create    Create a new instance of a resource.
  ctx       Switch clusters.
  delete    Delete a resource.
  describe  Get detailed informations about a resource.
  get       Get a quick overview of different resources.
  ping      Tests the connection to the kafka cluster.

Config file for "apply" command

The config for the apply command has to be a yaml file and is given with the option -f or --file.

In the current version only topic configurations can be changed and specified.

It has to use the schema, which is used for the following example:

topics:
  - name: topic_one
    replication_factor: 3
    num_partitions: 50
    config:
      cleanup.policy: compact
  - name: topic_two
    replication_factor: 3
    num_partitions: 50
    config:
      cleanup.policy: compact

Development

pipenv install --dev
pipenv shell 
export PYTHONPATH=$(pwd)

Run tests

docker-compose up

Alternatives

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for esque, version 0.1.3a0
Filename, size File type Python version Upload date Hashes
Filename, size esque-0.1.3a0.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page