# Kafka-lag-monitor

**Repository Path**: alvin-1998/kafka-lag-monitor

## Basic Information

- **Project Name**: Kafka-lag-monitor
- **Description**: 这是一个用于监控kafka消息堆积的监控工具，当堆积数达到预设阈值时，该工具会自动发送告警通知，帮助开发及运维人员及时发现并解决消息堆积问题，确保kafka集群的稳定性和性能。
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2024-01-04
- **Last Updated**: 2024-10-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Kafka消息堆积监控工具

## 简介

这是一个用于监控kafka消息堆积的监控工具，当堆积数达到预设阈值时，该工具会自动发送告警通知，帮助开发及运维人员及时发现并解决消息堆积问题，确保kafka集群的稳定性和性能。

## 特性

- **实时监控**：该工具可以实时监控kafka消息堆积情况，并及时发出告警通知，无须人工干预。
- **可配置阈值**： 可以根据实际需求设置不同的堆积阈值，以便更好的控制消息堆积问题。

## 使用指南

### 下载安装包

- 安装包文件：kafka-lag-monitor.tar.gz
- 解压安装包

```shell
tar -zxvf kafka-lag-monitor.tar.gz	
```

- 解压目录结构说明：

```
├── kafka-lag-monitor                     #主程序二进制文件
├── kafka-lag-monitor.exe                  #主程序(windows环境)
├── config.json                           #配置文件
```

### 修改配置文件

- 加载方式： kafka-lag-monitor服务启动时加载生效，若变更配置文件内容，需重启服务加载更新后的配置信息。
- 相关配置：

```json
{
  "appid": "010111",
  "kafka": {
    "kafka_name": "xxx系统kafka",
    "brokers": "{ip}:9092,{ip}:9092,{ip}:9092",
    "consumer_group": "xxx,xxx"
  },
  "alarm": {
    "poll_second": 3, //间隔多久查询一次 /秒
    "threshold": 5,   //堆积的阈值
    "count": 3,       //连续几次都超过阈值
    "webhook": "",
    "notice_template": "kafka名称：{kafka_name}数据堆积 \nbrokers：{brokers} \n消费组：{consumer_group} \n监听的topic：{topic} \n发生时间：{start_time}-{end_time} \n触发值：{alarm_threshold} \n累计次数：{poll_second} \n最后一次堆积量：{lag_count}"
  },
  "log": {
    "file_path": "/log"
  }
}
```

### 启动

```shell
#设置权限
chmod +x kafka-lag-monitor
#启动
nohup ./kafka-lag-monitor >/dev/null 2>1& &
#检查是否启动成功
ps -ef|grep kafka-lag-monitor
#停止
kill -9 {pid}
```