open

README

### 项目简介
集监控点监控、日志监控、数据可视化及监控告警为一体的分布式开源监控系统。    
通过插件方式支持常用监控需求，插件可自由选择且支持一键部署、移除、启用、禁用等操作。  
提供丰富的图表和多种数据类型，满足对数据可视化的需要。   

在windows下访问演示版地址：[http://open.xrkmonitor.com](http://open.xrkmonitor.com)   
(注意访问演示版要通过代理客户端访问，下载并解压源码目录下的：AccessDaemon.rar，该客户端会修改相关的域名的dns到本地回环地址，运行时需要管理员权限)

**相比其它开源监控系统优势**  
1.  支持插件功能, 监控插件无需开发，自由选择监控插件，控制台安装即可使用   
1.	集成告警功能, 支持多种告警方式    
1.	集成分布式日志系统功能, 无需任何开发即可打造高性能分布式日志系统    
1.  支持多种部署方式    
	a.集中部署（全部服务部署在一台机器，适合个人或者小团队开发者）  
	b.分布式部署（分布式部署在多台机器，适合小中型企业大规模监控需求）   
1.	支持自动化配置（机器部署agent后自动注册到监控系统无需在控制台配置、视图根据上报自动绑定相关上报机器）  
1.  支持多用户访问（子账号由管理员账号在控制台添加）   
1.  同时面向开发者和运维产品人员，开发者可以使用API开发接口很方便的定制自己的监控需求，运维和产品人员可以直接部署使用现有插件完成监控需求   


### 特色功能推荐
1. IP地址库: 支持通过IP地址上报时将IP地址转为物理地址，相同物理地址归并展示，一个监控API 即可轻松生成监控数据的物理地址分布图，插件示例：[monitor_apache_log](https://gitee.com/xrkmonitorcom/monitor_apache_log)     
   ![](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/80ea122d1e7553a9a17fe3c6.png)    
   <br >

1. 监控插件市场: 让监控成为可以复用的组件，无需开发一键安装即可使用，更多监控插件持续开发中    
   ![](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/36f886d4cdec9ce5216018e0.png)    
   <br >

1. 分布式日志系统: 支持大规模系统日志上报，日志上报支持频率限制、日志染色、自定义字段等高级功能，控制台日志查看支持按关键字、排除关键字、上报时间、上报机器等方式过滤日志，从茫茫日志中轻松找到您需要的日志         
   ![](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/e7b2ffb33eb9476cc9d7d389.gif)
   <br >

1. 视图机制: 监控图表支持视图定制模式，视图可按上报服务器、监控点随意组合，轻松定制您需要的监控视图，并可在监控图表上直接设置告警值    
   ![](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/fe577585ebed8e285cc59fb5.png)
   <br >

1. 告警集成: 集成告警功能, 支持邮件、短信、微信、PC客户端等告警方式，告警功能无需开发直接可用   
   ![](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/8e3b9877928d924c5f43d9a1.png)
   <br >

1. 内网部署: 监控系统可以部署在内网隔离环境，插件仍可以从云端下载部署，agent 支持 udp 代理功能，可通过 agent 的代理使用云端提供的服务，如监控告警服务。   
   <br >

1. 插件实时表格，主要用于实时展示监控指标在分布式机群不同机器间的对比排序   
   ![](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/13a653507ce32064412c1cda.png)
   <br >


### docker 方式部署

以下假设宿主机的IP 地址为：192.168.128.210, 以最新版本 latest作为示例说明 docker 部署方法     
1. 拉取 docker 镜像: docker pull registry.cn-hangzhou.aliyuncs.com/xrkmonitor/release:latest
1. 通过镜像启动容器：docker images 查看镜像ID，假设为：93297f01d06b    
   启动容器：   
   docker run -idt -p27000:27000/udp -p38080:38080/udp -p28080:28080/udp -p80:80 --env xrk_http_port=80 -v /data/xrkmonitor/docker_mysql:/var/lib/mysql -v /data/xrkmonitor/docker_slog:/home/mtreport/slog --env xrk_host_ip=192.168.128.210 93297f01d06b    
   参数说明：    
   	-p27000:27000/udp -p38080:38080/udp -p28080:28080/udp -p80:80 日志、监控点、接入服务等的端口映射    
	--env xrk_http_port=80 web 控制台的映射端口（可以使用非80端口映射容器80端口，相关问题可以查看在线文档的 docker 部署部分）    
    -v /data/xrkmonitor/docker_mysql:/var/lib/mysql, 挂载宿主机目录作为mysql数据库文件目录       
    -v /data/xrkmonitor/docker_slog:/home/mtreport/slog，挂载日志目录     
    --env xrk_host_ip=192.168.128.210 宿主机的ip地址, 根据实际情况传递      
1. docker attach 进入容器，进入目录 /home/mtreport, 执行 ./start_docker.sh 启动监控系统服务    
1. 在浏览器端使用宿主机IP访问控制台： http://192.168.128.210，控制台默认账号密码为：sadmin/sadmin     
1. 如需停止服务可执行 : /home/mtreport/stop_docker.sh 脚本     

可以使用 ps -elf |grep slog 命令查看运行的进程，使用 ps -elf |grep xrk_ 查看运行的内置插件    

特别注意：由于当前暂不支持增量更新，如之前使用过 docker 方式部署，升级版本时注意更换宿主机的 mysql 映射目录或者清除映射目录下旧版本的 mysql 文件，否则 db 仍会使用旧版本db 库，这在新版本更改了mysql库表结构的情况下服务运行会出错。     

**agent 部署说明：**    
容器中 /home/mtreport/slog_mtreport_client.tar.gz 为 agent 部署包，可以将其拷贝到需要部署的机器上，解压后部署SERVER_MASTER 配置改为宿主机的IP地址， 如果需要在宿主机上部署 agent，需要指定：AGENT_CLIENT_IP 为容器网卡的IP，关于 agent 的详细说明可以参考开源版在线文档, 不建议在容器中部署插件(在宿主机需要部署时会发生冲突).  

docker 使用过程中如有问题可以加入我们的QQ群： 859052272 获取帮助。   

### 使用 docker 镜像编译源码
使用 docker 镜像编译源码方法如下：   
1. 拉取镜像： docker pull registry.cn-hangzhou.aliyuncs.com/xrkmonitor/compile:latest    
1. 执行镜像容器：docker run -idt [镜像id] (docker images 获取)    
1. 进入容器：docker attach [容器id] (docker ps -a 获取)    
1. 进入容器目录：/home/xrkmonitor/open, 执行 make 即可编译项目全部源码,如果编译出错，可尝试执行 ./install_dev.sh重新初始化下编译环境   
1. 编译成功后生成集中部署包，进入 tools_sh 目录，执行：./make_all.sh 即可生成完整的集中部署包    

关于集中部署请参考文档：[源码编译-集中部署](http://xrkmonitor.com/monitor/showdoc/showdoc/web/#/4?page_id=38)   

docker 编译镜像安装了 vim/gcc/git 等工具，如需更新源码，进入目录:/home/xrkmonitor/open 执行 git pull 即可    
如您想使用镜像进行二次开发，建议您挂载宿主机目录，将源码下载到挂载的目录进行修改， 不要使用容器中的/home/xrkmonitor/open 目录，以免工作成果丢失。   

### 离线部署(自行编译源码)

如果在线安装失败或者需要二次开发, 可以使用源码编译方式安装     

操作步骤：
1. git clone https://gitee.com/xrkmonitorcom/open.git 下载源码    
2. 进入源码目录，执行 make 完成源码编译   
3. 进入 tools_sh 目录，执行 make_all.sh 生成部署包:slog_all.tar.gz   
4. 将部署包拷贝到安装目录(建议目录：/home/mtreport) 在安装目录解压部署包，执行 local_install.sh 完成安装   
  
(如遇编译环境问题，可以尝试使用docker 镜像编译)   
监控系统卸载执行脚本: ./uninstall_xrkmonitor.sh

安装环境变量同在线安装一样, 具体可以查看说明文档: [源码编译-集中部署](http://xrkmonitor.com/monitor/showdoc/showdoc/web/#/4?page_id=38)    
控制台默认账号密码: sadmin/sadmin    

另外 opensuse 系统可以直接使用源码中的离线部署包: slog_all.tar.gz


### 使用的技术方案
1. apache + mysql(监控点数据、配置信息使用 mysql 存储, 支持分布式部署)   
2. 前端 web 控制台采用 [dwz 开源框架](http://jui.org/)   
3. 前端监控图表采用开源 [echarts](https://www.echartsjs.com/zh/index.html) 绘制
4. 后台 cgi 使用开源的cgi模板引擎 - [clearsilver](http://www.clearsilver.net/), 所有cgi支持以fastcgi方式部署    
5. 后台服务使用了开源的 socket 开发框架 - [C++ Sockets](http://www.alhem.net/Sockets/)   

### 当前监控上报API支持的语言如下(更多语言支持在开发中)
1. [c/c++ 开发接口](http://xrkmonitor.com//monitor/showdoc/showdoc/web/#/4?page_id=45) 
2. [php 开发接口](http://xrkmonitor.com//monitor/showdoc/showdoc/web/#/4?page_id=51)
3. [linux shell 开发接口](http://xrkmonitor.com//monitor/showdoc/showdoc/web/#/4?page_id=72)
4. [javascript 开发接口](http://xrkmonitor.com//monitor/showdoc/showdoc/web/#/4?page_id=76)
	   
### 插件市场 (部分插件，请登录演示版查看更多)
1. [linux_base](https://gitee.com/xrkmonitorcom/plugin_linux_base) - c/c++语言开发，用于监控linux 系统 cpu/内存/磁盘/网络等资源    
2. [monitor_apache_log](https://gitee.com/xrkmonitorcom/monitor_apache_log) - c/c++语言开发，用于监控apache 网站的流量访问量等   
3. [linux_file_monitor](https://gitee.com/xrkmonitorcom/linux_file_monitor) - shell 语言开发，用于监控 linux系统文件目录的增删改变动      
4. [monitor_website](https://gitee.com/xrkmonitorcom/monitor_website) - javascript 语言开发，用于监控网站访客基本信息和运行异常信息      
5. [open_source_star](http://xrkmonitor.com/a/plugin_open_source_sta