# kafka-eagle

**Repository Path**: wbdevops/kafka-eagle

## Basic Information

- **Project Name**: kafka-eagle
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-02
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/smartloli/kafka-eagle.svg?branch=master)](https://travis-ci.org/smartloli/kafka-eagle)
![](https://img.shields.io/badge/language-java-orange.svg)
[![codebeat badge](https://codebeat.co/badges/bf22a7b2-76ac-4aba-b840-00328841d9e3)](https://codebeat.co/projects/github-com-smartloli-kafka-eagle-master)
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/smartloli/kafka-eagle/blob/master/LICENSE)

# Kafka Eagle

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

When you install [Kafka Eagle](https://www.kafka-eagle.org/), 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 Kafka Eagle system screenshots:

# Big Screen Support
![BScreen Data](http://www.kafka-eagle.org/images/docs/bscreen@2x.jpg)

# Alert Support
In addition to supporting ```email``` alerts, Kafka Eagle also supports im alerts, such as ```DingDing``` and ```WeChat```.
![DingDing Alert](http://www.kafka-eagle.org/images/docs/dingding_alert@2x.png)
![WeChat Alert](http://www.kafka-eagle.org/images/docs/wechat_alert@2x.png)

# List of Consumer Groups & Active Group Graph
![Consumer & Active Graph](http://www.kafka-eagle.org/images/docs/consumer@2x.png)

# List of Topics Detail
![Topics](http://www.kafka-eagle.org/images/docs/list@2x.png)

# Consumer & Producer Rate Chart
![Rate Chart](http://www.kafka-eagle.org/images/docs/consumer_rate_graph@2x.png)

# Start Kafka Eagle
![KE Script](http://www.kafka-eagle.org/images/docs/startup@2x.png)

# 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. Kafka Eagle 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).
  
Kafka Eagle supports multiple offset storage paths. If you store them in Zookeeper and Kafka, you can configure them like this.
```
# Set kafka cluster alias
kafka.eagle.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.kafka.eagle.offset.storage=kafka
cluster2.kafka.eagle.offset.storage=zookeeper
```

# Kafka SQL

Use the SQL statement to query the topic message log, and visualize the results, you can read [Kafka SQL](http://www.kafka-eagle.org/articles/docs/quickstart/ksql.html) to view the syntax.
For example, if you kafka has a topic with three partitions, the ksql query statement is as follows.
```
select * from "kafka_topic_name" where "partition" in (0,1,2) limit 10
```

![ksql](http://www.kafka-eagle.org/images/docs/kafka_sql@2x.png)
![ksql_result](http://www.kafka-eagle.org/images/docs/kafka_sql_result@2x.png)

# Quickstart

Please read [Kafka Eagle Install](http://www.kafka-eagle.org/articles/docs/installation/linux-macos.html) for setting up and running Kafka Eagle.

# Deploy

The project is a maven project that uses the Maven command to pack the deployment as follows:
```bash
./build.sh
```
# More Information

Please see the [Kafka Eagle Manual](http://www.kafka-eagle.org/articles/docs/documentation.html) for for more information including:
  * System environment settings and installation instructions.
  * Information about how to use script command.
  * Visual group,topic,offset metadata information etc.
  * Metadata collection and log change information.
 
# Contributing

The Kafka Eagle 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.

# Kafka Eagle PDF

[Kafka Eagle Architecture PDF](http://www.kafka-eagle.org/articles/docs/architecture/pdf.html)

# Contributors

Thanks to the following members for maintaining the project.

|Alias |Github |Email |
|:-- |:-- |:-- |
|smartloli|[smartloli](https://github.com/smartloli)|smartloli.org@gmail.com|
|hexiang|[hexian55](https://github.com/hexian55)|hexiang55@gmail.com|
|cocodroid|[cocodroid](https://github.com/cocodroid)|sujunguang@gmail.com|
|alisa|[alisa](https://github.com/zoumm)|alisazou1211@gmail.com|
|iamwzt|[iamwzt](https://github.com/iamwzt)|981911861@qq.com|