共计 5216 个字符，预计需要花费 14 分钟才能阅读完成。

由于业务需要，我司的产品越来越多，api 接口监控相对比较薄弱，对此要搭建 HTTP(s)的监控系统，之前一直使用第三方的监控系统，比如阿里云的云监控。

基本流程

1. 了解需求。

2. 通过各种途径了解有没有相关免费解决方案

3. 本地搭建实施，评估上线。

4. 上线部署 使用。

本文记录希望找到开源监控系统走的弯路，apimonitor 和 apitestplatform 都有这样或者那样的问题。最终找到对应的开源监控 uptime-kuma，并且有以外惊喜，如果有其他的需求也可以按照此流程进行。

业务需求

1. 开源、免费

2. 定时监控生产环境的接口链接，如果出现访问非 200 的、超时，则报警。

3. 告警方式：邮件、短信、钉钉群通知、电话等

4. 支持本地 Linux 服务器部署

5. 类似阿里云的“云监控”– 站点监控，如图。第三方参考解决方案https://www.jiankongbao.com/

测试系统

服务器系统：Centos7

IP 地址：192.168.1.5

服务器已安装：nginx 和 docker

开源产品

在网上搜索、问同事和相关从业经验的人，是否有相关的监控产品。

一、系统监控产品 apimonitor（项目已关闭）

apimonitor 有 api 探测、api 监控、http 请求模拟、系统接口监控等功能，可以模拟 http 页面操作过程，并根据请求耗时和响应结果监控系统接口可用性和正确性。

开源地址：https://gitee.com/ecar_team/apimonitor

查看功能部分符合，但是需要二次开发，可以在此开源项目上开发

1. 新增告警功能，通过邮件、短信、钉钉群通知等。

2. 新增访问时长记录。

二、apitestplatform（亲测有 bug）

一个 web 界面的接口自动化测试平台

git 地址：https://github.com/342164796/apitestplatform

安装步骤

cd /datagit clone https://github.com/342164796/apitestplatformcd apitestplatform/首次部署需要在 settings.py 文件里修改 mysql 的地址和账户名密码为自己的数据库地址vi apitestplatform/settings.py'default': {        'ENGINE': 'django.db.backends.mysql',        'HOST': "*.*.*.*",        'NAME': "apitestplatform",        'USER': "user",        'PASSWORD': "password",        'PORT': "3306",        # 'CHARSET': 'utf8',        # 'COLLATION': 'utf8_general_ci',    }​2. 初始化数据库，执行如下命令：python3.6 manage.py makemigrationspython3.6 manage.py migrate​python3.6 manage.py runserver​    

安装的踩坑记录

1.SyntaxError: invalid syntax

# python manage.py runserver   File "manage.py", line 14    ) from exc         ^SyntaxError: invalid syntaxpython 版本太低，系统自带为 2.7升级安装 python3.6# python -VPython 2.7.5​# python3.6 -VPython 3.6.8

2.Couldn’t import Djang

没有安装 django

# python3.6 manage.py runserver Couldn't import Django. Are you sure it's installed and available on your PYTHONPATH environment variable? Did you forget to activate a virtual environment?​安装 Django​虚拟环境里用 python3 安 django 和 uwsgi（如果用于生产的话，则需要指定安装和你项目相同的版本）​pip3.6 install djangopip3.6 install uwsgi

3. 没有安装 pymysql

再次报错：# python3.6 manage.py runserver ModuleNotFoundError: No module named 'pymysql'解决：# pip3.6 install pymysql再次报错：# python3.6 manage.py runserver ModuleNotFoundError: No module named 'django_crontab'

4. 没有安装 django-crontab

报错 django.db.utils.OperationalError: (2003, "Can't connect to MySQL server on '*.*.*.*' ([Errno -2] Name or service not known)") 解决：# pip3.6 install django-crontab​

启动成功

# python3.6 manage.py runserver You have 29 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, base, contenttypes, sessions.Run 'python manage.py migrate' to apply them.March 02, 2022 - 10:31:01Django version 3.2.12, using settings 'apitestplatform.settings'Starting development server at http://127.0.0.1:8000/Quit the server with CONTROL-C.

启动成功

# python3.6 manage.py runserver ​Django version 3.2.12, using settings 'apitestplatform.settings'Starting development server at http://127.0.0.1:8000/Quit the server with CONTROL-C.

nginx 反向代理

