1. 概述编辑
1.1 版本
运维平台版本 | 功能变更 |
---|---|
V1.5 | - |
1.2 功能简介
FineOPS运维平台是帮助帆软应用稳定运行和全方位运维管理的解决方案。
因此,运维平台支持接入已部署好的FineReport、FineBI等项目。
本文将带用户体验如何将非容器化部署的项目接入运维平台
2. 基础使用前提编辑
2.1 检查应用版本
要求说明:
如需对接运维平台,请确保应用版本在FineReport11.0.6/FineBI5.1.22及以上。
检查方法:
管理员登录FineReport/FineBI应用,点击「管理系统>注册管理>版本信息」,即可查看工程各个模块的小版本号。
解决方案:
请参考 FineReport小版本升级指南、FineBI小版本升级指南 升级工程到最新版本。
2.2 检查网络是否连通
请确保运维平台和需要被管理的应用,所在的服务器互相内网可联通。若网络不互通,则无法对接/影响后续功能使用。
如需精确到指定端口互通,请至少确保运维平台的工程端口和FineReport/FineBI工程端口可以互相访问。
2.3 开启Nginx配置
Nginx状态监控模块ngx_http_stub_status_module是统计Nginx服务所接收和处理的请求数量的模块。
若需要被管理的应用,并非使用FineKey容器化部署的应用,则需要额外安装该模块。
2.3.1 安装模块
检查状态监控模块ngx_http_stub_status_module是否已安装。
nginx -V 2>&1 | grep -o with-http_stub_status_module
出现提示「with-http_stub_status_module」则表示已安装ngx_http_stub_status_module模块。
若未出现以上提示,则说明未安装ngx_http_stub_status_module模块,可执行以下命令安装此模块。
wget http://nginx.org/download/nginx-1.13.12.tar.gztar xfz nginx-1.13.12.tar.gzcd nginx-1.13.12/./configure --with-http_stub_status_modulemakemake install
2.3.2 启用模块
启用ngx_http_stub_status_module模块查询Nginx状态。
location /basic_status { stub_status on; allow 127.0.0.1; #only allow requests from localhost deny all; #deny all other hosts }
注意事项:
1)Location地址请严格命名为basic_status。
2)allow 127.0.0.1和deny all表示仅允许本地访问。
若需允许Nginx Exporter访问,则可将这两行代码注释,或者将127.0.0.1设置为Nginx Exporter的IP地址。
2.3.3 重启Nginx
重启Nginx
nginx -tnginx -s reload
验证ngx_http_stub_status_module模块是否已成功启动
curl http://127.0.0.1/basic_status
出现提示「server accepts handled requests」则表示ngx_http_stub_status_module模块已成功启动。
2.4 准备运维接口密钥
要求说明:
项目管理的前提是,运维平台获得应用的认可。因此首先要从应用中获取一个运维接口密钥。
获取方法:
管理员登录FineReport/FineBI应用,点击「管理系统>智能运维>健康巡检>运维工具」。设置一个运维接口密钥,点击「保存」即可。
运维接口密钥请设置为大小写字母或数字,长度在8~14之间。请记住此次设置的密钥,下文需要用到。
2.5 准备应用地址
应用地址,即为FineReport/FineBI应用的访问地址,形如http://IP:端口号/工程名/decision
3. 安装exporter组件前提(可选)编辑
对接非容器化部署的FineReport/FineBI应用时,可在运维平台所在服务器安装为该工程的外接数据库、负载均衡、状态服务器进行日志采集类型的exporter组件。
可安装的exporter组件包括:mysqld_exporter、redis_exporter、nginx_exporter
如不安装exporter组件,可不准备本节信息,不影响运维平台与工程的对接,但后续运维平台将无法监控组件状态并进行日志采集。
3.1 确认是否支持安装组件
如需安装此类组件,请确保FineReport/FineBI应用是否符合要求,如不符合要求,则无法安装对应的exporter组件。
工程类型 | 建议 |
---|---|
单机-使用内置finedb数据库 | 无需安装任何exporter组件(没有相关被采集信息组件) |
单机-使用外接finedb数据库 | 1)无需安装redis_exporter、nginx_exporter(集群独有) 2)建议使用MySQL类型外接数据库,方可安装mysqld_exporter 3)若外接数据库类型不满足要求,建议更换,详情请参见:配置MySQL5外接数据库 |
集群 | 1)建议安装mysqld_exporter、redis_exporter、nginx_exporter 2)建议使用以下类型的组件,方可安装以上三种组件
3)若组件类型不满足条件,可自行更换应用组件,或迁移为容器化工程,详情请参见: |
3.2 检查网络是否连通
为了exporter组件能正常进行日志采集和服务器信息采集,需要确保网络互通,请确认:
请确认MySQL、Redis、Nginx组件所在服务器和占用端口,可与运维平台内网联通。
请记录Nginx组件需要与运维平台进行通信的服务器地址、端口、SSL信息,后续步骤中可指定。
4. 安装其他组件前提(可选)编辑
对接非容器化部署的FineReport/FineBI应用时,可在应用所在服务器安装为该工程进行服务器信息采集的组件。
可安装的组件包括:node_exporter和promtail组件。
如不安装组件,可不准备本节信息,不影响运维平台与工程的对接,但后续运维平台将无法监控并采集服务器信息。
4.1 组件作用
组件 | 组件作用 |
---|---|
node_exporter | 服务器物理节点的exporter 收集物理服务器的各种指标信息,每个物理节点安装一个node_exporter |
promtail | 与FR/BI绑定,一个FR/BI工程对应一个promtail组件,收集日志信息 |
4.2 准备应用节点信息
为了有权限安装组件,需要准备:
FineReport/FineBI应用所在服务器的主机IP、端口、root用户密码
集群需要准备好所有节点所在服务器的主机IP、端口、root用户密码
若使用私钥,请将私钥文件上传到运维平台挂载目录的/root/data/fanruanxxxxx/ops/resources/certificates文件夹中
4.3 检查端口状态
为了确保组件可以正常启动并与运维平台通信,请确保node_exporter默认占用端口9100,请确保9100-9104中至少有一个端口可用,安装时会从9100开始尝试五次,五次均失败便不安装该组件
promtail默认占用端口9080,请确保9080-9084中至少有一个端口可用,安装时会从9080开始尝试五次,五次均失败便不安装该组件
请确保node_exporter和promtail组件占用端口,可与运维平台所在服务器内网联通。
4.4 准备日志存放目录
为了有地方存放exporter日志,需要准备:
在FineReport/FineBI应用所在服务器,新建一个目录,该目录用于存放exporter日志
集群需要在所有节点所在服务器都准备好一个目录
该目录需要有读写权限
5. 接入已有项目编辑
5.1 新增项目
管理员登录运维平台,点击「运维管理>项目管理」,点击「新增项目>接入已有项目」按钮,如下图所示:
5.2 项目信息设置
设置相关项目信息,点击「测试连接并保存」,如下图所示:
需要设置的应用信息如下表所示:
信息 | 说明 |
---|---|
项目名称 | 自定义项目的名称 项目名称不允许为空 项目名称仅支持小写字母、数字 项目名称长度最大为12位 |
项目服务器地址 | FineReport、FineBI等项目的地址(2.5节准备的信息) 项目服务器地址形如http://IP:port/webroot/decision 项目服务器地址不允许为空 |
运维接口密钥 | 运维接口密钥(2.4节准备的信息) 运维接口密钥不允许为空 |
点击「测试连接并保存」,连接成功后提示「连接成功」,点击确定,进入下一步。
5.3 组件信息设置
如不安装第三章所述的exporter组件,可直接点击「测试连接并保存」进入下一步,后续运维平台也将无法监控组件状态并进行日志采集。
可安装的exporter组件包括:mysqld_exporter、redis_exporter、nginx_exporter
如需安装exporter组件,请确保已执行并准备好第三章相关exporter组件信息。
在「组件信息设置」步骤,会自动设置相关被监控组件信息,如下图所示:
此处信息如下表所示:
组件 | 信息 | 说明 |
---|---|---|
外接数据库组件 禁止修改 | MySql组件名称 | 默认名称为:项目名称_mysql |
组件地址 | IP地址 | |
组件端口 | 端口号 | |
Redis组件 禁止修改 | 组件名称 | 默认名称为:项目名称_redis |
组件地址 | IP地址 | |
组件端口 | 端口号 | |
Nginx组件 | 组件名称 | 默认名称为:项目名称_nginx 禁止修改 |
组件地址 | IP地址 支持修改,即为组件的地址 | |
组件端口 | 端口号 支持修改,即为组件的端口(3.2节) | |
SSL | 支持自行勾选配置 |
点击「测试连接并保存」,连接成功后提示「已保存,连接成功」,点击确定,进入下一步。
5.4 服务器信息设置
如不安装第四章所述的exporter组件,可直接点击「测试连接并保存」进入下一步,后续运维平台也将无法监控服务器状态并进行日志采集。
可安装的组件包括:node_exporter和promtail组件。
如需安装组件,请确保已执行并准备好第四章相关信息。
请将4.2节和4.4节准备的FineReport/FineBI应用所有节点所在服务器的相关信息填入。
配置完成后,点击「测试连接并保存」,连接成功后提示「保存成功」,点击确定,项目新增完毕。
6. 效果预览编辑
在项目管理列表中出现新接入的项目,即代表接入成功,如下图所示: