[Github地址](https://github.com/AutohomeCorp/frostmourne) | [Gitee地址](https://gitee.com/tim_guai/frostmourne) | [中文](./README.md) | [English](./README_en.md)
# 📖 介绍
`Frostmourne`(霜之哀伤)是汽车之家经销商技术部监控系统的开源版本，用于帮助监控几乎所有数据库数据(包括`Elasticsearch`, `Prometheus`, `SkyWalking`, `MySql` 等等)。如果你已经建立起了日志系统，
指标体系，却苦恼于没有一个配套监控系统，也许它能帮到你。使用本系统得当，至少可以做到线上应用出了什么问题，相关开发能第一时间了解报错情况，知道问题出在哪里，
可以快速响应处理，几乎先于所有人知道线上的情况，也因为心中有数所以可以从容应对各种问询，一点都不慌，你们团队值得拥有。
### 项目初衷
在用`ELK`建立起日志系统之后，我们发现应用日志监控这块除了`ElastAlert`之外，没有其他方案。我们初期使用`ElastAlert`来解决日志监控的问题，
但是随着配置的增加，不仅管理成本和使用成本较高，稳定性方面也不能让我们满意，所以为了更好的易用性，稳定性，我们决定自己做一套简单的监控系统，
来解决日志监控的问题。
项目并不局限于`Elasticsearch`数据，还支持`HTTP`, `PING`, `Telnet`监控，`Prometheus`, `SkyWalking`, `InfluxDB`，`MySQL`, `ClickHouse`, `IoTDB`, `SqlServer`数据监控，
后面还会加入更多的常用数据源(如：`Loki`, `MongoDB`, `Redis`, `Oracle` 等)纳入监控范畴，需要做的东西还有很多，需要更多相关开发加入进来，欢迎联系我们，一起做大做强。
# ✨ 主要功能
* 只需要写一条数据查询就可以轻松搞定监控
* 多种数据源支持：`Elasticsearch, HTTP, SkyWalking, Prometheus, InfluxDB, MySQL/TiDb, ClickHouse, SqlServer, PING, IotDB, Telnet`
* 数值计算类型监控：`count, min, max, avg, sum, unique count, percentiles, standard deviation`; `Elasticsearch`数据支持分桶
* 多种报警消息发送方式：钉钉(机器人)、企业微信(机器人)、飞书机器人、Email、短信、HTTP
* 多种消息格式：`text, markdown`
* 灵活的报警消息`Freemarker`模板定制，支持变量占位符；消息模板管理
* 分布式调度实现，每个监控都是独立调度，互不影响
* 报警消息附带日志查询短链接，直达报警原因
* 数值同比，环比监控
* `HTTP`数据监控, `Javascript`表达式判断是否报警; `PING`连通监控, `Telnet`端口连通监控
* 前端简单易用：监控管理、测试、另存、执行日志和历史消息
* `Elasticsearch`数据查询、分享和下载
* 报警消息抑制功能，防止消息轰炸；也有报警升级功能，避免故障相关方长时间得不到通知。
* 自带账号，团队，部门信息管理模块，也可自己实现内部对接
* 集成`LDAP`登录认证
* 权限控制，数据隔离，各团队互不影响
#### 企业微信机器人报警截图展示： （查看完整功能截图展示）
## 目录
- [介绍](#-介绍)
- [主要功能](#-主要功能)
- [在线demo](#-在线demo)
- [快速启动](#-快速启动)
- [部署](#-部署)
- [环境准备](#预备环境准备mysql数据库表创建)
- [k8s部署方式](#一k8s部署方式)
- [zip包部署方式](#二zip包部署方式)
- [自构建部署方式](#三自构建部署方式)
- [功能使用指南](#-功能使用指南)
- [开发调试](#-开发调试)
- [后续规划](#后续规划)
- [发版历史](./ReleaseNotes.md)
- [Contributors](#-contributors)
# 💻 在线demo
为了更快的理解本项目的作用，提供了一个接口全`mock`的静态站点供大家预览功能: 在线demo
在线`demo`更新不及时，请以项目实际运行效果为准，`demo`只是用于快速浏览
# 📦 快速启动
提供`docker-compose`方式，让你更快运行起来便于更好理解项目作用。详细请看文档：Quick-Start
# 🧰 部署
#### 预备环境准备：`MySQL`数据库表创建
> Frostmourne所有表的创建语句都在 [frostmourne.sql](./doc/mysql-schema/frostmourne.sql) 文件中。
数据库密码默认使用明文，没有加密策略。如果你需要对密码进行加密，请参考druid官方文档：[druid数据库密码加密](https://github.com/alibaba/druid/wiki/%E4%BD%BF%E7%94%A8ConfigFilter)
#### 一、`k8s`部署方式
`k8s`部署参考以下三个配置文件
* [frostmourne-monitor-namespace.yaml](./doc/docker/k8s/frostmourne-monitor-namespace.yaml)
* [frostmourne-monitor-deployment.yaml](./doc/docker/k8s/frostmourne-monitor-deployment.yaml)
* [frostmourne-monitor-service.yaml](./doc/docker/k8s/frostmourne-monitor-service.yaml)
相关参数在 `frostmourne-monitor-deployment.yaml` 文件里配置。需要注意的是在`frostmourne-monitor-service.yaml`里指定对外映射端口，默认`nodePort=30054`
```bash
kubectl applt -f frostmourne-monitor-namespace.yaml
kubectl applt -f frostmourne-monitor-deployment.yaml
kubectl apply -f frostmourne-monitor-service.yaml
```
#### 二、`zip`包部署方式
依赖环境
* `JDK 1.8`
* `MySQL 5.7.8+`
最新的Release版本zip包，请到 [releases](https://github.com/AutohomeCorp/frostmourne/releases) 中下载，解压后然后根据自己的环境修改应用配置文件`application.properties`文件和环境变量配置文件`env`，然后执行如下命令启动：
```bash
./scripts/startup.sh
```
执行如下命令停止应用：
```bash
./scripts/shutdown.sh
```
#### 三、自构建部署方式
依赖环境
* `JDK 1.8`
* `Maven 3.2.x+`
* `MySQL 5.7.8+`
在项目`frostmourne`主目录下执`maven`构建命令：
```bash
mvn -U clean package -DskipTests=true
```
前端项目`frostmourne-vue`会自动把资源构建到`frostmourne-monitor`的`resources/dist`下，所以你只需要部署`frostmourne-monitor`即可。
`frostmourne-monitor`已经配置了`assembly`打包，`target`目录下会生成`zip`包，你只需要将`zip`包解压，然后根据自己的
环境修改应用配置文件`application.properties`文件和环境变量配置文件env，然后执行如下命令启动：
```bash
./scripts/startup.sh
```
执行如下命令停止应用：
```bash
./scripts/shutdown.sh
```
# 📚 功能使用指南
# 🛠 开发调试
调试环境要求
* `JDK 8 ~ 14`
* `Node 16.14.2 (推荐)`
* `Yarn 1.22.10 (推荐) 或 Npm 8.7.0`
* `MySQL 5.7.8+`
* `Elasticsearch 6.3.2+`
启动`frostmourne-monitor`项目, 启动参数增加：
```
-Dmysql.host=localhost -Dmysql.user=root -Dmysql.password=example -Dlog.console.level=INFO
```
`MySQL`相关参数修改为自己环境的，`active profile`设置为`local`, 测试地址: http://localhost:10054
使用`VS Code`打开`frostmourne-vue`目录，进行前端调试。执行如下命令:
```bash
# install dependency
yarn install
# 建议不要直接使用 cnpm 安装以来，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
yarn install --registry=https://registry.npm.taobao.org
# develop
yarn dev
```
会自动打开： http://localhost:9528
搭建本地开发调试环境或者需要做二次开发遇到什么困难的都可以加群沟通，欢迎各路英雄多多PR
技术说明项目基于`Java8`实现，详细请看：[技术说明](./doc/wiki/technical.md)
# ⚙后续规划
* 发布1.0-RELEASE
* 增加本项目内程序日志采集至MySQL并提供查询页面，方便排查问题和监控
* Elasticsearch数据名增加kibana链接配置，在数据查询页面增加kibana地址跳转链接，方便将数据查询切换至kibana
* 短信报警方式实现，默认用阿里云短信实现
* 增加阿里云日志数据监控
* 增加腾讯云日志数据监控
* 增加华为云日志数据监控
* 完成英语国际化
* 增加 [loki](https://github.com/grafana/loki) 数据监控报警
* 增加邮箱在线配置页面功能
* 增加企业微信在线配置页面功能
* 将短链接id以16进制格式展示，解决id数字很大的时候较长的问题
* pom优化
* 员工换组增加是否迁移监控至新组的选项，如果勾选将该员工创建的监控也转移至新组
* 增加报警组支持
* Elasticsearch数据名增加traceid字段配置，可以配置跳转链接。例如: 配置skywalking的链接将跳转到skywalking对应的调用链
* 增加时序数据历史数据比较规则
* 监控增加报警消息允许发送时间段设置，非允许发送时间段内消息将只记录不发送，发送状态为FORBID
* 增加企业钉钉发消息默认实现(本地没有环境，需要帮助，欢迎PR，或者提供示例代码，先行谢过)
* 更多报警方式补充（欢迎PR）
* 增加 [skywalking](https://github.com/apache/skywalking) `Database Layer` 数据监控报警支持
* 监控列表增加一个开关选项，只显示我的监控
* Elasticsearch数据名配置时自动提示索引名称
* 引入对象迭代器，迭代器代表从数据源中得到一个List数据列表，或者自定义输入；用于动态生成监控查询语句，例如: Level: ERROR AND Project: ${ITEM_VALUE}；达到数据遍历监控的效果；
* 发布1.0-RELEASE
* 3-sigma离群点检测报警规则
* 加入时序数据异常检测算法规则(需要实验可行性 [基于时间序列的异常检测](https://blog.rexking6.top/2018/11/05/%E5%9F%BA%E4%BA%8E%E6%97%B6%E9%97%B4%E5%BA%8F%E5%88%97%E7%9A%84%E5%BC%82%E5%B8%B8%E6%A3%80%E6%B5%8B/))
* 总结项目用到的知识点
# 🗓 [发版历史](./ReleaseNotes.md)
# 👍 [致谢](./doc/wiki/thank.md)
# 👷 Contributors
[@menong-chen](https://github.com/menong-chen) [@fox2zz](https://github.com/fox2zz) [@xyzj91](https://github.com/xyzj91)
[@wxmclub](https://github.com/wxmclub) [@Aping](https://github.com/wuaping) [@limbo](https://github.com/limboinf)
[](https://github.com/AutohomeCorp/frostmourne/graphs/contributors)
# 💡️ 如何参与贡献
如果你觉得这个项目对你有所帮助想有所回馈，非常欢迎参与贡献。可以通过如下方式：
* 从后续规划里选择合适的任务提交`PR`
* 对文档进行必要补充
* 部署本项目使用起来并通过 [`github`](https://github.com/AutohomeCorp/frostmourne/issues/17) 或 [`gitee`](https://gitee.com/tim_guai/frostmourne/issues/I560YJ) 告知
* 帮忙扩散推广
* 在 [`issue`](https://github.com/AutohomeCorp/frostmourne/issues) 提出你的宝贵建议
* 加入交流群，解答交流问题。群内会不定时发布项目更新说明
* 开源不易，star鼓励
* [代码规范说明](./doc/wiki/code_format.md)
# 💬 联系我们
有问题需要帮助或者交流可以添加下边的微信群或QQ群，请优先选择提 [issue](https://github.com/AutohomeCorp/frostmourne/issues) ，便于问题的讨论和记录追踪，也方便有类似问题的伙伴搜索解决。也欢迎对项目感兴趣的同僚加群交流。
特别提一下：关于文档觉得哪里写的不通畅，不好理解，或者有哪方面缺失，都欢迎提 [issue](https://github.com/AutohomeCorp/frostmourne/issues) 。
# 📌 项目事记
* 2019-12-16: 发布`github`
* 2020-06-14: 发布`gitee`
* 2020-07-02: 合并第一个`PR`
* 2020-07-04: 被`elastic`中文社区收录 [Elastic日报988期](https://elasticsearch.cn/article/14018)
* 2020-07-13: github项目设置为私有，丢失82个`star`，29个`fork`
* 2020-07-15: 重新公开`github`
* 2020-08-23: 上`gitee`推荐
* 2020-08-27: `gitee star`破百
* 2020-10-12: `github star`破百
# 👥 已注册使用者
通过 [`github`](https://github.com/AutohomeCorp/frostmourne/issues/17) 或 [`gitee`](https://gitee.com/tim_guai/frostmourne/issues/I560YJ) 登记的使用者
# ⭐️ Stargazers over time
[](https://starchart.cc/AutohomeCorp/frostmourne)
