# KafkaCenter

**Repository Path**: jun-miss/KafkaCenter

## Basic Information

- **Project Name**: KafkaCenter
- **Description**: KafkaCenter是Kafka 集群管理和维护，生产/消费监控，生态组件使用的统一一站式平台
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 79
- **Created**: 2020-03-31
- **Last Updated**: 2020-12-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="right">Language: <a title="English" href="./README.md">:us:</a>
:cn:
</div>

# KafkaCenter
KafkaCenter是Kafka 集群管理和维护，生产/消费监控，生态组件使用的统一一站式平台。

[GitHub地址](https://github.com/xaecbd/KafkaCenter) 第一时间更新，请移步查看！

- [KafkaCenter](#kafkacenter)
  - [Main Features](#main-features)
  - [Getting Started](#getting-started)
    - [Building and Running KafkaCenter, and/or Contributing Code](#building-and-running-kafkacenter-andor-contributing-code)
  - [Documentation](#documentation)
  - [TODO](#todo)
  - [Changelog](#changelog)
  - [Questions? Problems? Suggestions?](#questions-problems-suggestions)

## Main Features
![avatar](docs/images/kafka-center.png)
![avatar](docs/images/screenshot.png)

- **Home**->
查看平台管理的Kafka Cluster集群信息及监控信息
- **Topic**->
用户可以在此模块查看自己的Topic，发起申请新建Topic，同时可以对Topic进行生产消费测试。
- **Monitor**->
用户可以在此模块中可以查看Topic的生产以及消费情况，同时可以针对消费延迟情况设置预警信息。
- **Kafka Connect**->
实现用户快速创建自己的Connect Job，并对自己的Connect进行维护。
- **KSQL**->
实现用户快速创建自己的KSQL Job，并对自己的Job进行维护。
- **Approve**->
此模块主要用于当普通用户申请创建Topic，管理员进行审批操作。
- **Setting**->
此模块主要功能为管理员维护User、Team以及kafka cluster信息
- **Kafka Manager**->
此模块用于管理员对集群的正常维护操作。

## Config
[application.properties](KafkaCenter-Core/src/main/resources/application.properties)

## Getting Started

**Important**: 项目配置信息存储在**mysql**中，因此必须mysql数据库.

资源|依赖情况|用途
---|---|---
mysql|必须|配置信息存储在**mysql**
elasticsearch(7.0+)|非必须|监控信息，例如集群metirc,消费lag可视化等
邮件服务器|非必须|申请、审批，告警邮件提醒
### 1.首先创建数据库及修改配置
#### 创建数据库及表
在数据库中执行[table_script.sql](KafkaCenter-Core/sql/table_script.sql)
#### 初始化配置
下载[application.properties](KafkaCenter-Core/src/main/resources/application.properties),按自己需求修改相应的配置
### 2.其次运行服务
- Docker run(**推荐**)

```
docker run -d -p 8080:8080 --name KafkaCenter -v ${PWD}/application.properties:/opt/app/kafka-center/config/application.properties xaecbd/kafka-center:2.0.1
```

- Local run

**Important**: 项目运行依赖jre11
```
$ git clone https://github.com/xaecbd/KafkaCenter.git
$ cd KafkaCenter
$ mvn clean package -Dmaven.test.skip=true
$ cd KafkaCenter\KafkaCenter-Core\target
$ java -jar KafkaCenter-Core-2.0.1-SNAPSHOT.jar
```

### 3.最后访问系统

访问`http://localhost:8080`,管理员用户与密码默认：**admin/admin**
### Building and Running KafkaCenter, and/or Contributing Code

You might want to build KafkaCenter locally to contribute some code, test out the latest features, or try
out an open PR:

- [CONTRIBUTING.md](CONTRIBUTING.md) will help you get KafkaCenter up and running.

## Documentation

更多文档详见： [KafkaCenter/docs](./docs).<br/>
系统模块简介：[KafkaCenter/docs/Module](./docs/Module.md).<br/>
用户使用文档：[KafkaCenter/docs/UserGuide](./docs/UserGuide.md)  
KafkaConnectUi文档：[KafkaConnectUi](./docs/KafkaConnectUi.md). 

## TODO

See [TODO List](https://github.com/xaecbd/KafkaCenter/projects/1)

## Changelog

See [CHANGELOG.md](CHANGELOG.md)

## Questions? Problems? Suggestions?

- If you've found a bug or want to request a feature, please create a [Issue](https://github.com/xaecbd/KafkaCenter/issues/new).
Please check to make sure someone else hasn't already created an issue for the same topic.
- Need help using KafkaCenter? Ask EC Bigdata Team member.