首页
/ Watchmen 服务监控项目技术文档

Watchmen 服务监控项目技术文档

2024-12-24 16:12:37作者:伍霜盼Ellen

1. 安装指南

环境要求

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

安装步骤

  1. 克隆项目仓库:

    git clone https://github.com/iloire/watchmen.git
    
  2. 进入项目目录:

    cd watchmen
    
  3. 安装依赖:

    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 服务:

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

4. 项目安装方式

使用 PM2 管理 Node 进程

  1. 安装 PM2:

    npm install -g pm2
    
  2. 配置环境变量:

    export WATCHMEN_WEB_PORT=8080
    
  3. 启动服务器:

    pm2 start run-monitor-server.js
    pm2 start run-web-server.js
    
  4. 查看服务器列表:

    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'
登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
162
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
198
279
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
Git4ResearchGit4Research
Git4Research旨在构建一个开放、包容、协作的研究社区,让更多人能够参与到科学研究中,共同推动知识的进步。
HTML
22
1
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
950
557
risc-v64-naruto-pirisc-v64-naruto-pi
基于QEMU构建的RISC-V64 SOC,支持Linux,baremetal, RTOS等,适合用来学习Linux,后续还会添加大量的controller,实现无需实体开发板,即可学习Linux和RISC-V架构
C
19
5