​server {        listen       80;        server_name  apitest.test.me;        #root /data/wwwroot/web/apitest.test.me/;        access_log /data/wwwroot/log/apitest.test.me-access.log main_aliyun;        error_log off;​        location / {                proxy_pass      http://127.0.0.1:8000;                proxy_redirect off;                proxy_set_header Host $host;                proxy_set_header X-Real-IP $remote_addr;                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;​        }​}​绑定 hosts 访问192.168.1.5 apitest.test.me

添加项目报错：

由于不太清楚报错的原因。放弃此开源项目。

三、开源监控 uptime-kuma

继续百度搜索查找，在知乎的页面中找到一个 @无为无谓 的回答，页面https://www.zhihu.com/question/23755976

他推荐了一个开源产品，uptime-kuma。

uptime-kuma 地址：https://github.com/louislam/uptime-kuma

反向代理教程：https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy

演示网站:

https://demo.uptime.kuma.pet:27000/ 创建管理员账号，有 10 分钟的体验时间。

查看演示基本能满足需要，在本地搭建测试，功能都符合我的要求，居然还有惊喜，首先界面很精美，再次除了有基本的 HTTP(S)的监控的，还有 TCP 端口监控、PING 监控、HTTP（s）关键字监控、DNS 监控、Push 监控、Steam Game Server 监控，功能相当多，重点是都是免费的，只要有服务器，或者局域网的虚拟机（可访问外网）就可以监控你的各种服务。

docker 部署 uptime-kuma

本次使用 docker 安装如果，需要非 docker 参考开源文档。

# mkdir -p /data/docker/uptime-kuma/data# docker run -d --restart=always -p 3001:3001 -v /data/docker/uptime-kuma/data:/app/data --name uptime-kuma louislam/uptime-kuma:1​​# netstat -tunpl|grep 3001tcp6       0      0 :::3001                 :::*                    LISTEN      29542/docker-proxy-

访问：

http://192.168.1.5:3001 访问，创建管理员账号。

nginx 代理访问

server  {    listen 80;    server_name    uptime.test.me;    location / {        proxy_pass         http://localhost:3001;        proxy_http_version 1.1;        proxy_set_header   Upgrade $http_upgrade;        proxy_set_header   Connection "upgrade";        proxy_set_header   Host $host;    }}绑定 hosts 访问192.168.1.5 uptime.test.me

基本设置

设置里面功能还比较齐全，有外观设置，消息通知重点是消息通知有，邮件、钉钉、短信、飞书等等的第三方通知，相当齐全。

外观设置

通知设置

创建监控项

HTTPS 监控图

端口 TCP 检测

关闭 nginx，80 端口：

systemctl stop nginx

报错：

重置密码

Docker 环境

docker exec -it <container name> npm run reset-password

非 Docker 环境

# cd 项目目录# npm run reset-password

https://github.com/louislam/uptime-kuma/wiki/Reset-Password-via-CLI

配置消息通知

Uptime Kuma 提供多种的消息推送，详情请参考：https://github.com/louislam/uptime-kuma/issues/284

我这里需要 Bark 手机 APP、配置邮件、钉钉群通知的演示，还有阿里云短信也是比较方便快捷的提醒。

配置 Bark

Brak 是苹果系统的一款推送软件。ios 手机安装 app，APP 内可以获取推送地址：https://api.day.app/{密钥}/ 这里改成你自己的推送内容

https://api.day.app/{密钥}/ 这里改成你自己的推送内容

后面不能有中文，有测试测试会报错

点击“测试一下”收到消息

模拟测试

恢复测试：

钉钉群通知

了解更多：https://developers.dingtalk.com/document/robots/custom-robot-access

钉钉群获取 WebHookUrl：假设为https://oapi.dingtalk.com/robot/send?access_token=abc123456

WebHookUrl: 填写完整的地址、SecretKey 则填写 abc123456 的值，我开始填写了错了，测试很久没有通过。

配置邮箱

如图配置，主机名、端口号、密码不是 163 的登录密码，需要在 163 邮箱后台开通开启 IMAP/SMTP 服务。获取授权密码。

测试发送邮件：

禁用身份验证

这是可选的，如果不禁用游客访问需要用户名和密码，但是你关掉后，就可以自由访问了。（后台后上角的设置，然后拉到最下面即可看到！）

设置 Status Page

这个功能还是很重要的，可以把新建的监控服务放置到这个监控页面，这样就可以随时随地的看到每个系统的状态了。

点击右上角的 Status Page，开始编辑，具体看图：

首页默认就会是这样的状态页。