2 Star 22 Fork 11

开源分享 / mrxu-monitor

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

1 Monitor API 是什么?

API监控平台是专门为SpringBoot微服务打造 的实时监控中心,对业务代码零侵入,只需引入jar包开启yml配置即可收集 API的运行状况和性能数据,并通过大屏进行直观展示。 内置告警通知可以对我们的 http错误状态码、业务错误状态码、慢请求、cc攻击做出预警。
说明:项目必须依赖redis,启动成功后默认通过 http://您的ip:你的端口/monitor/index.html访问(和swagger原理一样)。 效果图

2 监控指标

  1. 今日pv:当天访问网站接口的总次数。
  2. 今日uv:当天访问网站的ip个数。
  3. 错误数:当天接口返回http状态码非200和304个数。
  4. 业务异常:当天接口返回业务状态码错误数。
  5. 告警次数:当天触发告警次数。
  6. 异常告警(列表):当天触发的告警明细。
  7. 今日耗时接口top10:当天平均耗时最高的10个接口。
  8. 今日状态码码:当天http状态码分布饼状图 。
  9. 今日热门接口top10:当天请求次数最多的10个接口。
  10. 接口流量:当日接口返回数据大小总和。
  11. 总接口数:当日请求接口的总个数。
  12. 今日浏览器类型:当日请求的浏览器top4.
  13. 今日移动端占比:当日移动端请求与当日pv比值。
  14. 访问最多的国家:当日访问最多的国家
  15. 访问最多的省份: 当日访问最多的省份(国外的显示国家)
  16. 访问最多的城市: 当日访问最多的城市(国外的显示国家)

3 项目使用方式

  1. 引入pom文件
<dependency>
    <groupId>com.mrxu</groupId>
    <artifactId>mrxu-monitor</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>
  1. 启动类引入监控启动配置项(demo)
@SpringBootApplication
@EnableMonitor
public class MrxuDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(MrxuDemoApplication.class, args);
    }

}
  1. 项目配置文件
# 项目redis 配置
spring:
  redis:
    host: 你的redis地址
    port: 6379
    password: 你的redis密码
    
monitor:
  # 项目是否开启 api监控
  enable: true
  # 项目名称,也是redis key前缀的一部分
  projectCode: mrxu-demo
  # 访问监控大屏的密码
  viewPassword: cmcc
  # 告警通知渠道
  notify:
    # 钉钉告警 https://open.dingtalk.com/document/robots/custom-robot-access
    dingDingWebhook: https://oapi.dingtalk.com/robot/send?access_token=XXXX
    # 飞书告警 https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot
    feiShuWebhook: https://open.feishu.cn/open-apis/bot/v2/hook/XXXX
    #企业微信告警
    qiYeWeiWinWebhook: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXXX
    # 邮箱告警收件人,发件人详见mail.setting 配置
    toEmail:
      - '收件邮箱地址'
  # 拦截器规则
  interceptor:
    # 需要拦截的路径,默认全部
    path:
      - '/**'
    # 需要排除的路径
    excludePath:
    #- '/*.css'
    # 需要排除的ip
    excludeIp:
    #- '127.0.0.1'
    #- 'localhost'
  # 攻击相关配置
  attack:
    # 同一个ip每秒超过多少次访问认定为攻击
    limitCountPerSecond: 60
  # http状态码配置
  httpStatusConfig:
    enable: true
    # 每秒http状态码非200和304个数超过多少触发预警
    httpStatusErrorCountLimitPerSecond: 50
  # 慢请求配置
  timeOutConfig:
    enable: true
    # 每秒慢请求个数超过多少触发告警
    limitCountPerSecond: 3
    # 接口响应数据大于多少认为是慢请求
    limitMilliSecond: 1000
  # 业务异常状态码
  businessCode:
    # 是否开启业务异常状态码监控
    enable: true
    # 业务状态码key如返回:{code:200,msg:"成功",data:null} 业务状态码为code
    codeName: code
    # 正常的业务状态码
    successCode: 0
    # 业务状态码非正常每秒超过多少触发告警
    limitErrorCountPerSecond: 20
    # 监控特殊状态码用于感知系统异常
    errorCodeNotice:
      203: 发票余额不足
      201: 实名认证失败
  1. 邮箱告警邮件发送方配置
    # 配置相关文档:https://hutool.cn/docs/#/extra/%E9%82%AE%E4%BB%B6%E5%B7%A5%E5%85%B7-MailUtil?id=%e5%8f%91%e9%80%81%e9%82%ae%e4%bb%b6
    # 邮件服务器的SMTP地址,可选,默认为smtp.<发件人邮箱后缀>
    host = smtp.qq.com
    # 邮件服务器的SMTP端口,可选,默认25
    port = 465
    # 发件人(必须正确,否则发送失败)
    from = 你的qq@qq.com
    # 用户名,默认为发件人邮箱前缀
    user = 你的qq@qq.com
    # 密码(注意,某些邮箱需要为SMTP服务单独设置授权码,详情查看相关帮助)
    pass = XXXXXXXXXXX
    
    # 使用SSL安全连接
    sslEnable = true

4 告警相关

4.1 异常告警类型

  1. http状态码每秒非200和304个数超过配置阈值:当黑客尝试一些常见服务的路径如:swagger、springboot健康检查等服务常见路径,从而利用这些服务的漏洞对我们服务器进行渗透攻击。这种尝试通常会触发我们服务大量404状态,从而触发告警。
  2. 业务状态码错误数每秒超过配置阈值:项目中如果状态码错误数过多,在一定程度上会影响用户或接口调用方的体验,当这种告警出现时说明有人在渗透我们系统或前端校验不足。黑客暴力破解密码时也会触发告警。
  3. 单个ip每秒请求次数超过阈值:黑客通过接口爬取网站数据,会触发该预警。
  4. 慢请求每秒超过配置阈值:可以根据配置文件配置接口响应时间超过多少毫秒定义为慢请求,配置每秒超过多少触发告警。
  5. 接口返回配置文件中自定义异常业务状态码:当我们需要监控某种错误时可以配置该状态码,当出现该错误时及时通知相关人员。

4.2 告警方式

  1. 钉钉(webhook方式)
  2. 企业微信(webhook方式)
  3. 飞书(webhook方式)
  4. 邮箱

4.3 告警收敛

为了防止告警消息太多,我们针对每种告警类型做了限制,每种告警类型30秒内只会告警一次。

5 数据收集方式

  1. 通过类_ApiResponseBodyAdvice对我们系统所有RESTFULL API接口做切面拦截。收集接口的请求ip、请求路径、返回状态码、接口耗时、返回数据大小、请求浏览器类型等信息。改类命名以下划线开头为了是让该切面处理排到业务定义的切面后处理。
  2. 请求来源地址,获取请求来源ip,通过本地ip数据库文件获取ip归属地。
  3. 数据持久化采用redis存储。
  4. 为了防止收集指标数据已经频繁操作redis对我们业务产生影响,我们使用本地内存,并处理可能产生的异常,然后通过定时任务每秒向redis中写入。

6 代码目录

├── src/ # 源码路径
│ ├── main/ 
│ │ └── java/ # java 源代码
│ │   └──── com.mrxu.monitor # 监控相关java代码包
│ └── resource/ # 配置文件demo
├── README.md #说明文档
└── pom.xml #maven pom 文件

7 总结

欢迎拍砖。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Java 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/open-sharing/mrxu-monitor.git
git@gitee.com:open-sharing/mrxu-monitor.git
open-sharing
mrxu-monitor
mrxu-monitor
master

搜索帮助