1. 概述编辑
本文将带领大家了解,运维平台部署完成后,用户需要进行的操作。
2. 如何接入一个已有项目编辑
面向对象:先部署好了FR/BI应用,后部署了运维平台。为了让运维平台管理FR/BI应用,需要让运维平台接入部署好的应用。
由于容器化部署和非容器化部署的项目,在接入时的步骤不完全相同,因此第一步需要判断工程的部署方式,然后再选择不同的接入方案。
2.1 容器化部署
详情请参见:接入已有容器化项目
步骤 | 说明 | |
---|---|---|
1 | 检查是否支持接入 | 1)运维平台仅支持接入FineReport11.0.6/FineBI5.1.22及以上版本工程 2)运维平台和需要被管理的FR/BI应用,所在的服务器必须互相内网可联通 |
2 | 准备材料 | 1)获取FR/BI应用的访问地址 2)获取FR/BI应用的运维接口密钥 |
3 | 接入已有项目 | 登录运维平台,在「项目管理」界面选择「接入已有项目」 |
4 | 项目信息设置 | 自定义项目名称,填入第二步准备的信息 |
5 | 组件信息设置 | 自动获取FR/BI应用的exporter组件信息,确保从应用获取组件日志到运维平台进行分析 只需要确保第一步的网络连通,这一步不会出现任何问题,无需做任何更改 |
6 | 服务器信息设置 | 非容器化部署专用的步骤,容器化部署无需设置,直接进入下一步 |
7 | 接入成功 | 检测以上步骤是否有问题,没问题的情况下会成功接入 在「项目管理」界面会出现新接入的FR/BI项目 |
2.2 非容器化部署
详情请参见:接入已有非容器化项目
步骤 | 说明 | ||
---|---|---|---|
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和promtail组件,为该工程进行服务器信息采集 可以为应用的每一个节点、每一个组件所在服务器都安装一份node_exporter和promtail组件 如不安装上述组件,可直接点击「跳过」进入下一步,不影响运维平台与工程的对接,但后续运维平台将无法监控服务器状态并进行日志采集 |
前提准备 | 1)准备所有需要安装组件的节点服务器的主机IP、端口、root用户密码 2)在所有需要安装组件的节点服务器,都准备好一个目录,用于存放exporter日志 2)准备node_exporter和promtail需要占用的端口可用性 3)确保node_exporter和promtail端口可与运维平台内网联通 | ||
操作步骤 | 将上一步准备的所有服务器的相关信息填入 | ||
6 | 接入成功 | 检测以上步骤是否有问题,没问题的情况下会成功接入 在「项目管理」界面会出现新接入的FR/BI项目 |
3. 如何部署一个新项目编辑
面向对象:先部署好了运维平台,此时可以让运维平台帮助管理员部署并自动接入FR/BI应用。
参考文档:部署新项目
操作步骤:
步骤 | 说明 | |
---|---|---|
1 | 判断工程规模 | 由于单机和集群的FR/BI应用,对于服务器环境要求不完全相同 因此第一步需要先判断需要部署的工程规模(单机还是集群,几个节点) |
2 | 准备材料 | 1)配置镜像仓库:部署新项目,需要运维平台从仓库里获取镜像包安装各个组件,因此必须先确保运维平台与镜像仓库连接 2)确保网络联通:待部署FR/BI应用和组件所在的服务器,必须与运维平台所在服务器网络联通 3)确认服务器环境:一个FR/BI应用,包含了很多应用和组件,他们会占用很多内存,有最低CPU限制,因此必须确保服务器环境符合要求 4)确保端口可用:待部署FR/BI应用和组件如需正常运行,肯定需要有可用端口,必须确保默认端口可用/有可用端口替换 |
3 | 部署新项目 | 登录运维平台,在「项目管理」界面选择「部署新项目」 |
4 | 项目设置 | 1)自定义项目名称 2)选择需要部署的项目基础配置 3)根据第一步准备的材料,配置好每个组件的占用端口 |
5 | 节点配置 | 每一个待部署的FR/BI应用和组件,都需要设置这个组件的节点信息 |
6 | 部署成功 | 1)界面化展示部署的进度和结果 2)部署成功后,在「项目管理」界面会自动接入该FR/BI项目 3)FR/BI项目自动启动,用户可通过地址访问 |
4. 首次使用运维平台管理项目时需要做什么?编辑
本节分为两类操作:
一类是管理员首次需要配置好的、让运维平台定期自动执行的操作。
一类是管理员需要手动定期为项目进行检查的一些内容。
4.1 配置自动化规则
建议操作 | 说明 |
---|---|
设置自动备份 | 应用场景: 定期自动对项目进行整体异机备份,防止工程服务器出现意外,工程文件出现损毁后有办法快速恢复 功能简介: 在「运维管理>备份管理」中选择运维项目,开启自动备份,设置备份频率 参考文档:备份管理 |
设置告警对象 | 应用场景: 运维平台监控到项目出现异常时,可以通过email、webhook、企业微信通知管理员 因此管理员需要先设置好告警对象,方便运维平台知道给谁发消息 功能简介: 在「监控与告警>告警管理>告警方式」中设置告警对象,支持「email、webhook、企业微信」三种方式 参考文档:告警方式 |
设置自动健康巡检 | 应用场景: 健康巡检,可以理解为定期为系统做体检,确保及时发现系统的问题并进行调整。 因此管理员需要设定好体检的周期,让运维平台自动定期对系统进行监控巡检。 功能简介: 在「业务工具>监控巡检」中开启系统自动检查,设置执行周期 参考文档:健康诊断 |
设置宕机处理策略 | 应用场景: 系统宕机之后: 需要第一时间进行重启,需要第一时间恢复进程,以免影响业务用户使用 需要导出宕机日志,帮助管理员事后查看和分析宕机原因和优化方案 功能简介: 在「业务工具>宕机自动处理>宕机处理策略」中选择运维项目,开启宕机自动处理,设置宕机相关配置项 参考文档:宕机处理策略 |
4.2 定期手动检查
建议操作 | 说明 |
---|---|
检查组件状态与更新 | 应用场景: 为满足客户的新需求以及完善之前版本某些功能的不足之处,FineReport/FineBI在不断地更新迭代,管理员需要定期检查项目组件是否正常运行、是否需要更新 功能简介: 该功能仅面向容器化部署的项目 在「运维管理>项目管理>组件管理」中可以检查 |
检查集群节点状态 | 应用场景: 集群工程中,需要关注各个节点的状态,确保节点正常运行 功能简介: 该功能仅面向集群工程 在「运维管理>集群节点管理」中选择运维项目,可以查看哪些节点状态异常 |
检查各类监控仪表板 | 应用场景: 对于服务器、工程和工程中的组件,运维平台提供对应监控看板,监控各个指标情况 当指标出现异常时,会标黄/标红显示 功能简介: 在「监控与告警」中,可以查看各个监控看板,查看异常指标项 |
检查健康巡检异常项 | 应用场景: 运维平台会定期对FR/BI工程进行体检,管理员要根据体检报告改善工程配置 功能简介: 在「业务工具>健康巡检」中,查看是否存在异常项目,根据修改建议优化工程 |
5. 项目出现异常时,运维平台可以做什么?编辑
问题 | 解决方案 |
---|---|
应用监控与告警 | 当系统运行出现异常时,会触发系统的告警规则 当触发告警后,会通过告警方式通知管理员 管理员根据告警内容,优化问题,提前解决问题 |
宕机恢复与分析 | 当系统宕机之后 1)运维平台可根据宕机处理策略,自动重启工程,恢复进程 2)运维平台提供此次宕机的原因和处理方案,可根据方案优化 3)宕机后自动导出堆栈日志,运维平台可对日志进行分析,可根据分析报告优化 |
日志分析 | 出现任何问题,需要分析工程日志时,可通过运维平台快速下载日志到本地进行分析 |
配置更新与启停 | 如果检测到是FR/BI工程或组件的配置不合理,需要进行调整时: 1)对于FR/BI项目组件,可通过组件管理功能对Nginx/Redis/配置库进行配置修改 2)对于FR/BI工程,可通过「业务配置更改」功能修改工程配置,确保工程平稳运行 |