/kafka-eagle

A easy and high-performance monitoring system, as well as offsets or metadata and other kafka information.

Primary LanguageJavaApache License 2.0Apache-2.0

Build Status codebeat badge Hex.pm

Stargazers over time

EFAK (Eagle For Apache Kafka, previously known as Kafka Eagle)

This is an monitor system and monitor your kafka clusters, and visual consumer thread,offsets,owners etc.

When you install EFAK, you can see the current consumer group,for each group the topics that they are consuming and the offsets, lag, logsize position of the group in each topic. This is useful to understand how fast you are consuming from a message queue and how quick the message queue is increase. This will help you debuging kafka producers and consumers or just to have an idea of what is going on in your system.

The system shows the trend of consumer and producer trends on the same day, so you can see what happened that day.

Supported on kafka version: 0.8.2.x,0.9.x,0.10.x,0.11.x,1.x,2.x .

Supported platform: Mac OS X,Linux,Windows.

Supported JDK: JDK8+

Here are a few EFAK system screenshots: efak_tv

Get started

Unsure if EFAK is for you? Watch EFAK video in action on www.kafka-eagle.org!

Alert Support

EFAK supports currently popular IM alarm systems, such as:

  • DingDing
  • WeChat
  • Webhook
  • Email
  • ...

List of Consumer Groups & Active Group Graph

Consumer & Active Graph

List of Topics Detail

Topics

Consumer & Producer Rate Chart

Rate Chart

Start EFAK

KE Script

Kafka Offset Types

Kafka is designed to be flexible on how the offsets are managed. Consumer can choose arbitrary storage and format to persist kafka offsets. EFAK currently support following popular storage format:

  • Zookeeper. Old version of Kafka (0.8.2 before) default storage in Zookeeper.
  • Kafka. New version of Kafka (0.10.0 in the future) default recommend storage in Kafka Topic(__consumer_offsets).

EFAK supports multiple offset storage paths. If you store them in Zookeeper and Kafka, you can configure them like this.

# Set kafka cluster alias
efak.zk.cluster.alias=cluster1,cluster2

# Set kafka cluster zookeeper address
cluster1.zk.list=xdn1:2181,xdn2:2181,xdn3:2181
cluster2.zk.list=tdn1:2181,tdn2:2181,tdn3:2181

# Set kafka cluster offset storage path
cluster1.efak.offset.storage=kafka
cluster2.efak.offset.storage=zookeeper

Kafka SQL

Use the SQL statement to query the topic message log, and visualize the results, you can read Kafka SQL to view the syntax. For example, if you kafka has a topic with three partitions, the ksql query statement is as follows.

select * from ke_p3_r2 where `partition` in (0,1,2) limit 10

ksql ksql_result

Quickstart

Please read EFAK Install for setting up and running EFAK.

Deploy

The project is a maven project that uses the Maven command to pack the deployment as follows:

./build.sh

More Information

Please see the EFAK Manual for for more information including:

  • System environment settings and installation instructions.
  • Information about how to use script command.
  • Visual kafka consumer group,topic,offset metadata information etc.
  • Metadata collection and log change information.

Contributing

The EFAK is released under the Apache License and we welcome any contributions within this license. Any pull request is welcome and will be reviewed and merged as quickly as possible.

Since this is an open source tool, please comply with the relevant laws and regulations, the use of civilization.

Project Name and Management

EFAK was renamed from its previous name due to this issue. EFAK is designed to be used with Apache Kafka and is offered to support the needs of the Kafka community. The project is open source by Smartloli and maintained and managed in Github.

Contributors

Thanks to the following members for maintaining the project. If this project help you reduce time to develop, you can give us a star.

Alias Github Email
smartloli smartloli smartloli.org@gmail.com
hexiang hexian55 hexiang55@gmail.com
cocodroid cocodroid sujunguang@gmail.com
alisa alisa alisazou1211@gmail.com
iamwzt iamwzt 981911861@qq.com
JacobAP JacobAP jacobap@163.com