1. 概述编辑
1.1 版本
运维平台版本 | 功能变更 |
---|---|
V1.5.5 | - |
V1.5.6 | 1)组件信息设置时,允许修改组件地址和端口 2)服务器信息设置时,不再安装冗余组件promtail 3)帆软应用只允许被一个运维平台接入 若已被接入,应用的运维密钥处显示「已接入」 |
V1.9.0 | 接入项目交互界面优化 |
V1.10.0 | 项目名称限制放宽,新增支持英文大写、中文 |
1.2 功能简介
FineOps运维平台是帮助帆软应用稳定运行和全方位运维管理的解决方案。
因此,运维平台支持接入已部署好的FineReport、FineBI等项目。
本文将带用户体验如何将非容器化部署的项目接入运维平台。
1.3 步骤简介
步骤 | 说明 | ||
---|---|---|---|
1 | 检查是否支持接入 | 1)运维平台仅支持接入FineReport11.0.6/FineBI5.1.22及以上版本工程 2)运维平台和需要被管理的FR/BI应用,所在的服务器必须互相内网可联通 | |
2 | 接入已有项目 | 登录运维平台,在「项目管理」界面选择「接入已有项目」 | |
3 | 项目信息设置 | 是否必要 | 必要步骤 帮助运维平台与FR/BI应用连接 |
前提准备 | 1)获取FR/BI应用的访问地址 2)获取FR/BI应用的运维接口密钥 | ||
操作步骤 | 自定义项目名称,填入上一步准备的信息 | ||
4 | 组件信息设置 | 是否必要 | 非必要步骤 在运维平台所在服务器安装exporter组件,为该工程的外接数据库、负载均衡、状态服务器进行日志采集 可安装的exporter组件包括:mysqld_exporter、redis_exporter、nginx_exporter 如不安装,可直接点击「跳过」进入下一步,不影响运维平台与工程的对接,但后续运维平台将无法监控这些组件的状态并进行日志采集 |
前提准备 | 1)确认FR/BI应用中是否有符合要求的外接数据库、负载均衡、状态服务器组件 如果没有这些组件,就完全可以跳过这个步骤 2)确认MySQL、Redis、Nginx组件的端口可与运维平台内网联通 3)准备Nginx组件的服务器地址、端口、SSL信息 4)为FR/BI应用安装Nginx状态监控模块 | ||
操作步骤 | 1)自动设置MySQL和Redis组件信息 2)手动填写Nginx组件信息 | ||
5 | 服务器信息设置 | 是否必要 | 非必要步骤 在FR/BI应用所在服务器安装node_exporter组件,为该工程进行服务器信息采集 可以为应用的每一个节点、每一个组件所在服务器都安装一份node_exporter组件 如不安装上述组件,可直接点击「跳过」进入下一步,不影响运维平台与工程的对接,但后续运维平台将无法监控服务器状态并进行日志采集 |
前提准备 | 1)准备所有需要安装组件的节点服务器的主机IP、端口、root用户密码 2)在所有需要安装组件的节点服务器,都准备好一个目录,用于存放exporter日志 2)准备node_exporter需要占用的端口可用性 3)确保node_exporter端口可与运维平台内网联通 | ||
操作步骤 | 将上一步准备的所有服务器的相关信息填入 | ||
6 | 接入成功 | 检测以上步骤是否有问题,没问题的情况下会成功接入 在「项目管理」界面会出现新接入的FR/BI项目 |
2. 基础使用前提编辑
2.1 检查应用部署方式和版本
要求说明:
如需对接运维平台:
请确保应用部署在Linux/Windows系统的Tomcat中间件中。(其他环境部署的工程,尽管可以接入,但无法正常使用运维平台功能进行监控)
请确保应用版本在FineReport11.0.6/FineBI5.1.22/FineDataLink4.0.26及以上。
版本检查方法:
管理员登录FineReport/FineBI/FineDataLink应用,点击「管理系统>注册管理>版本信息」,即可查看工程各个模块的小版本号。
解决方案:
请参考 FineReport小版本升级指南、FineBI小版本升级指南、FineDataLink一键升级,升级工程到最新版本。
2.2 检查网络是否连通
请确保运维平台和需要被管理的应用,所在的服务器互相内网可联通。若网络不互通,则无法对接/影响后续功能使用。
如需精确到指定端口互通,请至少确保运维平台的工程端口和FineReport/FineBI/FineDataLink工程端口可以互相访问。
2.3 检查系统运维插件
请确保FineReport/FineBI/FineDataLink应用安装了「系统运维」插件。建议将插件升级到最新版本。
注:如果应用配置了CAS单点登录,安装「系统运维」插件后,需要重启应用,方可正常与FineOps运维平台对接。
2.4 准备运维接口密钥
要求说明:
项目管理的前提是,运维平台获得应用的认可。因此首先要从应用中获取一个运维接口密钥。
获取方法:
管理员登录FineReport/FineBI/FineDataLink应用,点击「管理系统>智能运维>健康巡检>运维工具」。设置一个运维接口密钥,点击「保存」即可。
运维接口密钥请设置为大小写字母或数字,长度在8~14之间。请记住此次设置的密钥,下文需要用到。
注:帆软应用只允许被一个运维平台接入。若已被接入,应用的运维密钥处显示「已接入」。
2.5 准备应用地址
应用地址,即为FineReport/FineBI/FineDataLink应用的访问地址,形如http://IP:端口号/工程名/decision
注:请勿准备短域名地址作为应用地址,可能会造成接入失败。
3. 项目设置编辑
1)管理员登录运维平台,点击「运维管理>项目管理」,点击「接入已有项目」按钮。
2)设置相关项目信息,需要设置的应用信息如下表所示:
信息 | 说明 |
---|---|
项目名称 | 自定义项目的名称 项目名称不允许为空 项目名称仅支持中文、英文大小写、数字 项目名称长度最大为12位 |
项目服务器地址 | FineReport、FineBI等项目的地址(2.5节准备的信息) 项目服务器地址形如http://IP:port/webroot/decision 项目服务器地址不允许为空 请勿准备短域名地址作为应用地址,可能会造成接入失败 |
运维接口密钥 | 运维接口密钥(2.4节准备的信息) 运维接口密钥不允许为空 |
3)点击「测试连接并保存」,提示「接入项目成功」,进入「组件设置」环节。
4. 组件设置(可选)编辑
对接非容器化部署的FineReport/FineBI/FineDataLink应用时,可在运维平台所在服务器安装为该工程的外接数据库、负载均衡、状态服务器进行日志采集类型的exporter组件。
可安装的exporter组件包括:mysqld_exporter、redis_exporter、nginx_exporter
如不安装上述exporter组件,可直接点击「跳过」进入下一步,不影响运维平台与工程的对接,但后续运维平台也将无法监控组件状态并进行日志采集。
成功接入工程后,若又希望安装exporter组件,在项目管理界面点击对应项目的「编辑」按钮,重新设置即可。
4.1 安装前提
4.1.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)若组件类型不满足条件,可自行更换应用组件。 |
4.1.2 检查端口状态
为了exporter组件能正常进行日志采集和服务器信息采集,需要确保网络互通,请确认:
MySQL、Redis组件所在服务器和占用端口会自动读取,但用户需要自行提供Nginx组件的服务器地址、端口、SSL信息
请确认MySQL、Redis、Nginx组件所在服务器和占用端口,可与运维平台内网联通。
4.1.3 开启Nginx配置
Nginx状态监控模块ngx_http_stub_status_module是统计Nginx服务所接收和处理的请求数量的模块。
若需要被管理的应用,并非使用FineKey容器化部署的应用,且需要安装nginx_exporter,则需要额外安装该模块。
1)检查是否安装模块
进入Nginx的安装目录(本示例/usr/nginx是一个示例目录,请根据实际情况,确保使用正确的目录名)
cd /usr/nginx
检查Nginx启用了哪些模块
./nginx -V
结果
如果已启用,将在命令输出中看到http_stub_status_module的相关信息「with-http_stub_status_module」。
如果没有启用http_stub_status_module模块,则需要重新编译nginx。
2)安装模块
进入Nginx的安装目录(本示例/usr/nginx是一个示例目录,请根据实际情况,确保使用正确的目录名)
cd /usr/nginx
在configure命令中,添加http_stub_status_module的支持
./configure --with-http_stub_status_module
注:请将上一步中「nginx -V」发现的已安装的模块都一一带上,例如./configure --with-http_stub_status_module --prefix=/usr/nginx --with-pcre=/usr/nginx/pcre-8.42 --with-zlib=/usr/nginx/zlib-1.2.11 --with-http_ssl_module --with-openssl=/usr/nginx/openssl-1.1.1a --with-stream --add-module=/usr/nginx/ngx_healthcheck_module-master
编译和安装Nginx
make && make install
3)启用模块
打开nginx.conf文件并修改
在默认情况下,nginx.conf 文件通常位于 Nginx 的安装目录下的 conf 目录中。
cd /usr/nginx/conf
在nginx.conf文件中,找到server {}块,并添加以下配置,以启用ngx_http_stub_status_module模块查询Nginx状态。
location /basic_status {
stub_status on;
#allow 127.0.0.1; #限制访问ip,可自行修改127.0.0.1为所需开放的ip
#deny all; #deny all other hosts
}
注意事项:
Location地址请严格命名为basic_status。
allow 127.0.0.1和deny all表示仅允许本地访问。
若需允许Nginx Exporter访问,则可将这两行代码注释,或者将127.0.0.1设置为Nginx Exporter的IP地址。
4)重启Nginx
进入Nginx的安装目录(本示例/usr/nginx是一个示例目录,请根据实际情况,确保使用正确的目录名)
cd /usr/nginx
检查Nginx配置文件的语法和结构是否正确
./nginx -t
关闭Nginx服务器
./nginx -s stop
重新加载 Nginx 的配置文件并启动服务器
nginx
5)验证模块是否启用
验证ngx_http_stub_status_module模块是否已成功启动
使用语句查询,若出现提示「server accepts handled requests」则表示ngx_http_stub_status_module模块已成功启动。
curl http://127.0.0.1/basic_status
4.2 操作步骤
如需安装exporter组件,请确保已执行并准备好4.1节相关exporter组件信息。
在「组件设置」步骤,会自动设置MySQL和Redis组件信息,需手动填写Nginx组件信息(4.1.2节)。
注:为了方便内网用户对接,V1.5.6 及之后版本,MySQL和Redis组件的地址和端口,也允许被修改。
点击「测试连接并保存」,连接成功后提示「已保存,连接成功」,进入下一步。
5. 服务器信息设置(可选)编辑
对接非容器化部署的FineReport/FineBI应用时,可在应用组件所在服务器安装为该工程进行服务器信息采集的组件。
可安装的组件包括:node_exporter组件,服务器物理节点的exporter,收集物理服务器的各种指标信息,每个物理节点安装一个node_exporter
如不安装上述组件,可直接点击「跳过并保存」进入下一步,不影响运维平台与工程的对接,但后续运维平台也将无法监控服务器状态并进行日志采集。
成功接入工程后,若又希望安装node_exporter组件,在项目管理界面点击对应项目的「编辑」按钮,重新设置即可。
5.1 安装前提
5.1.1 准备应用节点信息
为了有权限安装组件,需要准备:
FineReport/FineBI应用所在服务器的主机IP、端口、具有root权限的用户密码
集群需要准备好所有节点所在服务器的主机IP、端口、具有root权限的用户密码
若使用私钥,请在本地准备好私钥文件,并确保用户有权限上传密钥文件到运维平台挂载目录的/root/data/fanruanxxxxx/ops/resources/certificates文件夹中
注1:挂载目录寻找方式
1)先使用「docker ps -a」命令,找到 NAMES 中包含 ops 的 CONTAINER ID(容器ID)。
2)再使用「docker inspect 容器ID」命令,在返回的 HostConfig 中,即可得到上面所指挂载目录的位置。
注2:V1.11.0及之后版本,支持使用非root用户进行安装,V1.10.0及之前版本,仅支持使用root用户进行安装。
请确保准备的用户具有root权限,有些指标数据需要访问系统资源或敏感信息,这些操作通常需要特权(root)访问权限。
例如,获取网络接口统计信息、文件系统使用情况等。这些指标数据只有在使用root权限运行node_exporter时才能够收集和暴露。
5.1.2 检查端口状态
为了确保组件可以正常启动并与运维平台通信,请确保:
node_exporter默认占用端口9100,请确保9100-9104中至少有一个端口可用,安装时会从9100开始尝试五次,五次均失败便不安装该组件。
请确保node_exporter组件占用端口,可与运维平台所在服务器内网联通。
5.1.3 准备日志存放目录
为了有地方存放exporter日志,需要准备:
在FineReport/FineBI应用所在服务器,新建一个目录,该目录用于存放exporter日志。
集群需要在所有节点所在服务器都准备好一个目录。
准备的用户具有该目录的读写权限。
5.2 操作步骤
如需安装组件,请确保已执行并准备好5.1节相关信息。
请将5.1.1节准备的FRBI应用服务器信息和5.1.3节准备的安装路径(即日志存放目录)填入。
注1:若工程有多个节点,请点击「新增服务器」新增节点进行配置。
注2:此处填写的安装路径,必须为绝对路径。
6. 效果预览编辑
配置完成后,点击「测试连接并保存」,连接成功后提示「已保存,连接成功」。
在项目管理列表中出现新接入的项目,即代表接入成功,如下图所示: