Watchmen 服务监控项目技术文档

2024-12-24 17:10:33作者：伍霜盼Ellen

1. 安装指南

环境要求

在安装 Watchmen 之前，请确保你已经安装了 Redis。你可以从 Redis 官网下载并安装 Redis。

安装步骤

克隆项目仓库：

git clone https://github.com/iloire/watchmen.git

进入项目目录：
```
cd watchmen
```
安装依赖：
```
npm install
```

2. 项目的使用说明

启动与停止 Watchmen

确保 redis-server 在你的 PATH 中，然后你可以启动 Watchmen 服务：

redis-server redis.conf
node run-monitor-server.js
node run-web-server.js

开发工作流

获取 Bower 依赖并构建静态资源

npm run build

开发构建监视

npm run build:watch

运行测试

请参考项目的测试部分。

3. 项目API使用文档

内置 Ping 服务

HTTP-HEAD

用于发送 HTTP HEAD 请求来检查服务状态。

HTTP-CONTAINS

用于检查 HTTP 响应中是否包含特定内容。

第三方贡献的 Ping 服务

NightmareJS 插件

允许通过 Nightmare 脚本执行的 Watchmen 实例。

创建自定义 Ping 服务

Ping 服务是带有 'watchmen-ping' 前缀的 npm 模块。例如，如果你想创建一个 SMTP Ping 服务：

创建一个 watchmen-ping-smtp 模块并发布它。
在 Watchmen 中安装该模块：
```
npm install watchmen-ping-smtp
```
创建一个使用该 Ping 服务的服务。

4. 项目安装方式

使用 PM2 管理 Node 进程

安装 PM2：
```
npm install -g pm2
```
配置环境变量：
```
export WATCHMEN_WEB_PORT=8080
```

启动服务器：

pm2 start run-monitor-server.js
pm2 start run-web-server.js

查看服务器列表：
```
pm2 list
```

使用 node-foreman 管理进程

node-foreman 可以用于将监控和 Web 服务器作为 Upstart 服务运行。Watchmen 已经包含一个 Procfile，因此你可以使用 nf 来管理。

npm install -g foreman
nf start

要将服务导出为 Upstart 脚本，请使用以下命令：

PATH="/home/user/.nvm/versions/v5.1.0/bin:$PATH" nf export -o /etc/init -a watchmen

配置

配置通过环境变量设置。请查看 /config 文件夹以获取更多详细信息。

export WATCHMEN_BASE_URL='http://watchmen.letsnode.com'
export WATCHMEN_WEB_PORT='8080'
export WATCHMEN_ADMINS='admin@domain.com'
export WATCHMEN_GOOGLE_ANALYTICS_ID='your-GA-ID'

禁用身份验证

如果你想禁用身份验证并允许任何人访问和编辑服务，请使用以下命令：

export WATCHMEN_WEB_NO_AUTH='true'

watchmen

A simple node.js service monitor

项目地址：https://gitcode.com/gh_mirrors/wa/watchmen

登录后查看全文