# htd-apm

**Repository Path**: LevelCoder/htd-apm

## Basic Information

- **Project Name**: htd-apm
- **Description**: 收集各类监控主体的异常信息，通过日志收集、分析、异常规则匹配，以多种方式通知告警到相关人员，全面提升告警管理能力（支持三方告警平台及监控工具快速集成）
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2024-11-23
- **Last Updated**: 2024-11-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基础项目-告警系统
- [项目简介](#项目简介)
- [使用说明](#使用说明)
- [使用效果](#使用效果)
- [项目结构](#项目结构)
- [库表结构](#库表结构)
- [核心功能](#核心功能)
- [项目启动](#项目启动)
- [模块启停](#模块启停)
- [版权所有](#版权所有)


## 项目简介
```
   告警系统目标是收集各类监控主体的异常信息，通过日志收集、分析、异常规则匹配，以多种方式通知告警到相关人员，全面提升告警管理能力（支持三方告警平台及监控工具快速集成）
```
## 使用说明
```
项目需要用到MySQL、redis、es、xxl-job;如果没有可提前安装；如果不想安装可将相关配置注释掉，启动简易工程
启动可访问：http://localhost:8080/htd-apm/test，测试效果
OneAlertController类里面uniformAlert方法提供统一对外告警方法，可供调用
LogAnalyzeErrorRecordTask定时任务类，从es拉取待告警内容
目前对外开放邮件推送功能展示；如需其他推送功能请自行研究集成。
对于系统个jar包版本升级可根据需要升级。
```


## 使用效果
```
https://images.gitee.com/uploads/images/2021/1026/180134_a37b8f23_9885867.png
```

## 项目结构
- api层：对外暴露接口服务
- assemble层：controller、配置类
- service层：业务核心处理
- dmo层：数据模型对象
- common层：一些常用工具类
```
目前项目名称以 htd-apm 展示,可根据需要更项目名称
```
## 库表结构
```
- alarms_info：告警内容，发送的告警内容
- log_analyze_error_record：告警分析表，可从es等拉取异常内容
- one_alert_alarms_record： 告警发送记录表
- one_alert_filter_key：告警过滤条件 （ES查询条件）
- one_alert_key：根据具体业务可有可无
```
  
# 核心功能
```
- **mybatis 集成** （项目必须）
- **redis 集成** （可关闭）
- **rabbitmq 集成** （可关闭））
- **druid 集成** （可关闭）
- **dubbo 集成** （可关闭）
- **xxl-job集成**（可关闭）
- **ES集成**（可关闭）
- **邮件集成**（可关闭）
- **常用工具类** (选择性使用)
```
# 项目启动
```
直接在assemble层，找到HtdApmAssembleApplication。启动即可。多环境可根据需要自行添加配置
```
# 模块启停
```
项目集成了很多模块，可根据具体项目选择性启停功能，如集成的Redis
如不需要，则只需将RedisConfig中的@Configuration注解去掉即可。
其他可关闭模块类似

```
## 版权所有
```
汇通达
```