管理员手册

# 前言

本文档描述了金蝶Apusic中间件云平台（简称“ACP”）V8.0产品管理运维、运营功能详细使用说明。

# 适用读者

本文档主要面向金蝶Apusic中间件云平台的管理、运维及运营人员。

# 相关文档

有关金蝶Apusic中间件云平台产品更多信息，请参考如下文档资源：

# 缩略词与术语

（无）

# 平台总览

提供数据面板，包括：

  • 租户数据如：租户数量，租户服务开通情况，租户配额使用情况。
  • 服务数据如：服务可用率，故障服务信息。
  • 资源数据如：资源使用率和余量。

# 产品管理

# 产品列表

基于已经接入的产品进行产品的创建，上/下架，删除、以及对服务信息维护等。

入口：进入 ACP 控制台，点击菜单【产品管理->产品列表】进入产品列表管理界面，默认展示选中目录下关联的所有产品列表并以卡片列表方式展示。

切换列表式展示信息。

筛选全部、已上架、或未上架的产品列表。

# 上架

在产品列表或产品详情中均可进行产品的上架操作，未上架产品可进行上架。

产品列表中点击卡片的【上架】按钮，弹出上架确认框，点击【确认】按钮确认上架操作。

产品详情中点击右上角操作区的【上架】按钮，弹出上架、下架确认框，点击【确认】按钮确认操作。

6

# 下架

在产品列表或产品详情中均可进行产品的下架操作，已上架的产品可下架。

产品列表中点击卡片的【下架】按钮，弹出下架确认框，点击【确认】按钮确认下架操作。

产品详情中点击右上角操作区的【下架】按钮，弹出下架确认框，点击【确认】按钮确认下架操作。

注意：

产品上架要求：关联了软件且至少配置了一个产品规格。

产品下架后：产品下架后产品介绍链接无法访问 ，门户无法搜索到，门户的产品列表不显示，产品无法开通。

# 产品新增

进入产品列表界面，点击【新增】按钮，进入产品新增界面，填写产品信息。

基本信息中必填项必须填写，产品特性和应用场景如未添加可以不填，如添加则必填。

1

2

基本信息参数说明：

  • 产品 logo：上传本地图片。

  • 产品目录：可多选，选项为产品的二级目录。

  • 产品名称：文本框，15 个字符限制。

  • 英文名称：文本框。

  • 产品简称：文本框，15 个字符限制。

  • 产品定位：文本框，30 个字符限制。

  • 产品介绍：文本框，250 个字符限制。

  • 计费模式：单选，选项：按量计费。

产品特性参数说明：

  • 产品 logo：单选，平台 logo 库选择，产品特性最多 4 个。

  • 产品标题：文本框，15 个字符限制。

  • 介绍：文本框，125 个字符限制。

应用场景参数说明：

  • 产品 logo：单选，平台 logo 库选择，产品特性最多 4 个。

  • 产品标题：文本框，15 个字符限制。

  • 介绍：文本框，125 个字符限制。

填写完成后，点击【确定】，产品创建成功后进行产品配置，也可暂不配置软件。

3

3

规则配置参数说明：

  • 关联软件：单选，数据来源于软件列表，关联成功后不允许修改。

  • 主机规格：多选，数据为可用服务器列表。

  • 数量限制：文本框，一次购买提交最多支持的服务个数。

# 产品详情

产品详情中展示了产品信息、产品规格，具有上、下架、删除及预览功能。

# 产品信息

4 5

# 基本信息编辑

# 产品特性编辑

# 产品特性删除

# 应用场景编辑

# 应用场景删除
# 产品规格

上架中的产品不允许修改关联软件。

选择软件规格：从关联的软件规格列表选择。

选择主机规格：按照关联产品的产品规格进行服务器选择，表示配置开通此产品时能选择的产品器资源规格。

按照规格限制默认配置最低主机要求和最佳要求的主机规格，且最低要求的机器规格不允许移除。 主机规格来自于 AUMP 中的所有数据中心下的主机资源库。

规格隐藏，隐藏的规格不可在产品开通时显示，隐藏规格只会影响之后开通的产品不会影响已经开通的产品。

# 产品删除

在产品详情页，点击右上角【删除】操作，弹出删除确认框，点击【确定】按钮确认删除操作。

产品删除后在产品列表不可见，仅当产品状态未上线、且产品下无创建实例时才可操作产品删除。

# 产品预览

在产品详情页，点击【预览】生成产品介绍广告页，展示产品信息。

# 产品目录

服务目录是平台提供服务的一种类型集合，目前提供二层级的目录结构，服务目录维护模块主要作用为对平台所提供的服务进行维护，包括服务目录的创建，停/启用，删除，信息修改。

入口：进入ACP控制台，点击菜单【产品管理->产品目录】进入产品目录管理界面，展示产品目录列表信息。

# 新增目录

进入产品目录管理界面，点击【新增】按钮，弹出产品目录新增窗口。

输入参数说明：

  • 目录名称：用户手动输入目录的名称，此为必填项，限制10字符长度。

  • 排序号：排序号用于控制在平台中产品目录的排放顺序，此为必选项，类型为数字。

  • 描述：补充描述信息，从组织列表中选择主机隶属部门。

  • 是否启用：服务目录是否启用并展示对应上下架服务，默认否。

# 目录编辑

进入产品目录管理界面，选中一条目录信息，点击【编辑】按钮，弹出产品目录编辑窗口，修改信息，并点击【确认】修改该条目录信息。

# 目录删除

进入产品目录管理界面，选中一条目录信息，点击【删除】按钮，弹出产品目录删除确认框窗口，并点击【确认】删除该条目录信息，点击【取消】则关闭弹窗取消删除操作。

# 新增子目录

进入产品目录管理界面，点击【新增子目录】按钮，弹出产品子目录新增窗口。

输入参数说明：

  • 上级目录：新增子目录的所属目录，根据所选目录回显，且不可编辑。

  • 目录名称：用户手动输入目录的名称，此为必填项，限制10字符长度。

  • 排序号：排序号用于控制在平台中产品目录的排放顺序，此为必选项，类型为数字。

  • 描述：补充描述信息，从组织列表中选择主机隶属部门。

  • 是否启用：服务目录是否启用并展示对应上下架服务，默认否。

# 子目录编辑

进入产品目录管理界面，选中以及目录下的一条子目录信息，点击【编辑】按钮，弹出产品目录编辑窗口，修改信息，并点击【确认】修改该条目录信息。

# 子目录删除

进入产品目录管理界面，选中以及目录下的一条子目录信息，点击【删除】按钮，弹出产品目录删除确认框窗口，并点击【确认】删除该条目录信息，点击【取消】则关闭弹窗取消删除操作。

# 子目录停用、启用

进入产品目录管理界面，选中以及目录下的一条子目录信息，操作子目录的停用、启用功能。

1、当状态为启用时，点击【停用】按钮，弹出产品目录停用确认框窗口，并点击【确认】停用该条目录信息，点击【取消】则关闭弹窗取消停用操作。

2、当状态为停用时，点击【启用】按钮，弹出产品目录启用确认框窗口，并点击【确认】启用该条目录信息，点击【取消】则关闭弹窗取消启用操作。

# 软件管理

接入管理为对接入到 ACP 平台的产品进行管理。

入口：进入 ACP 控制台，点击菜单【产品管理->软件管理】进入软件管理界面，展示软件列表信息，查询条件软件编号或者名称模糊搜索。

参数说明：

  • 软件编号：唯一编码。

  • 软件名称：软件名称（详情查看入口）。

  • 来源：目前都是来此 AUMP。

  • 更新时间：最近一次信息的更新时间。

  • 产品：管理的上下架产品。

# 软件详情

进入软件管理界面，选中一条信息，点击【软件名称】，进入软件详情界面。

基本信息参数说明：

  • 软件编号：唯一编码。

  • 软件名称：软件名称。

  • 来源：目前都是来此 AUMP。

  • 更新时间：最近一次信息的更新时间。

  • 创建时间：最初创建的时间。

产品规格（由版本+部署方式组成）参数说明：

  • 节点数量：节点限制。

  • 服务规格：最低限制和最佳推荐。

  • 配置参数：开放给用户配置的参数。

# 多租户管理

ACP 基于多租户模式设计，租户数据相互隔离。支持租户创建、用户池管理等。

# 租户管理

入口：【多租户管理->租户管理】，可以创建新的租户，添加租户成员以及租户的配额。

# 租户的创建和管理

租户包含租户名称、租户成员、总配额、租户管理员等信息。 点击【创建租户】，输入租户名称、选择租户成员。

点击【下一步】选择租户管理员（最多可以选择 5 位租户管理员），添加租户配额。

# 租户详情

点击租户名，可以查看租户详情，包含租户的基本信息，该租户下的成员列表，以及租的配额情况。

点击【添加管理员】或者【添加成员】可在该租户下加入新的管理员或者成员。

点击成员列表中的【移除】可移除改租户下的成员。

可以对租户配额进行新增、修改、删除操作。点击【新增配额】，可以给该租户添加新的资源。

# 用户池

对租户下的全部用户进行管理。可以创建用户，编辑、删除用户，也可以对用户分配租户。

入口：【多租户管理->用户池】进入用户池列表页，左侧是租户分类，右侧是该租户下的用户。

# 用户池的创建和管理

点击【创建用户】，输入用户名、密码、姓名、手机号码、邮箱、描述等信息，完成对用户的创建。

勾选表格中的用户，点击【分配租户】，选择租户，可以将勾选的用户分配至该租户。

# 用户详情

点击用户名，可以查看用户的基本信息，以及与该用户相关联的租户。

# 计量计费

支持按照中间件实例服务的运行时长进行计量，按照租户、产品类型进行统计分析，支持统计数据导出。

# 用量统计

入口：【计量计费->用量统计】可以看见用量统计列表，其中包含实例名称、节点数量、服务规格、产品类型、计费模式、创建时间、运行时长、所属租户。

# 统计数据导出

点击【导出】按钮，可以根据需求，自定义选择多个产品类型， 多个租户，时间周期，以及导出项，导出 excel 表格。

# 统计数据明细

点击列表中的【明细】按钮，可以查看当前实例每日运行时长的趋势图。

# 中间件管理

# 服务与实例

  • 服务

    通过网络提供一组特定业务价值的实例组合，代表具体部署的一个中间件服务，服务具有单实例和集群多实例的部署形态。

  • 实例

    正在运行的软件，包括中间件、其他软件等。主要的特点是对外提供各种业务服务。

# 准备计算资源

# 主机资源

该模块可以对主机资源进行系统管理。在主机管理页面可以查看目前的主机资源列表。同时可以新增主机、编辑主机、导入导出主机、刷新、监控、远程终端、免密重设等操作。页面提供了主机高级检索功能，可通过输入或者选择各搜索条件对主机进行检索。

入口：点击左侧菜单【资源->主机】，进入到主机管理页。可查看主机的资源列表。

# 新增主机

进入主机管理页，点击【新增】按钮，弹出主机新增窗口。目前支持 SSH 和 HTTP 两种主机连接方式。

SSH 方式比 HTTP 方式多一些终端设置项的输入。同时在功能上 SSH 比 HTTP 多了远程终端与免密设置的功能。

HTTP 适用于禁用 SSH 方式的场景。

SSH 方式输入参数说明：

  • 主机名称：用户手动输入主机的名称，此为必填项。

  • 数据中心：点击下拉框，从数据中心列表中选择，此为必选项。

  • 隶属部门：点击下拉框，从组织列表中选择主机隶属部门，此为必选项。

  • IP 地址：用户手动输入主机的 IP 地址，此为必填项。

  • 描述：用户手动输入，非必填。

  • SSH 端口：用户手动输入主机的 SSH 端口号，此为必填项。

  • 用户名：用户手动输入用户名，此为必填项。

  • 密码：用户手动输入密码，此为必填项。

  • 是否免密连接远程终端：radio 单选框，若选择【是】则点击远程终端时会自动登录，相反则需要用户手动输入用户名和密码，验证通过后方可进入终端。

  • 远程终端禁用命令：rm，mv，vim/vi，多选框，若选择了多个命令，远程终端中将会禁用这些命令。

操作：

【取消】：数据将不会被记录，点击该按钮后会直接关闭新增对话框。

【测试连接】：点击该按钮后，会对 IP+端口+用户名+密码进行测试是否能连接到主机。若测试不通过，会弹出提示如下图：

【确定】：点击确定按钮后，会检测必填项是否都已输入，检测无误后将会调用接口，完成后将有成功提示，同时关闭对话框，主机列表中也会增加一条记录。

HTTP 方式输入参数说明：

  • 主机名称：用户手动输入主机的名称，此为必填项。

  • 数据中心：点击下拉框，从数据中心列表中选择，此为必选项。

  • 隶属部门：点击下拉框，从组织列表中选择主机隶属部门，此为必选项。

  • IP 地址：用户手动输入主机的 IP 地址，此为必填项。

  • 描述：用户手动输入，非必填。

操作：

【取消】：数据将不会被记录，点击该按钮后会直接关闭新增对话框。

【测试连接】：HTTP 方式下该功能不可用。

【确定】：点击确定按钮后，会检测必填项是否都已输入，检测无误后将会调用接口，完成后将有成功提示，同时关闭对话框，主机列表中也会增加一条记录。

# 主机导入

进入主机管理页，鼠标悬停在【导入】后面的三个点的额外按钮，弹出下拉框，支持 SSH 模板导入和 HTTP 模板导入。目的是操作方便，可在外部 excel 文件导入多个主机进行管理。

点击内置 SSH 数据中心，弹出对话框：

可点击蓝色文字下载导入模板至本地，下载文件为【SSH-template.xls】，根据导入模板格式和提示填写内容，请确保各字段类型正确无误，否则有可能导致导入失败。切勿修改模板中的字段名称。数据导入上限为 2000 条。

SSH 导入模板如下：

点击内置 HTTP 数据中心，弹出对话框：

可点击蓝色文字下载导入模板至本地，下载文件为【HTTP-template.xls】，根据导入模板格式和提示填写内容，请确保各字段类型正确无误，否则有可能导致导入失败。切勿修改模板中的字段名称。数据导入上限为 2000 条。

HTTP 导入模板如下：

导入完成后，窗口下方显示导入成功与失败信息；若失败显示详细错误信息并提供错误信息文件下载功能。点击【下载文档】下载详细错误信。

# 主机导出

进入主机列表页，在列表中选择多行或一行，点击【导出】按钮，即可导出主机文档【主机信息.xls】，若不选择主机，则导出所有主机信息。

# 主机监控

进入主机列表页，选择一台主机，鼠标悬停操作列【更多】按钮出现下列框，选择【监控】，进入到监控页面。监控页面会对主机的运行状态、磁盘大小、内存大小、网络流速等进行监控，可视化展现。

功能限制：主机处于运行状态，且能查询到该主机的监控地址时功能方可用。

主机监控 主机监控

# 远程终端

进入主机列表页，选择一台主机，鼠标悬停【更多】按钮出现下列框，选择【远程终端】，进入到远程终端，即可对主机节点进行命令行操作。 若该主机已设置为免密登录，则直接跳转到远程终端，若不免密，则会跳到登录页，需要输入用户名和密码登录进入。

功能使用限制：主机处于运行状态，且只有使用 SSH 方式的主机可以使用远程终端功能。

远程终端

# 免密重设

进入主机列表页，选择一台主机，鼠标悬停【更多】按钮出现下列框，选择【免密重设】，弹出免密重设窗口，从而对主机的密码进行修改。

功能限制：只有使用 SSH 方式的主机可才可以使用此功能。

输入参数说明：

  • 用户名：默认带出原用户名，此为必填项。

  • 密码：输入框输入密码，此为必填项。

操作：

【取消】：数据将不会被记录，点击该按钮后会直接关闭对话框。

【测试连接】：测试用户名密码是否能连接成功，不能的话会弹出提示。

【确定】：点击确定按钮后，会检测必填项是否都已输入，检测无误后将会调用接口，完成后将有成功提示，同时关闭对话框。注意保存成功的前提是测试连接通过。

# 编辑查看主机

进入主机列表页，选择一台主机，点击【主机名称】或操作列的【编辑】，进入该主机资源详情界面。详情页面展示主机基本信息及运行实例列表。同时提供了对该主机的免密配置、远程终端、监控、导出的功能。

点击主机信息卡片标题右侧【编辑】按钮可以进入编辑状态，可对隶属部门、描述、是否免密、终端禁用命令进行编辑。 点击【确定】，保存修改信息，点击【取消】，返回至查看状态。

# 数据中心

对于多数据中心的 IT 系统架构，可使用 AUMP 的数据中心功能进行资源区分管理，目前支持 SSH 以及 HTTP 两种控制模式对数据中心下的资源进行控制，可根据实际系统情况为数据中心配置不同控制模式。

数据中心通过脚本进行初始化配置。在该模块中用户可以查看当前的数据中心信息，只支持用户浏览，不支持页面操作。

入口：点击菜单【资源->数据中心】进入数据中心管理界面，展示数据中心列表信息。

具体多数据中心配置操参考多数据中心配置 (opens new window)

# 查看

进入数据中心管理界面，点击【查看】连接，弹出信息查看窗口，显示数据中心名称、描述、地理位置、ip 地址范围信息详情，点击【确定/关闭】按钮，关闭弹窗。

# 安装中间件

当系统限制的最大管理实例数量大于当前管理的实例数，允许用户安装中间件。否则安装、批量安装、快速安装及导入功能被禁用。

# 单个安装

提供用户引导，规范操作入口，支持分步式安装部署，安装时默认使用统一配置信息，配置信息个性化设置功能。

入口：点击菜单【中间件->服务管理】，进入服务管理界面，点击【安装】按钮进入安装界面，或选择软件后进入安装界面，界面显示安装参数信息，并根据所属软件进行软件安装。

安装基础信息编辑页，填写基础信息，点击【下一步】按钮，保存当前输入的基础信息，并进入资源配置界面。 或者点击【取消】取消安装操作，提示“是否退出软件安装”，点击【确认】按钮，回到服务管理界面。 在资源配置界面，选择数据中心，通过添加资源或者自动分配方式进行资源的配置。

点击【添加资源】弹出资源选择窗口，选择主机并点击【确认】按钮进行资源添加。

鼠标悬停【自动分配】，弹出自动分配资源设置窗口，输入需要分配的资源数，点击【确认】进行主机自动分配，自动分配完成提示已分配信息。

资源配置完成后，点击【下一步】按钮，保存当前配置的资源，并进入组件配置界面。

在组件配置界面，根据基础信息界面中所选的软件、版本及部署形态信息获取对应的组件信息，进行全局组件配置。 若开启监控，安装成功后，选择实例，鼠标悬停【...】,点击【监控】链接，进入基础设施监控监控页面。

组件配置完成后，点击【下一步】按钮，保存组件配置信息，并进入安装确认页。

在安装确认界面，上部分展示所填写的基础信息，下部分展示所配置的资源、资源的组件配置信息。 若需要回退操作，点击【上一步】按钮，提示“离开当前页，个性化配置数据将丢失”，点击【确定】按钮，回到组件配置界面对全局组件信息重新进行配置。 点击【个性化】链接，对单个资源进行组件个性化配置，展开“修改配置信息”可对配置文件路径及文件进行修改，点击【确认】按钮，确认个性化配置并保存修改的内容。 安装确认配置信息无误，点击【安装】进行智能安装操作，操作成功后提示“安装成功”，并进入完成界面，点击【继续安装】回到基础信息配置界面，点击【查看详情】查看已安装中间件详情信息。

# 批量安装

支持同一软件相同版本的服务批量安装，批量安装时默认使用统一配置信息，配置信息个性化修改功能。

入口：点击菜单【中间件->服务管理】，进入服务管理界面，点击【批量安装】按钮进入批量安装界面，或选择软件后进入批量安装界面，界面显示批量安装参数信息，并根据所属软件进行批量安装。

填写基础配置信息，所属软件版本，获取部署形态信息，选择部署形态，获取安装组件信息并对组件信息进行全局配置。

在服务列表中，可通过添加资源或者自动分配方式进行资源的配置。

点击【添加资源】弹出资源选择窗口，选择主机并点击【确认】按钮进行资源添加。

鼠标悬停【自动分配】，弹出自动分配资源设置窗口，选择数据中心，输入需要分配的资源数，点击【确认】进行主机自动分配，自动分配完成提示已分配信息。

选择的主机默认赋值全局配置的组件信息，主机配置完成后，也可通过点击【编辑】对主机配置信息进行个性化配置。

确认配置信息及服务列表中信息配置无误，点击下方【提交】按钮，进行批量安装。

安装成功，界面提示安装成功提示，并返回至服务管理界面； 安装失败，弹出错误提示信息。

点击【取消】，回退至服务管理界面；

# 快速安装

为减少现场复杂度，提供一键安装脚本，实现产品快速安装。

入口：点击菜单【中间件->服务管理】，进入服务管理界面，点击【快速安装】按钮进入快速安装界面，或选择软件后进入快速安装界面，界面显示快速安装参数信息，并根据所属软件进行快速安装。

填写基础配置信息，选择所属软件版本，获取部署形态信息、推荐资源数量信息，选择部署形态，获取快速安装参数配置信息并对其进行配置。

确认安装信息填写无误，点击下方【确认】按钮，进行快速安装。

安装成功，界面提示安装成功提示，并返回至服务管理界面； 安装失败，弹出错误提示信息。

点击【取消】，回退至服务管理界面。

# 导入安装

采用动态生成的软件导入模板文件，优化填写体验，导入 Excel 文件，实现安装中间件。

入口：点击单菜【中间件->服务管理】，进入服务管理界面，点击【导入】按钮弹出导入窗口。

在窗口中选择所属软件及版本，点击【下一步】按钮，获取动态生成的所选软件导入模板。

选择该导入模板或通用模板下载，根据导入模板格式和提示填写内容，请确保各字段类型正确无误，否则有可能导致导入失败。切勿修改模板中的字段名称，数据导入上限为 2000 条，填写完成，上传 Excel 文件。

导入完成后，窗口下方显示导入成功与失败信息；若失败显示详细错误信息并提供错误信息文件下载功能。点击【下载文档】下载详细错误信。

# 安装预检

为解决安装环境复杂性带来的安装异常问题，提供对选定安装的目标机器进行安装预检功能，给出安装提示，支持 jdk 安装。

入口：安装（安装确认步骤）或批量安装界面，点击下方【环境监测】按钮，触发安装预检功能。

触发安装预检后，系统给出环境检测结果提示，并支持 jdk 安装。

# 安装后的检查

软件安装成功，界面提示安装成功提示。返回至服务管理界面，查看服务状态(在线运行实例数/实例总数)、运行日志详情查看安装进度。 安装进度完成后，查看服务状态，进入服务详情查看服务下所有实例运行状态，状态异常的实例进行中间件管控，并查看运行日志详情信息。

# 纳管已有的中间件

将原有零散手工的中间件管理方式转为平台化、统一的管理。支持存量已部署的中间件实例的纳管，以及通过平台新部署的中间件的管理，实现集约化、规模化管理，提高管理的规模和效率。

# 导入

点击菜单【中间件->服务管理】，进入服务管理界面。点击【导入】按钮，弹出导入对话框。 点击【下一步】按钮，弹出如下对话框，下载选择的软件对应的模板或通用模板进行数据编辑，包括服务和实例，然后将编辑后的模板保存后重新拖拽到上传区域上传。导入完成后，窗口下方显示导入成功与失败信息；若失败显示详细错误信息并提供错误信息文件下载功能。点击【下载文档】下载详细错误信。 导入模板：

# 导出

点击菜单【中间件->服务管理】，进入服务管理界面。选择一个或多个服务（当全都不选时，默认导出全部），点击【导出】按钮，将导出服务信息 excel 文件，文件内容包含服务与对应的实例信息。

# 管理中间件服务

针对已经部署好的中间件服务，平台提供了启、停、移除、卸载、升级、日志等功能。

# 服务筛选

点击菜单【中间件->服务管理】，进入服务管理界面，可以查看到当前已经部署好的中间件服务。

服务管理管理页面左侧为软件的分类，点击任何一个软件卡片，右侧表格会筛选出对应的中间件列表。 同时，页面右上角支持模糊查询，可以根据组织，应用及服务名称进行模糊查询。

# 启动

点击菜单【中间件->服务管理】，进入服务管理界面，选择一条或多条服务信息，点击【启动】按钮，弹出启动提示窗口，点击“确定”按钮，将会把服务器集群中的实例启动。

# 停止

点击菜单【中间件->服务管理】，进入服务管理界面，选择一条或多条服务，点击【停止】按钮，弹出停止提示窗口，点击“确定”按钮，将会把服务器集群中的实例停止运行。

# 重启

点击菜单【中间件->服务管理】，进入服务管理界面，选择一条或多条服务，点击【重启】按钮，弹出重启提示窗口，点击“确定”按钮，将会把服务器集群中的实例重新启动。

# 移除

点击菜单【中间件->服务管理】，进入服务管理界面，选择需要移除的服务，点击【移除】按钮，，或者鼠标悬停在服务列表某一列的更多操作按钮上，在下拉框中点击【移除】，弹出删除提示窗口，点击“确定”按钮，将会将服务器集群信息移除。移除服务器集群信息前需要先把服务器集群中的实例删除。

移除后系统将无法控制这些软件，如需控制要重新增加或导入。

# 卸载

点击菜单【中间件->服务管理】，进入服务管理界面，选择需要卸载的服务，点击【卸载】按钮，或者鼠标悬停在服务列表某一列的更多操作按钮上，在下拉框中点击【卸载】，弹出卸载提示窗口，点击“确定”按钮，将会将服务器集群信息与实例卸载。卸载后将无法再恢复。

# 升级

对于已安装的中间件，若软件版本更新，平台提供升级功能。

入口：点击菜单【中间件->服务管理】，鼠标悬停在服务列表某一列的更多操作按钮上，在下拉框中点击【升级】跳转到服务升级页面。

服务有两种升级方式，安装包升级和补丁升级。

安装包升级：

此种方式采用选择事先上传好的可升级安装包（需在软件仓库中上传）进行升级。

参数说明：

  • 升级方式：分为安装包和补丁两种，页面默认选择安装包。
  • 升级说明：用户输入此次升级的说明描述，非必填。
  • 软件包：点击下拉框，选择该软件可用于升级的软件包，此为必选项。注意：可升级软件包需要提前在软件仓库上上传才可以，否则升级页面没有可用的软件包，页面会在输入框下面提示“无可用的软件包，请在软件库中上传！”。

操作：

点击【确认】按钮，会执行升级操作。页面返回至服务管理页面，同时会弹出操作成功与否的提示。

点击【取消】按钮，将关闭升级页面，跳转到服务管理页面，信息不会被记录。

补丁升级：

此种方式允许用户自行上传补丁文件进行升级，支持上传多个补丁文件。

参数说明：

  • 升级方式：分为安装包和补丁两种，需点击补丁，激活补丁升级方式。
  • 升级说明：用户输入此次升级的说明描述，非必填。
  • 目标路径：补丁文件的目标路径，注意：需输入相对路径，必填。
  • 补丁资源：用户自行选择补丁文件进行上传，必传。

操作：

点击【添加】按钮，会增加一组【目标路径】和【补丁资源】，支持用户上传多个补丁文件。

点击【确认】按钮，会执行升级操作。页面返回至服务管理页面，同时会弹出操作成功与否的提示。

点击【取消】按钮，将关闭升级页面，跳转到服务管理页面，信息不会被记录。

# 回滚

服务升级后可进行回滚。

入口：点击菜单【中间件->服务管理】，选择升级的服务，点击服务名称进入该服务详情页。在详情页点击【版本记录】，可查看服务升级历史的最新 5 条。 在操作列点击【回滚】，弹出对话框，输入回滚原因，点击【确定】后即可将服务回滚至上一版本。点击【取消】弹出二次确认消息后，关闭对话框，取消回滚操作。 操作限制：最新一条记录不出现回滚按钮，已经回滚过的不允许再次回滚操作。

# 授权更新

平台提供授权更新可视化操作。

入口：点击菜单【中间件->服务管理】，鼠标悬停在服务列表某一列的更多操作按钮上，在下拉框中点击【授权更新】跳转到授权更新页面。

功能限制:该功能只支持自有中间件：AASV9、AASV10、AMDC、AMDQ。 参数说明：

  • 目标路径：授权文件的目标路径，注意：需输入相对路径，必填。
  • 文件：用户自行选择授权文件进行上传，必传。

操作：

点击【添加】按钮，会增加一组【目标路径】和【文件】，支持用户上传多个文件。

点击【确认】按钮，会执行授权更新操作。页面返回至服务管理页面，同时会弹出操作成功与否的提示。

点击【取消】按钮，将关闭授权更新页面，跳转到服务管理页面，信息不会被记录。

# 运行日志

1、点击菜单【中间件->服务管理】，鼠标悬停在服务列表某一列的更多操作按钮上，在下拉框中点击【日志】弹出在线运行日志详情对话框。 2、点击服务列表服务名称进入某个服务的服务详情页，右上角点击【日志】按钮，弹出在线运行日志详情对话框。

运行日志详情内容区域默认显示最近 100 行日志内容，日志内容默认 5 秒钟自动更新一次。

操作：

点击【刷新】按钮，日志内容刷新。

点击【下载】按钮，将会下载日志全部内容。

点击【关闭】按钮，将会直接关闭日志详情对话框。

# 服务详情

入口：点击菜单【中间件->服务管理】，选择一个服务，点击【服务名称】或操作列的【查看】，进入该服务详情界面。详情页面展示服务基本信息、监控详情、版本记录。

基本信息：展示服务信息及组件基本信息和对应的实例列表。组件实例列表对应的操作同中间件实例。组件实例的批量配置同中间件实例配置。

监控信息：展示同一服务下的同一组件的多个实例树形结构，同时展示实例的监控设施状态。 实例状态包括：正常、告警、离线、未知。点击实例图标跳转到具体的监控信息页面（如果没有开启监控则不跳转）。 注意：ADMC 如果是集群部署形态，则展示整个集群的运行状态。

版本记录：展示服务升级历史的列表，只展示最近 5 条的升级记录。 在操作列点击【回滚】，弹出对话框，输入回滚原因，点击【确定】后即可将服务回滚至上一版本。点击【取消】弹出二次确认消息后，关闭对话框，取消回滚操作。 操作限制：最新一条记录不出现回滚按钮，已经回滚过的不允许再次回滚操作。

# 管理中间件实例

# 实例筛选

点击菜单【中间件->实例管理】，进入实例管理界面，可以查看到当前已经部署好的中间件实例。

实例管理管理页面左侧为软件的分类，点击任何一个软件卡片，右侧表格会筛选出对应的中间件列表。 同时，页面右上角支持模糊查询，可以根据组织，应用及实例名称进行模糊查询。

# 启动

进入实例管理界面，在列表模式选择一条或多条实例信息（或在卡片模式选中一个或多个卡片），点击【启动】按钮，弹出启动提示窗口，点击“确定”按钮，将会把实例启动运行。

# 停止

进入实例管理界面，在列表模式选择一条或多条实例务信息（或在卡片模式选中一个或多个卡片），点击【停止】按钮，弹出启动提示窗口，点击“确定”按钮，将会把实例停止运行。

# 重启

进入实例管理界面，在列表模式选择一条或多条实例信息（或在卡片模式选中一个或多个卡片），点击【重启】按钮，弹出启动提示窗口，点击“确定”按钮，将会把实例重新启动。

# 访问控制台

AASV9、AASV10 提供管控台免密登录功能。进入实例管理界面，选择一条实例信息，鼠标悬停【更多】，点击【管控台】免密进入 Apusic 应用服务器监控管理平台。

# 删除

进入实例管理界面，在列表模式选择一条或多条需要移除的实例信息信（或在卡片模式选中一个或多个卡片），点击【移除】按钮，弹出启动提示窗口，点击“确定”按钮，将会将实例信息移除。 在列表操作行，鼠标悬停【移除】，也会将实例信息移除。

# 监控

进入实例管理界面，选择一条实例信息，鼠标悬停【更多】，点击【监控】链接，进入基础设施实例监控页面。

# 配置

进入实例管理界面，选择一条实例信息，鼠标悬停【更多】，点击【配置】即可弹出实例配置对话框。或者进入实例详情页，点击右上角的【配置】按钮同样可进行配置。 若组件无配置参数，弹出提示如下：

若有配置参数，则会显示配置参数的表单，点击【确定】后弹出消息二次提示提示【配置修改后将立即重启实例，确定继续该操作吗？】确认后会保存配置参数的修改。

# 实例详情

入口：点击菜单【中间件->实例管理】，选择一个服务，点击【实例名称】或操作列的【查看】，进入该实例详情界面。详情页面展示实例信息、配置文件、日志详情、操作历史、关联资源、关联应用。

实例基本信息编辑：点击编辑按钮，编辑实例描述，点击确定完成编辑。

配置文件查看：在配置文件列表操作列点击【查看】，弹出配置文件详情对话框。

日志信息查看及下载：在日志信息列表操作列点击【查看】，弹出配置日志详情对话框。点击【下载】可下载日志文件。

操作历史：展示配置操作的历史，若实例进行了配置操作，则新增一条操作历史。只展示最近的 5 条操作历史。 在操作历史列表中点击查看按钮，弹出配置参数的原值与新值，若两者不相等则高亮显示。 在操作历史列表中点击【还原】按钮，则配置参数还原为原来的值，并生成一条操作记录。

关联资源展示该实例关联的主机基本信息，点击【资源详情】页面跳转到该主机的详情页面。 关联应用展示该实例关联的应用基本信息，点击蓝色应用名称，页面跳转到该应用的详情页面。

# 管理中间件配置

# 配置模板

该模块可以管理接入软件的配置模板。用户可新增软件的统一使用模板，并对模板进行编辑、删除和对比。

入口：点击左侧菜单【配置->配置模板】，进入到配置模板页。默认展示 AASV9 的模板。用户可以切换软件的下拉选项，选到想查看的软件，来对该软件的模板进行管理。

# 新增模板

在配置模板页，选择软件后，点击【新建模板】按钮，进入新增模板页面，输入模板名称和描述，选择软件版本范围，并增加模板配置内容，即可新增成功。

功能限制：需要选定软件，若无软件功能不可用。

# 编辑模板

在配置模板页，点击列表操作列中的【编辑】按钮，进入模板编辑页，此时可以编辑模板名称、描述及模板配置内容。

功能限制：需要选定软件，若无软件功能不可用。

# 查看模板

在配置模板页，点击列表中操作列的【查看】按钮或者点击表格第一列，进入到查看页面，此时所有内容均不可修改。

# 模板对比

点击菜单【配置模板】, 进入到配置模板列表页，当有且只有选择两个模板，点击【对比】按钮，可看到文件对比内容，文件对比内容中不同的地方被黄色背景标注。

功能限制：同一模板下需要有两个及以上模板，且选定两个模板时功能才可用。

模板选择

文件对比内容，文件对比内容中不同的地方被黄色背景标注，也可以通过选择框切换配置模板，选择不同类型的配置文件进行比较。 模板内容对比

# 模板删除

删除模板，删除后不可恢复。在配置模板页，点击列表中操作列的【删除】按钮，即可进行删除操作。 模板删除

# 应用配置模板到实例

在软件安装过程中，可以选择在模板配置中创建的模板来进行配置。

# 中间件实例配置更新

平台提供页面可视化的方式帮助用户修改中间件的配置参数。

入口：

1、菜单【中间件->实例管理】，实例列表操作列，鼠标悬停【更多】，点击【配置】即可弹出实例配置对话框。 2、菜单【中间件->实例管理】，点击列表【实例名称】列，进入实例详情页，点击右上角的【配置】按钮即可弹出实例配置对话框。 3、菜单【中间件->服务管理】，点击列表【服务名称】列，进入服务详情页，选择部署角色卡片表格的一行或多行，点击【批量配置】按钮。

点击以上入口按钮后，若组件无配置参数，弹出提示。

若有配置参数，则会显示配置参数的表单，点击【确定】后弹出消息二次提示提示【配置修改后将立即重启实例，确定继续该操作吗？】确认后会保存配置参数的修改。

如果实例进行了参数配置，会在实例详情中展示最近的 5 条操作历史。 在操作历史列表中点击查看按钮，弹出配置参数的原值与新值，若两者不相等则高亮显示。 在操作历史列表中点击【还原】按钮，则配置参数还原为原来的值，并生成一条操作记录。

# 中间件仓库

# 组件的概念

组件是软件的逻辑部件的统称，一个软件通常包含一个或多个可部署单元。组件可以是软件的一个内置部件，也可以是引用一个独立软件，甚至是已经部署好的软件实例或者外部服务。

# 出厂默认支持的中间件

软件名称 版本
金蝶 Apusic 应用服务器（AAS） V9、V10
金蝶 Apusic 分布式消息（ADMQ） V2.4+
金蝶 Apusic 分布式缓存（AMDC） V2.0+
金蝶 Apusic 负载均衡（ALB） V2.0+
金蝶 Apusic 分布式配置中心（ADCC） V1.X
Redis 5.X
Nginx 1.8.0~2.0
Zookeeper 3.4.X
Kafka 0.10.X、1.11.X
Keepalived 2.1.0~2.1.5
ActiveMQ 5.X

# 中间件目录与分类

为了便于管理软件分类，可以建立不同的中间件目录。

入口：点击菜单【软件->软件目录】进入软件目录管理页面。 点击【新增目录】按钮，弹出目录新增对话框，输入目录名称及描述后，点击确定按钮即可增加一个新的目录。 在列表操作列点击【编辑】，弹出目录编辑对话框，可对目录名称和描述进行编辑。 选择一个或多个目录后，点击【删除】按钮，可对目录进行批量删除。点击表格操作列的删除则为单个删除。

# 自定义接入中间件

除了出厂默认支持的中间件，用户可自定义接入中间件。

入口：点击菜单【软件->软件接入】进入软件接入页面。此页面提供软件的新增、导入、导出、编辑、删除功能，来完成自定义软件的导入。

# 新增/编辑软件

在软件接入页点击【新增软件】按钮，进入软件新增页面，即可对软件进行接入。 可分为基本信息、版本范围（包括组件定义和部署定义）。其中，版本范围、组件定义、部署定义可自由增减。

  • 基本信息（以下*号皆为必填） - 软件目录：点击下拉框，选择软件归属的目录 - 软件编码：用户手动输入，注意唯一性，若不唯一，最后保存时弹出提示将不允许保存 - 软件名称：用户手动输入 - 软件描述：用户手动输入，添加描述 - 图标：软件的 logo 图标，支持上传 png、jpg 格式的图片，图标会在实例、服务列表页面中展示。

  • 版本范围 默认有一个版本范围，且有一个时不可删除。点击【+】按钮，生成新的版本范围，点击 tab 标题右侧的叉号，可以删除该版本范围。版本最多可添加十个。 点击右侧的【复制当前 Tab】按钮，可再复制一个与当前版本内容相同的新版本。 - 版本范围：必填，输入软件版本。输入框的内容改变后，版本范围页签的标题跟着改变 - 版本描述：用户输入 - 管控台：开关打开后，显示控制台地址输入框 - 配置信息：可添加多行配置信息。配置参数改变后，组件的关联配置列表跟着改变 - 操控方式：目前只支持定制脚本 - 安装位置:用户输入 - 安装依赖：选择软件的安装依赖，如 jdk 或 python 等。最多可添加 10 个，依赖不能重复添加。选择依赖后，在服务安装中，会有环境检测功能，对目标机器进行安装依赖检测并给出对应反馈。

    - 组件定义：

    默认有一个组件，点击【+】按钮，生成新的组件，点击tab标题右侧的叉号，可以删除该组件。最多可添加十个组件。点击右侧的【复制当前Tab】按钮，可再复制一个与当前组件内容相同的新组件。
    - 组件名称：输入框的内容改变后，tab标题跟着改变。
    - 组件编码：用户输入，必填，在同一版本内要唯一。
    - 组件描述：用户输入。
    - 关联配置：下拉多选，下拉内容列表与版本基本信息中配置信息同步。
    - 日志位置：用户输入，必填。
    ![](./assets/user-manual/software/component-base-info.png)

    - 安装参数：在软件安装时候需要，后续不可修改。点击【新参数】按钮，生成一行参数表单，点击表单右侧的叉号，可以删除该参数。端口参数为必有内容，不可删除。
        - 参数名称：用户输入中文参数名称。
        - 参数代号：用户输入参数英文代号。
        - 参数类型：下拉框选择，选择类型的不同会影响安装中参数表单的展现形式，如展现输入框或选择框等。可选项：INT("整数"), TEXT("文本"), PASSWORD("密码"), NAME("名称"),DESCRIPTION("文本描述") ,ONOFF("开关"),POSITIVEINT("正整数"),PERCENTAGE("百分比"),POSITIVEFLOAT("正浮点数"), FLOAT("浮点数"),IP("IP地址"),RADIO("单选"),CHECKBOX("多选"),FILEPATH("文件路径"), FOLDERPATH("文件夹路径")。
        - 长度：用户输入最大长度。
        - 取值：用户输入，需根据参数类型来区分输入，如单选和多选为label=value。
        - 生效条件：用户输入js表达式。
        - 必填：复选框，选择必填，安装时有必填校验。
        - 快速安装必填：复选框，设置快速安装参数是否必填。
        - 参数描述：用户输入参数的说明。
    ![](./assets/user-manual/software/component-installparams.png)
    - 配置参数：内容同安装参数。在安装和配置时都需要，允许修改。

    - 监控参数定义：若打开监控支持开关，则可以选择监控模板，同时显示相应的监控参数进行设置。
    ![](./assets/user-manual/software/monitor-params.png)

    - 操控定义：
          针对不同的操作类型（安装、卸载、启动、停止、初始化、配置）进行脚本参数的添加及脚本内容的编辑。
    ![](./assets/user-manual/software/component-opration.png)

- 部署定义：

    默认有一个部署形态，且有一个时不可删除。点击【+】按钮，生成新的部署形态，点击tab标题右侧的叉号，可以删除该部署形态。最多可添加十个部署形态。 点击右侧的【复制当前Tab】按钮，可再复制一个与当前部署形态内容相同的部署形态。

    - 部署名称：输入框的内容改变后，tab标题跟着改变。
    - 部署编码：用户输入，在同一版本内要唯一。
    - 部署描述：用户输入。
    - 节点数量：用户选择。
    - 机器规格：用户选择。
    - 组件：组件列表来自于该版本下组件定义部分添加的组件。组件可拖动顺序，可多选。
    ![](./assets/user-manual/software/deploy-info.png)

操作：

点击页面最下方操作条的【保存】按钮，页面所有的输入信息方可被保存。保存前有表单输入的校验，若保存成功，则会跳转到软件接入列表页，若不成功，页面会有红色提示，用户可根据提示修改表单信息再进行保存。

点击页面最下方操作条的【关闭】按钮，弹出二次提示后，页面将跳转到软件接入列表页，信息不会被记录。

# 软件导入

在软件接入页面点击【导入】按钮，弹出导入对话框。用户可以选择文件上传或将文件拖拽到上传区域，注意：只支持上传.yml 文件(导入文件格式可参考导出文件)，若选择其他格式的文件会弹出信息提示，将不允许上传。

操作：

点击【确定】按钮，文件将会被上传，导入成功后，会自动关闭对话框，列表中增加一条记录。

点击【取消】按钮，对话框将会被关闭，信息不会被记录。

# 软件导出

在软件接入列表中，选择一个或多个软件，然后点击上方的【导出】按钮，会直接下载选择软件的 yml 文件。若选择多个，下载文件则为压缩包，若选择一个，下载文件为单个的 yml 文件，若不选择，下载文件为所有软件的压缩包。

# 软件删除

在软件接入列表操作列点击【删除】，弹出二次确认提示，确认后可删除。

# 软件仓库

在软件仓库页面管理软件安装包的上传、下载等操作，同时页面提供的高级检索功能，可以通过软件类别、软件版本、操作系统、cpu 架构、分类对列表数据进行筛选来查看自己想看到的数据。

# 软件库导入

在软件库仓库页面点击【导入】按钮，弹出软件库导入模态框。

导入参数说明：

  • 软件：点击下拉框，选择要导入的软件的类别，此为必选项。
  • 版本范围：与软件的选择有关。点击下拉框，选择版本范围，此为必选项。
  • 软件版本：用户手动输入软件的版本，此为必填项。
  • CPU 架构：点击下拉框，选择 CPU 架构，此为必选项，可选项包含：X86、X86_64、ARM64、MIPS64。
  • 操作系统及版本：点击下拉框，选择操作系统，此为必选项。
  • 分类：点击下拉框，选择分类，此为必选项，分类包含：基础资源、中间件、应用、库文件。
  • 描述：用户手动输入。
  • 安装包：点击上传按钮，弹出文件选择框，安装包为必选项，其中当分类选择为库文件时，只能上传 zip、tar、rpm、pkg、gz、war、jar 类型的文件。

操作：

点击【确定】按钮，提示成功后，可在列表页看到刚刚导入的软件。

点击【取消】按钮，将关闭对话框，信息不会被记录。

# 软件库下载

点击表格操作列的下载按钮，可对软件的安装包进行下载。 点击表格上方的下载按钮，可对选中的安装包分别进行下载。

# 软件库删除

点击表格操作列的删除按钮，可对该列的软件包进行删除，删除记录时同时会删除安装包。

# 软件安装

在软件库列表【操作】列点击安装，进入软件安装页面，即可对该软件进行安装。

# 软件库详情

在软件库列表点击第二列【软件库名称】或在最后一列【操作】列点击查看，进入软件库详情页面，即可查看软件详情信息。

# 业务分组与隔离

# 应用

应用是一组相关联中间件实例的集合，实现完整的业务功能。应用是一种视图，提供业务维度的管理能力。在应用模块用户可以查看已经创建的应用列表，可以新增编辑删除应用，也可以从外部文件中导入应用。

入口：点击菜单【应用】进入应用管理页面。点击应用名称进入应用详情页，详情页中可查看该应用下的实例列表与资源列表。 应用列表展示应用的基本信息列表，包括应用名称、应用版本、描述、隶属部门、运行实例数、操作。 点击第一列的应用名称可以进行详情页，同时在详情页中也提供了应用基本信息编辑的功能；在列表的操作列提供了编辑和删除的功能。 列表头部操作区域提供了新增应用，导入应用和批量删除应用的功能，其中批量删除功能只有在选中列表一行或多行时可用。 同时标题头部右侧提供了根据应用名称或版本进行模糊查询的功能。

# 新增应用

在应用管理页面点击【新增】按钮，进入应用新增页。

应用基本信息输入参数说明：

  • 选择部门：点击下拉框，从组织列表中选择应用对应的部门，为必选项。
  • 应用名称：用户手动输入，为必填项。
  • 应用版本：用户手动输入，为必填项。
  • 描述：用户手动输入应用的描述说明信息。

操作：

点击右下角【保存】按钮即可成功创建应用，页面跳转到应用管理页面，同时应用列表中将会增加一条记录。

点击右下角【关闭】按钮，页面将会返回到应用管理页面，数据不会被记录。

# 编辑应用

编辑应用时，在应用列表页的操作列点击编辑按钮，进入该应用的详情页，点击应用信息标题后面的编辑按钮即可对应用的基本信息进行编辑。 编辑完应用基本信息后，点击确定按钮则可以完成应用信息的编辑，点击取消取消本次编辑。

# 导入应用

使用 excel 文件导入应用，注意：文件内容格式要与模板一致，模板可按如下引导方式下载。

在应用管理页面点击【导入】按钮，弹出导入对话框。

导入应用时，可点击蓝色文字【导入模板】进行模板下载，再根据格式修改数据，注意：请确保各字段类型正确无误，否则有可能导致导入失败。切勿修改模板中的字段名称。数据导入上限为 2000 条。

导入模板，当把修改后的文件保存后，将导入文件拖拽到导入弹出框的上传区域即可完成应用的导入，导入成功后可以在应用列表中查看到导入的应用。

# 删除应用

批量删除：表格中单选或多选应用时，批量删除功能才可用。该功能需在表格中选中应用才可用。

单个删除：点击表格操作列的【删除】，即可对该行的应用进行删除。

# 组织部门

平台提供了组织管理的功能，在中间件导入时可以选择组织部门，更好的纳管中间件的分类。在该功能中用户可以很清晰的查看用户的组织结构，同时用户可以新增编辑删除某个组织。

组织入口：统一平台->平台管理->组织管理。 组织管理列表呈现组织的树形结构，从公司到部门到小组。

# 新增编辑组织

在组织管理模块中，点击按钮【新增】即可打开新增组织对话框；点击表格操作列的【编辑】，可以编辑该组织。

参数说明：

  • 上级组织：下拉框，下拉列表为组织的树形结构，用户选择它的上级组织，必选。
  • 组织类型：三选一，必选，组织类型包括三类:公司、部门、小组。
  • 组织名称：用户手动输入组织的名称，此为必填项。
  • 说明：用户输入，非必填，添加组织的备注说明。
  • 管理员：下拉选择该组织的管理员，非必选。

操作：

点击【确定】按钮，组织信息将被保存，可在列表页看到组织信息的更新。

点击【取消】按钮，将关闭对话框，信息不会被记录。

# 组织详情

在组织管理模块中，点击组织名称可以查看组织详情，除基本信息外，可以查看该组织的下级部门及该组织下的用户。

# 相关工具

# 远程终端

主机中提供了远程终端功能，可以对主机进行命令行操作。

功能使用限制：主机处于运行状态，且只有使用 SSH 方式的主机可以使用远程终端功能。

入口：

1、点击菜单【资源->主机管理】进入主机管理页面。在主机列表，选择一台主机，鼠标悬停【更多】链接，选择【远程终端】，若该主机为免密连接，则直接跳转到远程终端，若非免密，会跳转到远程终端登录页，输入正确密码后可以登录进入远程终端。若主机设置了终端禁用命令，则在终端中无法使用该命令。 2、点击主机列表主机名称列，进入主机详情页面，在右上角有【远程终端】按钮，点击后功能同 1。

非免密状态下，需要输入正确密码方可登录。

主机的远程终端禁用命令在新增或导入时可设置，并且在主机详情页也可以修改禁用命令与免密与否。

# 日志

系统提供了运行日志的查看与下载功能。若进行了中间件的安装，服务的启停删等操作都可以在日志功能中进行查看。

入口：

1、点击菜单【中间件->服务管理】，鼠标悬停在服务列表某一列的更多操作按钮上，在下拉框中点击【日志】弹出在线运行日志详情对话框。 2、点击服务列表服务名称进入某个服务的服务详情页，右上角点击【日志】按钮，弹出在线运行日志详情对话框。

运行日志详情内容区域默认显示最近 100 行日志内容，日志内容默认 5 秒钟自动更新一次。

操作：

点击【刷新】按钮，日志内容刷新。

点击【下载】按钮，将会下载日志全部内容。

点击【关闭】按钮，将会直接关闭日志详情对话框。

# 运维观测

# 监控中心

内置中间件指标采集器进行指标数据采集，支持监控任务的可视化界面配置，包括采集指标，采集端点，采集路径等。可通过配置图表面板实现指标可视化展示，支持配置多套面板，定义面板筛选条件，图表数据动态刷新。

# 实例监控

实例监控是对实例资源监控指标进行采集监控并进行管理。

# 实例筛选

进入实例监控界面，可以看到实例监控的列表信息，包括实例名称，采集状态、版本、部署模式、告警策略、查看的操作。

入口：点击【运维观测->监控中心】左侧菜单【指标->实例监控】，可以看到左侧的软件分类和右侧的实例监控的表格，点击任何一个软件分类，都能筛选出当前对应的实例。

  1. 实例名称：实例的名称，点击实例名称，可以查看当前实例的监控详情、告警策略以及告警事件。

  2. 采集器状态：采集器运行的状态，全部运行正常显示正常，存在运行异常的显示异常。

  3. 版本：软件的版本。

  4. 部署模式：软件的部署模式。

  5. 告警策略：该实例下创建的告警策略的数量。

  6. 查看：点击【查看】，可以查看当前实例的监控详情、告警策略以及告警事件。

实例-实例列表

# 实例详情

在实例监控界面点击具体的实例名称或者【查看】进入具体的实例详情，包括监控图表、告警策略、告警事件。

# 实例监控图表

在实例监控界面点击具体的实例名称或者【查看】进入具体的实例，切换到"监控图表"页签，可以查看该实例的动态图表数据，可以根据不同的筛选条件查看实例不同的监控图表，描述如下图所示。

实例-监控图表

# 实例告警策略

在实例监控界面点击具体的实例名称或者告警策略数量进入具体的实例，切换到"告警策略"页签，可以对该实例进行添加管理告警策略，可以查看该实例的目前创建的告警策略，该位置维护该实例的告警策略，也可以在【配置】-【告警策略】下创建管理告警策略。描述如下图所示。

实例-告警策略

# 实例告警事件

在实例监控界面点击具体的实例名称或者【查看】进入具体的实例，切换到"告警事件"页签，可以查看该实例的目前所产生的告警事件信息，描述如下图所示。

实例-告警事件

# 告警策略

告警策略与实例关联，告警策略就是对实例指标的变化采取的措施的规则。针对不同的软件类型，可以选择不同的告警模板，进行批量的创建告警策略，展示所有告警策略的策略名称、关联对象、关联对象数、监控指标、触发条件、告警级别、启用禁用状态、创建时间等。用户可以统一、方便地管理和查看告警策略。

# 策略列表

入口：点击【运维观测->监控中心】左侧菜单【配置->告警策略】,进入告警策略管理页，可查看策略列表。

告警策略可以通过列表进行批量的启用、禁用和删除操作，并能根据告警策略名称查询相关的告警策略。还可以查看关联对象的实例名称。点击【策略名称】可以查看策略的详情。

告警策略

# 添加

点击【添加】按钮，进入新增告警策略页面，选择软件类型、关联对象，并可以根据需求选择模板导入或自定义来决定策略是模板中的还是手动创建，警策略启用禁用状态。

软件类型：选择软件的类型。

关联对象： 选择当前软件类型下的实例。

策略选择：模板导入，自定义两种，选择一种，选择模板导入，后续可以选择相应的告警模板，批量导入该告警模板的告警策略，只需要修改相应的报警条件，报警级别即可。若选择自定义，需要用户自己去添加相应的告警策略。

策略名称：告警策略的标识名称。

监控指标项：可从当前设施的监控项中选取。

报警触发条件：设置阈值，和监控项数据和阈值的对比公式，当达到公式条件时候，触发报警动作。

触发报警级别：警告，严重，灾难，选择其中一种。

添加告警策略

# 编辑

选中要操作的告警策略，点击【编辑】按钮，进入编辑告警策略界面，可修改是否启用策略、策略名称、监控项、触发条件、告警级别等内容，点击确认按钮，完成告警策略的编辑操作。

# 删除

选中要操作的告警策略，点击表格里的【删除】按钮，弹出"确定删除该告警策略吗？"提示弹窗，点击确认按钮，完成告警策略的删除操作。或者可以勾选左侧勾选框，批量选中要删除的策略，点击左上方的【删除】按钮，完成批量删除操作。

删除告警策略

# 启用禁用

选中要操作的告警策略，点击表格里的【启用/禁用】按钮，弹出"确定启用/禁用该告警策略吗？"提示弹窗，点击确认按钮，完成告警策略的启用禁用操作。或者可以勾选左侧勾选框，批量选中要启用/禁用的策略，点击左上方的【启用/禁用】按钮，完成批量启用/禁用。

启用/禁用告警策略

# 查看

选中要操作的告警策略，点击策略名称，即可进入告警策略详情页面。

告警策略详情

# 告警模板

告警模板是针对软件类型监控资源所设置的告警模板，ACP 中间件云平台中对标准监控模板内置了相应的告警模板，提供了对应的一些告警策略，用户在定义告警策略时可以根据特定的告警模板批量的创建告警策略。告警模板包括内置告警模板，自定义告警模板。

# 告警模板筛选

入口：点击【运维观测->监控中心】左侧菜单【配置->告警模板】，可以看到左侧的软件分类和右侧的模板列表，点击任何一个软件分类，都能筛选出当前软件类型对应的告警模板。

告警模板列表

# 创建告警模板

点击【创建告警模板】按钮，进入新增告警模板页面，用户可以根据自己的需求，添加相应的自定义告警模板。

名称：告警模板名称。

从现有模板导入：若选择从现有模板，后续可以对原有的告警模板中的策略修改，最终创建新的告警模板。若不选择从现有模板导入，后续需要自己添加相应的告警策略。

默认告警模板：若选择从现有模板导入，则需要选择默认告警模板。

策略名称：告警策略的标识名称。

监控指标项：可从当前设施的监控项中选取。

报警触发条件：设置阈值，和监控项数据和阈值的对比公式，当达到公式条件时候，触发报警动作。

触发报警级别：警告，严重，灾难，选择其中一种。

创建告警模板

# 编辑

选中要操作的自定义告警模板（内置模板不可编辑），点击【编辑】按钮，进入编辑告警模板界面，可修改模板名称、策略名称、监控项、触发条件、告警级别等内容，点击确认按钮，完成告警模板的编辑操作。

# 删除

选中要操作的自定义告警模板（内置模板不可删除），点击【删除】按钮，弹出"确定删除改模板吗？"提示弹窗，点击确认按钮，完成告警模板的删除操作。或者可以勾选左侧勾选框，批量选中要删除的策略，点击左上方的【删除】按钮，完成批量删除操作。

删除告警模板

# 查看

点击卡片上的【查看详情】进入告警模板详情，可以看到告警模板的基本信息以及该模板下的告警策略。

告警模板详情

# 告警中心

# 概览

  1. 展示历史原始告警数量，压缩率，智能告警事件数量。
  2. 展示告警数量 Top3 的告警应用，点击告警应用可以查看下面最新产生的三条告警事件。

image-20210902172230428

# 待关闭告警总览

  1. 按照告警级别展示待处理和处理中的告警数量以及等级占比情况。
  2. 外环显示告警处理状态的占比情况，内环显示告警状态的占比情况。

image-20210902173052762

# 告警处理数据

  1. 展示过去 7 天内日新增告警数，每日关闭告警数，每日剩余未关闭告警数。

image-20210902173145877

# 告警数量 Top5 应用

  1. 展示告警数量排名前 5 的监控应用。
  2. 可筛选时间过去 7 天，过去 15 天，过去 30 天。

image-20210902172303414

# 各系统告警总览

  1. 展示各监控系统告警数据情况，可按照自定义选择时间段。
  2. 可筛选时间过去 7 天，过去 15 天，过去 30 天。

image-20210902172420965

# 事件

通过系统集成，各监控系统产生的原始告警信息，会被接入到 AAlarm 平台，经过智能算法的去重，压缩，降噪等处理成代表某一类问题的告警事件。

# 告警事件等级

AAlarm 将告警事件分为四种等级，分别为：提示、警告、严重、灾难，各监控系统集成过来的告警信息将会被映射到这四个等级（映射规则请查看告警集成中对应部分）。

# 告警事件状态

  • 待处理：告警事件产生时最初的状态，事件状态为 '待处理' 时，如果有新的告警信息被推送到 AAlarm 平台，通过算法的处理被判定与当前告警事件相同/相关，将会被收敛到该告警事件下，不会产生新的告警事件，可以在告警事件详情查看被收敛的告警信息。
  • 处理中：告警事件被认领后，状态由 '待处理' 变为 '处理中'，已经被认领的事件将不会再触发通知，事件认领后将在工单系统生成一个工单。
  • 已完成：告警事件被处理完成。

提示：关闭告警事件的两种方式：

  1. 直接在页面点击【关闭】。

image-20210907151021594

  1. 对应的工单处理完成。

image-20210907152102914

# 告警事件处理流程

  1. 事件产生

    集成的告警系统所产生的告警信息将被推送至 AAlarm，经 AAlarm 处理后形成告警事件。

  1. 事件通知

① 通知对象，通过设置的分派策略将告警事件通知给相应的对象，对象包括：

  • 人：可以选择系统用户作为通知对象。
  • 组：将通知对象设置为组，告警事件产生后将通知到组内的所有成员。
  • 智能排班：根据各时间段的排班情况，将告警信息通知给对应的值班人员。

image-20210907153457081

② 支持升级通知和轮询通知，在告警事件 '待认领' 的状态下，会根据设置的升级通知和轮询通知规则进行通知。

升级通知：在设置的升级通知时间内，告警事件无人认领则自动升级到下一级别通知，最多支持设置三级通知。

轮询通知：开启轮询通知后，可以设置轮询时间和轮询次数。

案例：升级通知为 2 级，间隔时间为 5min，轮询时间为 10min，轮询次数为 3 次，当告警事件产生后根据通知策略进行第一级通知，5min 后无人认领则进行第二级通知，再过 10min 后无人认领，则重新开始第一级通知，如此轮询 3 次，3 次轮询结束后仍然无人认领，则不再通知。

③ 通知渠道，目前支持短信、邮件、钉钉、企业微信、云之家、webhook 等多种通知类型。

提示：关闭告警通知的两种方式：

  1. 通知策略中设置。
  2. 告警事件列表和详情页面可以关闭当前告警的通知。
  1. 事件处理

运维人员接收到告警事件通知之后，可以登录到 AAlarm 系统进入告警事件管理页面查看具体的告警内容，可以选择 ' 认领' 或者直接 '关闭' 告警。

  • 认领：认领成功后，将会在工单系统生成一个工单，并且自动将工单分派给当前认领的用户，当工单状态。

  • 关闭：'待处理' 的告警事件可以直接告警列表页操作 '关闭'，关闭时需要选择反馈信息。

# 收敛规则

每个监控应用对应一套收敛规则，收敛规则中分为过滤、去重、抑制三个维度进行告警信息的压缩。

  • 过滤

    将符合条件的告警直接过滤。

  • 去重

    一段时间内，符合条件被认定为重复告警，重复告警进行过滤。

  • 抑制

    **抑制目标：**需要抑制的对象。

    **抑制源：**抑制后的对象。

    **约束条件：**约束条件值相同时进行抑制，比如约束条件设置为 “告警等级”，则告警等级相同时才会按照规则进行抑制。

image-20220829110017371

# 通知

# 通知策略

AAlarm 支持自定义通知策略，通过通知策略设置可以实现告警事件的自动分发，用户以实际情况设置通知方式，通知渠道等，确保及时接收到告警通知。通知策略的设置主要包含以下几个部分：

  1. 事件源

    选择需要接收的告警监控应用。

  1. 告警状态

  • 告警产生：设置成功后在告警事件产生的时将会发送通知。

  • 告警恢复：设置成功后在告警事件处理完成，状态变为 '已关闭' 的时候发送通知。

  1. 告警级别

提供四个级别，提示、警告、严重、灾难，选择相应的级别表示出现该级别的告警事件时发送通知。

各监控应用自身的级别将会映射为这四个级别，具体映射规则如下：

AAlarm 告警级别 Apusic AMP Apuic AILP Apusic APM Prometheus Zabbix
提示 未知，正常 1、2 not_classified、information
警告 警告 WARNING WARNING 3 warning、average
严重 严重 4 high
灾难 灾难 5 disaster

注意：如果监控应用级别未知或者为空将会转换成级别 '警告'

  1. 通知对象

通知对象可选择人、通知组、排班计划，同一级别的通知策略要么选择人/组，要么选择排班计划；不同级别的通知策略中可以混选。

  1. 通知方式
  • 短信：先集成短信 SMS 服务，通过集成的短信 SMS 服务，将告警事件通过短信的方式发送到通知人账号绑定的手机号上。
  • 邮件：先集成邮件服务，通过集成的邮件服务，将告警事件发送到通知人账号绑定的邮箱上。
  • 协作方式：协作方式是通过群机器人的方式，将告警信息通知到群组，AAlarm 支持钉钉、企业微信、蓝信、云之家 4 种协作方式，选择协作方式之前先集成相应的通知服务。
  • webhook：先集成 webhook 服务，通过集成的 webhook 地址进行通知。

注意：如果配置了多个短信 SMS 服务并且都是 '启用' 状态则会收到多条通知短信。

  1. 轮询策略

开启轮询通知后，可以设置轮询时间和轮询次数。

  1. 通知时间

  • 任意时间：7*24 小时全天通知。

  • 指定时段：可以根据星期，时间段来设置通知时间，只有在设置的时段产生的告警事件才会触发通知。

image-20210918100643363

# 通知对象

对成员进行分组管理，在进行通知策略设置时，可以直接选择通知组，则组里所有成员将会接收到告警通知。

  1. 进入 '通知' -> '通知对象' 模块，页面默认按照创建时间降序排列，点击 '新建通知组'。

  2. 填写基本信息，选择通知组成员（通知组成员在系统用户中选择，如果成员未在系统用户中，可以在平台添加用户）。

image-20210918100705747

# 智能排班

使用智能排班可以根据值班情况设置值班人员，告警事件产生时根据值班情况，自动通知到相应的值班人员，支持创建多个排班计划，排班日历可按照 '计划/人员' 两种方式筛选查看。

image-20210918101310500

每个排班计划包含以下内容：

  1. 排班状态
  • 启用：正常使用。
  • 禁用：关联了通知策略的排班不可以被禁用，被禁用的排班也不可以被选择为通知对象。
  • 失效：过了生效日期的排班计划。

image-20210918101710303

  1. 班次

    为了排班更加灵活，每个排班计划下可以创建多个班次（举例：排班计划相当于公交线路，班次相当于该线路下不同时段的发车班次）。一个排班计划中最多可设置 5 个班次。

    image-20210918101755644

  2. 值班人员

    在系统用户中选择，值班人员设置时排序位置是有作用的，在排班时会根据排班周期按顺序安排值班人员，支持拖动成员改变排序。

    image-20210918101922024

  3. 排班周期

    • 周：按周循环排班。
    • 月：按月循环排班。

    image-20210918101901787

  4. 排班时间

    按照星期和时段选择。

image-20210918102001131

  1. 生效时间

    可以设置开始时间和结束时间，最长可以设置 180 天。

image-20210918102020828

  1. 修改单个排班

    点击排班日历中某个排班可以修改单个排班计划。

image-20210918101426179

# 集成

# 监控系统

主要提供监控数据的整合。针对不同的监控系统，不同数据源，实现多种数据结构的标准化存储。

在 AAlarm 中集成模块，找到 '系统集成' 菜单，可以创建监控应用，目前提供两种集成模式：

  • 通过 webhook 集成：Apusic AMP、Apusic AILP、Apusic APM、Prometheus 可以通过 webhook 将告警信息对接到 AAlarm 平台。
  • 通过 Agent 集成：Zabbix 集成需要通过安装 Agent 探针，通过探针将告警信息对接到 AAlarm 平台。

同一监控系统下支持创建多个监控应用。

# Apusic 基础设施监控

Apusic AMP 是金蝶 Apusic 运维平台下基础设施监控系统，可实现对主机、网络、存储、数据库、中间件、容器云等基础设施和业务应用系统进行全栈监控。通过集成 Apusic AMP 可以将基础设施相关的告警信息推送到 AAlarm。

  1. 创建监控应用：在 AAlarm 系统集成页面创建一个 Apusic 基础设施监控的监控应用，获取唯一 appkey。

  2. 配置接口回调地址：进入 Apusic 基础设施监控系统，配置如下 HTTP 接口回调地址。

    {AAlarm 域名}/api/{appkey}/events
    1

    image-20210819170244511

  3. 设置报警策略：在 Apusic 基础设施监控系统对应的报警策略中勾选 ‘ HTTP 接口回调 ’。

image-20210819170220994

# Apusic 日志监控

Apusic AILP 是金蝶 Apusic 运维平台下的日志监控系统，提供一站式日志数据采集、清洗、结构化处理、大规模集中存储、可视化图表等功能。通过集成 Apusic AILP 可以将日志信息推送到 AAlarm。

  1. 找到 Apusic 日志监控项目中，config/application.properties 文件，新增 webhooks 配置如下：

    aops.notice.enable=true
aops.notice.webhook={AAlarm 域名}/api/{appkey}/events
    1
    2

image-20210918100434849

# Apusic 应用性能监控

Apusic APM 是金蝶 Apusic 运维平台下的应用性能管理系统，实现对数据中心、云计算以及容器云等环境中各类单体架构应用、分布式应用以及微服务架构应用进行非侵入式的实时监控获取服务端新能数据。通过集成 Apusic APM 可以将应用性能相关数据推送到 AAlarm。

  1. 找到 Apusic 应用性能监控项目中 config/alarm-settings.yml 文件，修改 webhooks 配置如下：
webhooks:
- {AAlarm 域名}/api/{APPkey}/events
1
2

image-20210918100529959

# Apusic 智能运维
  1. 进入 Apusic 智能运维平台，配置 HTTP 接口回调地址，如下：

# Zabbix

  1. 下载 Apusic Alarm 脚本。

  2. 在 zabbix 的 alertscripts 目录下解压脚本。

  3. 在解压出的脚本中找到 alert.sh 文件，修改 DC_URL 配置信息，如下：

    DC_URL = "{AAlarm 域名}/api/{APPkey}/events"
    1

  4. 执行安装。

    install.sh {APPkey}
    1

image-20210918100516348

# Prometheus

  1. 修改 Prometheus 中插件 alertmanager 的配置文件（请确保已经安装 alertmanager 插件），编辑 alertmanager.yml ，修改 webhooks 配置如下：

    webhook_configs:
- url: ‘{AAlarm 域名}/api/{APPkey}/events’
    1
    2

    image-20210918100606566

# 通知渠道

# 短信
# 阿里云 SMS
  1. 在阿里云 SMS 平台创建好短信模板，签名。
  2. 在 AAlarm 通知服务模块 > 短信 > 阿里云 SMS 下创建一个服务实例。
# 腾讯云 SMS
  1. 在腾讯云 SMS 平台创建好短信模板，签名。
  2. 在 AAlarm 通知服务模块 > 短信 > 腾讯云 SMS 下创建一个服务实例。
# 金蝶云 SMS
  1. 在金蝶云 SMS 平台创建好短信模板，签名。
  2. 在 AAlarm 通知服务模块 > 短信 > 金蝶云 SMS 下创建一个服务实例。
# 华为云 SMS
  1. 在腾讯云 SMS 平台创建好短信模板，签名。
  2. 在 AAlarm 通知服务模块 > 短信 > 腾讯云 SMS 下创建一个服务实例。

短信模板格式建议：

  • 告警产生：您的监控对象{object}出现{level}等级的告警事件${Id}，异常内容为{content}，来自：{system}，请及时处理！
  • 告警恢复：您的监控对象{object}出现{level}等级的告警事件${Id}已经恢复。

注意：短信模板中 {} 中的内容按照参考格式中填写，其它内容可自定义

# 协作
# 钉钉

  1. 在钉钉群组里创建一个机器人，配置机器人信息。

  2. 在 AAlarm 通知服务模块 > 协作 > 钉钉 下创建一个服务实例，配置 Webhook 地址。

image-20210918100957508

# 企业微信

  1. 在企业微信群组里创建一个机器人，配置机器人信息。

  2. 在 AAlarm 通知服务模块 > 协作 > 企业微信 下创建一个服务实例，配置 Webhook 地址。

image-20210918101019493

# 云之家

  1. 在云之家群组里创建一个机器人，配置机器人信息。

  2. 在 AAlarm 通知服务模块 > 协作 > 云之家 下创建一个服务实例，配置 Webhook 地址。

image-20210918101039534

# 蓝信

  1. 在蓝信创建一个群组。

  2. 在 AAlarm 通知服务模块 > 协作 > 蓝信 下创建一个服务实例，配置基本信息。

    • 服务器地址：蓝信所在的服务器地址。
    • 蓝信版本：6.0 or 6.0 以下。
    • AppID：蓝信 APPID。
    • AppSecret：蓝信 AppSecret。
    • 群组 ID：接收告警信息的群组 ID。

    image-20210918101102773

# 邮件
  1. 在 AAlarm 通知服务模块 > 邮件下创建一个邮件服务实例，配置基本信息。

image-20210918101126964

# webhook
  1. 在 AAlarm 通知服务模块 > webhook 下创建一个 webhook 服务实例，配置基本信息。

image-20210918101204377

在集成各项服务时，填写完成后可以点击 '发送测试告警'，可以根据配置信息将告警发送对应对象，短信将会发送给当前登录用户的手机号上，邮件将会发送到当前登录用户的邮箱上，协作将会发送到配置的群组中，webhook 将会发送到配置的 webhook 地址中。

# 日志中心

# 概要

智能日志概要数字展示接入主机、接入应用，接入日志类型数量，图表展示主机日志事件和应用事件记录数。（如图所示） image4 图 4- 1 概要

# 仪表盘

  1. 仪表盘通过可视化配置的方式，让用户能够根据不同场景的需求自定义日志分析。天燕智能日志平台支持图形面板、数字面板以及表格面板。其中图形面板包括区域图、柱状图、折线图以及饼图。通过组合不同的面板来完成复杂得报表呈现，支持根据设定的时间范围查询统计数据，可以通过设置自动更新动态更新面板数据，同时面板还支持拖拽缩放等功能。

图 4- 2 仪表盘

  1. 该页为仪表盘列表页，用户可以在该页面通过点击最右侧空白仪表盘创建新仪表盘。当鼠标悬停在仪表盘上时，出现编辑和删除操作的按钮，用户可以通过点击编辑按钮对仪表盘名称进行修改，修改窗口如下图，或者对仪表盘进行删除操作。

图 4- 3 仪表盘

新增面板

  1. 点击进入仪表盘详情页，此处展示用户自定义的面板。左上角显示仪表盘名称，右上角第一个下拉选择框可选择面板数据的统计时间，第二个下拉选择框可以设置自动更新的周期时长，默认为关闭自动更新，返回按钮返回仪表盘列表。右下角点击按钮展开新增面板，依次为区域图、柱状图、折线图、饼图、表格面板以及数字面板。 图 4- 4 图表

  2. 选择一种面板类型，进入面板设置页面。

  3. 上方为图形预览部分，中间为面板配置项。

  • 区域图、柱状图、折线图、饼图。

如：选择数据源 kdcloud-apigwsuccess-kdcloud_nginx-* 作为索引，Y 轴配置中，过滤条件为空，度量维度选择统计@timestamp 的总数。通过 Y 轴配置右侧的按钮动态增删度量维度。X 轴配置中，选择 Data Histogram 分组方式，统计字段为@timestamp，X 轴统计间隔为 5 分钟。

图 4- 5 数据源

面板编辑页签中选择柱状图为该图表图表展现形式，设置面板标题为访问事务数。

图 4- 6 面板编辑

时间过滤页签选择今天作为统计的范围。

图 4- 7 时间过滤

  • 表格面板

表格面板中对用户自定义的字段进行统计，用户通过多选下拉列表选择数据。并可通过点击右侧删除图标删除已选字段。

图 4- 8 表格面板 1

根据所选字段统计数据，支持翻页功能。

图 4- 9 表格面板 2

  • 数字面板

选择索引，过滤条件为空，统计字段为 apusic.hostname，数字下标文案为台。

如下图：主机数为面板标题，3 为统计所得数据，台为用户填入的数字下标文案。

3、点击页面右下方进行预览或者保存调整到面板列表页。

面板操作

用户能够根据自己的需要移动缩放面板，单个面板具备编辑、复制以及删除的操作。拖住面板任意位置进行移动可以改变面板位置，拖住右下角可以对面板进行缩放，面板中图例会根据面板大小自适应。图形面板可以动态增删图例、表格面板可以进行翻页操作。

图 4- 10 面板操作 1

点击复制面板，如下图所示。

图 4- 11 面板操作 2

# 配置

# 日志配置

日志配置是使用 Apusic 智能日志平台的第一步。在"设置"菜单中点击"日志配置"，即可进入日志配置的引导页面。

  • 服务器操作系统

首先选择需要上传日志的服务器操作系统，目前支持 ubuntu 和 redhat 等 Linux 系统。（如图所示）

图 4- 12 选择服务器系统

  • 配置日志文件

配置日志文件需要输入：日志文件绝对路径、应用名和应用标签，同时需要指定日志的解析规则。天燕智能日志平台内置了 Mysql Log、Zookeeper Log 等常见日志文件的解析规则。如果用户日志比较特殊，则可以使用自定义的解析规则。如何自定义解析规则，用户可参看下一章节内容。（如图所示）

日志配置

图 4- 13 配置日志文件

  • 执行配置脚本

配置日志文件完成以后，只需要在目标服务器执行相应 shell 脚本，即可完成整个日志采集配置过程。

日志配置2

图 4- 14 执行配置脚本

# 解析规则

用户上传的原生日志是一种半结构化数据，一般按行分为不同的记录，每条记录则根据日志类型的不同，可以拆分成不同的字段。解析日志就是按照预先定义的解析规则将非结构化的日志数据变成结构化的数据。

  • 官方解析规则

AILP 智能日志平台提供了常用的官方日志解析规则，例如 Zookeeper_log、mysql_log、redis-log、keepalived_log、lvs_log、mysql_audit_log、nginx_error_log、json_log。

  • 自定义解析规则

AILP 智能日志平台提供了常用的日志解析规则，能够识别和解析常见的日志格式。对于不支持的日志格式，用户可以自定义解析规则。

图 4- 15 解析规则

自定义解析规则首先需要填写一段日志样例，再选择一种解析器，智能日志提供多种解析器，用户选择一项解析后，填写相应规则，再根据字段进行细粒度地拆分。创建过程如下：

1、添加一段日志样例，并选一种解析器。目前智能日志提供的解析器有四种：

  • 正则解析。

  • JSON 解析。

  • 数值型字段转换。

  • 时间戳识别等。

图 4- 16 正则解析

2、示例中选择正则解析，填写解析规则。

图 4- 17 填写解析规则

3、在上面窗口中点击"确定"，日志样例将进行日志解析，解析为结构化的数据。

图 4- 18 编辑解析 1

4、默认正则解析的字段类型为字符型，所以可以更细粒度的定义字段类型。

图 4- 19 编辑解析 2

图 4- 20 编辑解析 3

5、最后保存规则。

图 4- 21 保存规则

# 数据源管理

数据源是按照 ElasticSearch 中的索引来划分的，每个索引对应一个数据源。显示的信息包括：索引名，来源，分组，接入主机，日志文件名，解析规则，应用名，上传日志总数，最后上传时间。

数据源管理并且提供了数据源的删除、暂停和启动操作。

数据源列表

图 4- 22 数据源列表

# 日志分析

日志分析功能分为两部分，包括你日志搜索，以及根据搜索结果进行统计分析。

日志分析-总

图 4- 23 日志分析

  • 日志搜索

日志搜索提供了功能强大、简单易用的方式来检索日志，可以快速过滤并找到相关的结果。

搜索条件包括：

1、日志分组：选择日志分组，进行筛选日志数据源。

2、数据源：选择数据源对应的索引名称。

3、搜索条件：在搜索框中输入搜索语句。搜索语句支持 Lucene 语法对日志进行实时搜索。

4、时间范围：快速选择时间或者自定义时间区间。

日志分析-图表

图 4- 23 统计图

点击"搜索"后，会展示根据搜索条件过滤后事件统计图。如下：

表格字段过滤：在页面左侧的字段列表中，可以过滤表格中显示的字段值。默认显示@timestamp、host.name、message 这三个字段值。

需要选择其他字段在未选字段列表中点击"+"进行添加字段，同样，在已选字段列表中也可以点击"-"进行删除字段。

搜索过滤字段

图 4- 24 过滤字段

  • 统计分析

统计分析是针对搜索结果创建不同展示方式的统计图表，目前支持的统计图有：事件统计，时间分段，数值分段，字段值分类等。

  • 事件计数

事件计数是在当前搜索结果中针对不同的字段值进行事件数量的统计，包括总数量（相当于 SQL 语句中的 count），和独立值数量（相当于 SQL 语句中的 count distinct）。通过事件计数的统计分析，可以探索不同字段的事件数的分布情况。

图 4- 25 事件计数

  • 时间分段

时间分段是自定义不同的区间对事件进行统计分析，并且支持总计（sum），最大值(max)，最小值(min) 和平均值(avg)统计。时间区间维度可以任意指定，统计字段则只支持数值型，不支持字符型。

图 4- 26 时间分段

  • 数值分段

数值分段和时间分段类似，不同的是分段维度。前者是根据数值来分段，后者是根据时间来分段。

图 4- 27 数值分段

  • 字段值分类

字段值分类对于分析字段的具体值分布的情况非常有用。可以指定任意字段，将 TOPN 的值得数量以直方图的形式展示出来。

字段分类图-top10

图 4- 28 字段值分类

# 实时跟踪

实时跟踪是用户可以根据数据源、主机名进行筛选查看实时日志。功能类似于在服务器上对日志执行 tail -f filename.log，现在通过浏览器也可以达到同样的效果。

实时跟踪图

图 4- 29 实时跟踪

# 监控

# 告警规则

目前智能日志的告警规则类型分为事件数监控、字段统计监控和连续统计监控三种。

  • 添加监控
  1. 事件数监控：在给定的时间范围内搜索结果的总数达到阈值，则触发告警。如：在 2 分钟内，搜索条件为"ERROR"的日志出现次数超过 10 次，触发告警。

搜索条件遵循 lucense 语法，搜索条件条件为"ERROR"的意思是判断采集到的日志出现 ERROR 的日志信息。搜索条件也可以为"loglevel:ERROR",其中 loglevel 是采集到的日志信息根据解析规则解析出的日志级别字段，搜索该字段出现"ERROR"的次数。这种搜索条件依赖日志的解析规则，需要根据根据具体的解析字段进行设置。

告警规则-事件数

2、字段统计监控：在触发条件中填写你需要监测的字段，当该字段在一段时间出现的次数达到阈值，则出发告警。如：在 5 分钟内，字段 timetaken（响应时间）的平均值超过 200 时，触发告警。

3、连续统计监控：当触发条件中需要监测的字段，在某个时间内连续出现次数达到阈值，则触发告警。

如：在 5 分钟内，字段 timetaken（响应时间）的值超过 200 的次数超过 5 次时，触发告警。

智能日志平台支持针对搜索条件触发式的监控告警，告警条件触发以后，可以通过企业微信发送给预先设置的告警接收人。

图 4- 30 告警规则

# 告警历史

告警历史展示告警趋势图及系统触发告警的列表。

图 4- 31 告警历史

告警趋势图可以查当天，本周，本月的告警情况。

图 4- 32 告警趋势

具体的告警详情可以查看列表。

# 企业微信

智能日志支持使用企业微信发送告警信息。用户需要先前往企业微信注册账号。

注册完成后，用户需要使用 AgentId 、 Corpid 等信息在智能日志中完成企业微信的配置。点击"编译"按钮。

图 4- 33 企业微信

填写对应信息，点击"保存"，企业微信配置成功。

用户可以在企业微信中维护成员信息。企业微信的使用请参考腾讯的帮助文档。

# K8s 日志采集说明

# K8s 日志说明

智能日志支持 k8s（Kubernetes）环境下日志数据的采集，分析，展现。对于 k8s 环境中应用日志的采集说明如下。

使用 filebeat 采集 k8s 环境下应用日志，通过 daemonset 的方式，在集群中的每个节点上运行一个采集节点，采集位于/var/log/containers/*.log 下 k8s 的日志，最后将 k8s 环境下的日志信息采集到日志系统中。

采集 k8s 环境下采集日志前置条件：

  • 需要用户先安装 k8s 集群环境，docker 工具等。

  • K8s 环境下 pod 日志需要标准输出容器终端。

# 产品介质说明

1.k8 日志采集相关安装介质。

解压安装完成日志服务后，从 cloudlog/public/k8sfilebeatimages 路径下如下获取安装包，路径中 cloudlog 即是日志服务安装包解压后的目录。

  • amp-cloudlog-k8s-filebeat.tar.gz

安装 k8s 应用日志采集的产品介质包。

2.amp-cloudlog-k8s-filebeat.tar.gz 产品安装包解压后，可以看到下面几个具体的安装包文件：

文件名 | 说明 apusic-filebeat-amd64.tar | Filebeat 的 amd64（x86_64）产品镜像包。 apusic-filebeat-arm64.tar | Filebeat 的 arm64（aarch64）产品镜像包。 K8s-daemonset-filebeat.yml | Filebeat 镜像的启动配置文件。 addK8sDataSource.sh | 添加注册 k8s 数据源的脚本文件。

# 安装 K8s 日志采集组件
# 加载 filebeat 镜像

1.上传 k8s 日志采集组件安装包到服务器，进行解压安装包。

解压产品安装包后，得到 amd64 和 arm64 版本的 filebeat 的安装镜像，安装配置文件，添加注册数据源脚本文件。

2.加载镜像。

根据具体的环境加载对应的镜像，这里使用 arm64 环境下镜像进行说明。

成功加载镜像后，查看镜像，可以看到该镜像的具体内容如下。

如果用户的 k8s 环境存在 dockerhub 镜像仓库,可以将该镜像上传到镜像仓库，方便 k8s 集群中其他 node 节点直接使用。否则需要手动将该镜像上传到其他节点，再进行加载该镜像。

# 安装运行 filebeat
  • 修改 filebeat 配置文件

获取产品包解压后的 amp-cloudlog-k8s-filebeat.tar.gz 的配置文件 K8s-daemonset-filebeat.yml，修改相应的内容。

1)修改日志数据索引名称 apusic.type,如果只存有一个集群可以使用默认值不进行修改，如果多次添加时，需要进行修改。

apusic.type 的组成由用户名（logdata），应用名 apusic.appname（k8slog）,解析规则（system_json_log）,创建时间 apusic.createtime(创建时间可以根据添加时的年月日时分秒时间手动替换),使用连接符拼（-）接而成，如果进行修改需要保持一致。如果进行多次添加时，需要同时进行修改 apusic.appname，及 apusic.type 中的 appname，保证应用名不重复。

2)修改 kafka 服务器的访问地址。

此处 kafka 的地址即是 cloudlog 配置文件 application.properties 中的 kafka 地址。

修改 kafka 服务的实际访问地址 output.kafka 下的 hosts,如果是一个 kafka 节点，格式如下：

hosts: ["172.20.140.93:9092"]。

如果是 kafka 集群多个节点，修改格式如下：

hosts: ["172.20.140.93:9092","172.20.140.94:9092","172.20.140.95:9092"]。

1.修改镜像文件版本。

默认使用 arm64(aarch64)版本的镜像，如果服务器是该种环境，则不需要修改，可以跳过该步骤。

如果用户服务器是 amd64(x86_64)环境，需要修改镜像的版本。

修改 spec.containers.image 的值为：apusic.net/filebeat-amd64:5.5.0。

  • 运行 filebeat

进入 k8s 集群环境中，在服务器执行下列操作，运行 filebeat 容器服务。

执行上面命令后，filebeat 会以 daemonset 的方式在 k8s 集群中的每个节点运行一个 pod 服务，每个 pod 运行一个 filebeat 容器，从而进行采集日志到日志系统。

此时执行命令 kubectl get pods，进行查看 filebeat 的 pod 节点，此时该节点可能处于 ContainerCreating 状态，这是正常情况，因为资源需要进行调度，需要花费时间，几分钟后进行查看，可以看到运行 filebeat 容器的 pod 节点正常运行。

# 注册添加 k8s 日志数据源

添加注册数据源到智能日志服务系统中，智能日志系统进行日志的查询，分析操作。

获取产品包解压后的 amp-cloudlog-k8s-filebeat.tar.gz 的脚本文件 addK8sDataSource.sh，修改相应的内容。

  • 修改注册数据源脚本

1.修改日志服务地址 CLOUDLOG_SERVER 为实际的服务地址。

2.如果 5.3.2.1 下的 apusic.type 如果没有进行修改，则跳过。否则，需要根据上一步进行修改下面配置文件中的 APP_NAME 等。此处的创建时间 CREATE_TIME 需要与上一步配置文件中的保持一致。

  • 执行脚本文件

执行脚本文件，进行注册添加数据源到智能日志系统。

如果文件没有可执行权限，执行下面命令，给该文件赋予可执行权限。

如果注册数据源成功，结果如下所示。

如果注册数据源失败，需要根据出错信息进行修改。

判断上一步 5.3.2.1 中配置信息是否与脚本中的参数对应一致。

执行成功后，可以看到日志服务的数据源管理界面已经存在 k8s 日志的数据源记录。

后续可以进行日志的查看，分析操作。

# 停止卸载 K8s 日志采集组件

停止 k8s 中 filebeat 日志采集组件采集日志信息。

  • 进入到启动 filebeat 容器的配置文件 K8s-daemonset-filebeat.yml 的所在目录。

  • 执行下列命令。

此时执行命令 kubectl get pods，进行查看 filebeat 的 pod 节点，此时该节点可能处于 Terminating 状态，这是正常情况，因为删除该节点需要对资源做一些处理，需要花费时间，几分钟后进行查看，可以看到运行 filebeat 的 pod 节点成功删除。

  • 删除数据源。

进入到日志服务的数据源管理界面，找到采集 k8s 应用日志的记录，点击该条记录后的"删除"按钮进行删除该数据源。

# 工单系统

工单管理系统对 ACP 的运维管理员和运维人员开放，主要是处理用户和系统生成的工单，获取工单的统计概览信息。

# 工单概览和统计

工单概览统计显示当前平台的所有工单的统计信息，如全部工单数、已处理工单数、当前未处理工单数、平均工单响应时间、平均工单处理时间等。工程师工单统计可以直观显示某个工程师的具体工单处理情况。只有运维管理员才有权限查看工单概览和工程师工单统计。

# 工程师工单统计

# 工单中心

工单中心是整个工单管理系统的工单调度中心。工单中心可以查询平台上所有工单的信息。运维人员在工单中心可以进行指派、接受工单操作，进行工单的分发，指定具体的工单处理人。

# SLA 服务水平

Sla 服务水平菜单界面主要是一段时间内未受理的工单的快捷入口。运维人员可以方便的查看到超过 24h 和 48h 还没被受理的工单，提醒运维人员尽快对长时间未受理的工单进行响应，提升用户体验。

# 我的工单

我的工单是运维人员需要处理的工单的展示页面，只能查看到当前登陆用户作为工单处理人的工单，分为未解决和已解决工单。未解决工单包括已受理、处理中的工单，已解决工单则是运维人员标记已解决、已关闭的工单。

# 工单详情

工单详情页面展示工单的详细信息，在工单的查询列表中点击查看详情即可进入到工单详情页面。在工单详情页中，运维人员和工单用户都可以通过发送留言随时进行沟通交流，工单处理情况则实时显示工单的当前进度和历史处理信息。

# 消息中心

点击控制台顶部导航栏的“消息”，可进入消息中心模块。消息中心模块分为消息管理和通知管理两个部分。

# 消息管理

消息管理中包括全部消息、未读消息、已读消息三个子模块。用户可以通过页签切换、关键字搜索等方式，聚焦于自己关注的重点消息。

# 全部消息

在全部消息界面中，用户可以查看所有的消息（包括已读、未读）。 全部消息

# 未读消息

在全部消息界面中，用户可以查看所有未读消息。 未读消息

# 已读消息

在全部消息界面中，用户可以查看所有已读消息。 已读消息

# 通知管理

通知管理包括通知服务、消息接收配置、接收人管理三个子模块。

# 通知服务

通知服务添加表单： 通知服务添加表单 通知服务预览（卡片模式）： 通知服务-卡片 通知服务预览（表格模式）： 通知服务-卡片

# 消息接收配置

消息配置如下： 消息接受配置 通过“修改接收人”表单，可对接收人进行配置： 消息接受配置-修改接收人

# 接收人管理

在接收人管理界面，用户可通过接收人管理表单编辑或新增接收人信息。 接收人表单 在接收人管理界面，用户可通过接收人管理表格查看接收人信息。 接收人表格

# 平台管理

主要描述 ACP 的控制设置和访问管理。集成了用户管理、角色管理、审计日志的功能模块，是 ACP 平台的管理和控制中心，该功能只对平台管理员开放。

# 用户管理

用户是 ACP 的使用者的信息载体，一组账号密码等信息的集合。ACP 通过用户进行登录认证和权限分配等。

# 用户的创建和管理

用户包含有用户名、密码、姓名、手机、邮箱、描述等信息。ACP 平台使用用户的用户名和密码进行登录认证。在用户管理模块中可以对用户进行创建、编辑、查看、删除、启用禁用、分配角色等操作。

启用和禁用状态表示能够通过该用户登录 ACP，启用状态的用户可以登录到 ACP，禁用状态的用户则无法登录。启动和禁用状态可以进行切换。

分配角色代表将一个或多个角色分配给该用户，该用户自动具有该角色下所有权限。

# 角色管理

“角色”是用于权限控制功能的一个抽象概念，一个“角色”代表了一组权限的集合，不同的角色可能会包含不同的权限。ACP 平台通过给用户分配不同的角色，而角色又有不同的权限，从而实现用户的权限管理。

# 角色的创建和管理

角色包含角色名称、角色描述以及该角色拥有的权限项。在角色列表中可以对角色进行创建、编辑、查看、删除、分配权限等操作。

# 审计日志

ACP 提供审计日志功能用于还原出用户在平台中的行为，可用作事件发生后的回溯和定责。以帮助企业和组织在业务不断增长的同时保持安全与合规。

主要由以下 5 个部分组成，来记录操作人在什么时间操作了什么资源：

  1. 日志时间: 采取行动的时间。
  2. 用户名: 实施动作的人。
  3. 事件名称、资源：受影响的资源及具体操作的页面。
  4. IP 地址: 发起操作的 IP。
  5. 相关信息: 事件 ID 及备注信息。 可根据事件及用户名对审计日志进行查询，并可导出 Excel 表。

# 个人中心

登录用户可查看自己的信息，可修改自己的信息。包含基本设置、安全设置。

# 基本设置

主要展示当前登录用户的用户名、姓名、描述以及头像。可对用户姓名（除了 admin）、头像、描述进行修改。

入口：【个人中心->基本设置】。

# 安全设置

展示了当前账号的安全等级，以及可以对登陆密码进行修改、手机号码绑定与修改、邮箱绑定与修改等操作。

入口：【个人中心->安全设置】。

点击登陆密码后的【修改】按钮，可以修改都能录密码。

点击手机绑定后的【绑定】按钮，可以绑定手机号码，成功绑定手机号码后，也可以对手机号码进行修改。

点击邮箱绑定后的【绑定】按钮，可以绑定邮箱，成功绑定邮箱后，也可以对邮箱进行修改的。

# 附录

# 中间件默认定义

本章节描述中间件软件仓库中出厂的中间件标准定义说明。

# Apusic 应用服务器 V9

# 基本信息
项目 定义值 备注
软件目录 应用服务器
软件名称 AASV9
图标
软件描述 aasv9
# 版本与依赖
项目 定义值 备注
版本范围 V9~V9.x
版本描述
是否开启管控台 开启
配置信息 apusic.conf、license.xml
操控方式 定制脚本
安装位置 /opt/AASV9
安装依赖 jdk1.8、python2.7.5、端口 6888
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 aasv9
组件编码 aasv9
组件关联配置
日志位置 /opt/AASV9/domains/mydomain/logs/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 端口号 4 6888 是 6888
密码 password 密码 256 Apusic12345678 否 密码必须大于 8 位，包括大小写、数字
域路径 domainDir 文本 256 /opt/AASV9/domains/mydomain 是
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
多路复用端口号 port 端口号 4 6888 否 多路复用端口号；HTTP、JNDI、JMS 服务
是否启用 SSL 通讯 SSLEnabled 文本 10 FALSE 否 是否启用 SSL 通讯，True/False，设置为 True 表示开启 SSL 通讯，需要配置 SSL 通讯属性
SSL 通讯端口 SecurePort 端口号 4 6889 否 SSL 通讯所使用的端口
保存服务器密钥和证书的密钥 KeyStore 文本 255 config/sslserver 否 保存服务器密钥和证书的密钥库文件
KeyStore 密钥库的管理密码 KeyStorePassword 文本 255 否 KeyStore 密钥库的管理密码
KeyStore 密钥密码 KeyPassword 文本 255 否 KeyStore 密钥密码
最大线程数 MaxThreads 正整数 10 30 否 此属性决定自动调优线程池所能提供的最大线程数，-1 表示不限数量
最大队列数 MaxQueueSize 正整数 10 500 否 此属性决定等待获取线程队列的最大长度
最小备用线程数 MinSpareThreads 正整数 10 5 否 此属性决定自动调优线程池中的最小备用线程数
最大备用线程数 MaxSpareThreads 正整数 10 30 否 此属性决定自动调优线程池中的最大备用线程数
等待超时时间 IdleTimeout 正整数 10 300 否 等待超时时间，当线程池中的某个线程等待被使用的实际时间超过此属性数值时，线程池自动关闭此线程；单位秒
# 监控参数
项目 定义值 备注
监控模板 ApusicAS V9 Apusic 应用服务器 V9
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单机部署定义
项目 定义值 备注
部署名称 单机
部署编码 standlone
部署描述
节点数量 = 1
计算规格 2G、2 核、100G
包含组件 aasv9
  • 集群部署定义
项目 定义值 备注
部署名称
部署编码
部署描述
节点数量
计算规格
包含组件

# Apusic 应用服务器 V10

# 基本信息
项目 定义值 备注
软件目录 应用服务器
软件名称 AASV10
图标
软件描述 aasv10
# 版本与依赖
项目 定义值 备注
版本范围 AASV10~AASV10.x
版本描述
是否开启管控台 开启
配置信息 domain.xml、license.xml
操控方式 定制脚本
安装位置 /opt/AASV10
安装依赖 jdk1.8
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 AASV10
组件编码 AASV10
组件关联配置
日志位置 /opt/AASV10/ApusicAS/aas/domains/mydomain/logs/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 端口号 4 6888 是 6888
密码 password 密码 255 Apusic12345678 否 密码必须大于 8 位，包括大小写、数字
域名 domainName 文本 255 mydomain 是
域路径 domainDir 文本 1024 /opt/AASV10/ApusicAS/aas/domains 是
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
最大线程池大小 max-thread-pool-size 正整数 10 250 否 线程池 http-thread-pool 最大线程池大小
最小线程池大小 min-thread-pool-size 正整数 10 5 否 线程池 http-thread-pool 最小线程池大小
最大队列大小 max-queue-size 正整数 10 4096 否 在有线程可用来处理消息之前，可以排队的最大消息数。-1 值表示队列大小没有限制
空闲线程超时时间 idle-thread-timeout-seconds 正整数 10 900 否 从池中删除空闲线程之前经过的时间 (秒)
# 监控参数
项目 定义值 备注
监控模板 ApusicAS V10 Apusic 应用服务器 V10
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单机部署定义
项目 定义值 备注
部署名称 单机
部署编码 standlone
部署描述
节点数量 = 1
计算规格 2G、2 核、100G
包含组件 AASV10
  • 集群部署定义
项目 定义值 备注
部署名称
部署编码
部署描述
节点数量
计算规格
包含组件

# Apusic 分布式消息队列

# 基本信息
项目 定义值 备注
软件目录 消息中间件
软件名称 ADMQ
图标
软件描述 admq
# 版本与依赖
项目 定义值 备注
版本范围 2.1~2.X
版本描述
是否开启管控台 开启
配置信息 license.xml、zookeeper.conf、broker.conf、storage.conf
操控方式 定制脚本
安装位置 /opt/ADMQ
安装依赖 jdk1.8
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 zookeeper
组件编码 zookeeper
组件关联配置 license.xml、zookeeper.conf
日志位置 /opt/ADMQ/admq-V2.2.1/logs/
组件描述
项目 定义值 备注
组件名称 broker
组件编码 broker
组件关联配置 license.xml、broker.conf
日志位置 /opt/ADMQ/admq-V2.2.1/logs/
组件描述
项目 定义值 备注
组件名称 storage
组件编码 storage
组件关联配置 license.xml、broker.conf
日志位置 /opt/ADMQ/admq-V2.2.1/logs/
组件描述
项目 定义值 备注
组件名称 standalone
组件编码 standalone
组件关联配置 license.xml、zookeeper.conf
日志位置 /opt/ADMQ/admq-V2.2.1/logs/
组件描述 单机引擎
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 端口号 5 2181 是 客户端连接端口
管控台 manager_server 文本 256 否 管控台 ip
zk 选举端口 elect_port 正整数 5 2888 是
zk 数据同步端口 data_port 正整数 5 3888 是
管理端口 admin_port 正整数 5 9990 是
监控数据采集端口 monitorPport 正整数 5 18800 是
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 端口号 5 6650 是 数据传输端口
管理端口 admin_port 正整数 5 8080 否
第三方传输协议 messagingProtocols 文本 10 否 第三方传输协议适配（支持 kafka,mqtt,amqp,rocketmq
kafka 端口 kafka_port 端口号 5 9092 否
监控数据采集端口 monitorPport 正整数 5 18800 否
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 3181 是 数据传输端口
监控数据采集端口 monitorPport 正整数 5 8000 是
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 2181 是
主机服务 manager_server 文本 20 是
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 settingPort 文本 20 否
参数名称 参数代号 参数类型 长度 取值 必填项 描述
存储节点个数 managedLedgerDefaultEnsemb 正整数 10 2 否 存储节点个数
写入的存储节点个数 managedLedgerDefaultWriteQuo 正整数 10 2 否 每条消息需要写入的存储节点个数
等待写入节点个数 managedLedgerDefaultAckQuorum 正整数 10 1 否 需要等待多少个节点的写入确认
# 监控参数
项目 定义值 备注
监控模板 ZooKeeper ZooKeeper
采集器安装路径 /usr/local/exporter/
采集端口 9141
采集路径 /metrics
zk 地址 localhost:2181
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单机部署定义
项目 定义值 备注
部署名称 单机
部署编码 standlone
部署描述
节点数量 = 1
计算规格 2G、2 核、100G
包含组件 standalone 单机引擎
  • 集群部署定义
项目 定义值 备注
部署名称 集群
部署编码 cluster
部署描述
节点数量 = 3
计算规格 1G、1 核、100G
包含组件 zookeeper、broker、storage

# Apusic 分布式缓存

# 基本信息
项目 定义值 备注
软件目录 缓存
软件名称 AMDC
图标
软件描述 amdc
# 版本与依赖
项目 定义值 备注
版本范围 2.1~2.X
版本描述
是否开启管控台 关闭
配置信息 license.xml、conf.yaml、sentinel.yaml
操控方式 定制脚本
安装位置 /opt/AMDC
安装依赖
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 amdc-server
组件编码 amdc-server
组件关联配置
日志位置 amdc/
组件描述
项目 定义值 备注
组件名称 amdc-sentinel
组件编码 amdc-sentinel
组件关联配置
日志位置 amdc/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 端口号 5 6359 是 客户端连接端口
从节点个数 SLAVE_NUM 整数 5 0 是
密码 PASSWORD 密码 32 否
主节点 masterNode 文本描述 25 否
主节点密码 masterAuth 密码 255 否
监控端口 monitorport 端口号 5 8004 是
虚拟 IP vip IP 地址 25 否
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 26359 是 客户端连接端口
主节点 ip masterIp IP 地址 15 127.0.0.1 否
主节点端口 masterPort 端口号 5 6359 否
主节点密码 masterPssword 密码 50 否
选举个数 eCount 整数 5 1 否
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
绑定 IP Bind 文本 20 0.0.0.0 否 绑定服务器所在的 IP
工作目录 Dir 文本 20 ./ 否 设置工作目录，rdb 文件会自动存放在该目录
license 路径 LicensePath 文本 20 ./license.xml 否 读取 license.xml 的路径
SSL 模式 SSL 文本 20 false 否 是否开启 SSL 模式
# 监控参数
项目 定义值 备注
监控模板 AMDC AMDC
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单机部署定义
项目 定义值 备注
部署名称 单机
部署编码 standlone
部署描述
节点数量 = 1
计算规格 2G、2 核、100G
包含组件 amdc-server amdc
  • 集群部署定义
项目 定义值 备注
部署名称 集群
部署编码 cluster
部署描述
节点数量 >= 3
计算规格 2G、2 核、200G
包含组件 amdc-server

# Apusic 负载均衡器

# 基本信息
项目 定义值 备注
软件目录 服务网关
软件名称 ALB
图标
软件描述 ALB
# 版本与依赖
项目 定义值 备注
版本范围 2.0~2.X
版本描述
是否开启管控台 关闭
配置信息 license.xml、license-dashboard.xml、config.yaml
操控方式 定制脚本
安装位置 /opt/alb
安装依赖 端口 80
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 alb
组件编码 alb
组件关联配置
日志位置 /opt/alb/alb/alb_install_dir/alb/logs/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 80 是 端口
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
# 监控参数
项目 定义值 备注
监控模板 Apusic LB Apusic 负载均衡器
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 标准部署定义
项目 定义值 备注
部署名称 标准
部署编码 standard
部署描述
节点数量 = 1
计算规格 1G、1 核、100G
包含组件 alb alb

# Nginx

# 基本信息
项目 定义值 备注
软件目录 反向代理
软件名称 Nginx
图标
软件描述 Nginx
# 版本与依赖
项目 定义值 备注
版本范围 1.8.0~2.0
版本描述
是否开启管控台 关闭
配置信息 nginx.conf
操控方式 定制脚本
安装位置 /usr/local/nginx
安装依赖 jdk 1.8
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 nginx
组件编码 nginx
组件关联配置
日志位置 /usr/local/nginx/logs/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 80 是 端口
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
进程数 worker_processes 整数 10 1 否 nginx 进程数
最大连接数 worker_connections 整数 10 1024 否 单个进程最大连接数
# 监控参数
项目 定义值 备注
监控模板 Nginx Nginx
采集器安装路径 /usr/local/exporter/
采集端口 9113
采集路径 /metrics
抓取 nginx 指标 uri http://127.0.0.1/stub_status
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单例部署定义
项目 定义值 备注
部署名称 单例
部署编码 standalone
部署描述
节点数量 = 1
计算规格 1G、1 核、100G
包含组件 nginx nginx

# Kafka

# 基本信息
项目 定义值 备注
软件目录 消息中间件
软件名称 kafka-0.X
图标
软件描述 kafka 1.0 以下版本
# 版本与依赖
项目 定义值 备注
版本范围 0.10.2.0~0.10.X
版本描述
是否开启管控台 关闭
配置信息 server.properties
操控方式 定制脚本
安装位置 /opt/kafka
安装依赖
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 kafka-server
组件编码 kafka-server
组件关联配置
日志位置 logs/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 9092 是
日志目录 logDir 文本 256 /opt/kafka/logs 是
zk 服务列表 zkList 文本 256 localhost:2181 是 ip1:port1,ip2:port2 ...
监控端口 monitorPort 正整数 5 9308 是 端口
节点服务列表 nodeList 文本 256 是 节点 IP 服务列表 e.g. "172.24.3.1,172.24.3.2,172.24.3.3"
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
# 监控参数
项目 定义值 备注
监控模板 Kafka Kafka
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单机部署定义
项目 定义值 备注
部署名称 单例
部署编码 standalone
部署描述
节点数量 = 1
计算规格 1G、1 核、100G
包含组件 kafka-server kafka-server
  • 集群部署定义
项目 定义值 备注
部署名称 集群
部署编码 cluster
部署描述
节点数量 = 3
计算规格 2G、2 核、100G
包含组件 kafka-server kafka-server

# Redis

# 基本信息
项目 定义值 备注
软件目录 缓存
软件名称 Redis
图标
软件描述 redis 缓存
# 版本与依赖
项目 定义值 备注
版本范围 5.0~5.X
版本描述
是否开启管控台 关闭
配置信息 redis.conf
操控方式 定制脚本
安装位置 /usr/local/redis
安装依赖 jdk 1.8
# 组件定义
# 组件信息
项目 定义值 备注
组件名称 redis
组件编码 redis
组件关联配置
日志位置 /usr/local/redis/
组件描述
# 安装参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
端口 port 正整数 5 6379 是
密码 password 文本 32 否
主机 ip masterIp 文本 32 是
主机密码 masterAuth 文本 32 否
# 配置参数
参数名称 参数代号 参数类型 长度 取值 必填项 描述
客户端超时时间 timeout 正整数 10 0 否 客户端空闲 N 秒后关闭连接
日志输出级别 loglevel 文本 10 notice 否 取值 debug、verbose、notice 或 warning
日志输出路径 logfile 文本 255 usr/local/redis/redis.log 否 指定日志输出路径
设置同时连接的最大客户端数 maxclients 整数 10 10000 否 设置同时连接的最大客户端数
内存清理策略 maxmemory-policy 文本 55 noeviction 否
# 监控参数
项目 定义值 备注
监控模板 Redis Redis
采集器安装路径 /usr/local/exporter/
采集端口 9121
采集路径 /metrics
redis 地址 localhost:6379
redis 密码
# 操控定义
项目 定义值 备注
安装
卸载 rm -rf $installPath
启动 nohup $domainDir/bin/startapusic >> startaas.log 2>&1 &
停止
初始化
配置 source /etc/profile
# 部署定义
  • 单机部署定义
项目 定义值 备注
部署名称 单机
部署编码 standalone
部署描述
节点数量 = 1
计算规格 1G、1 核、100G
包含组件 redis redis 单机
  • 主从部署定义
项目 定义值 备注
部署名称 主从
部署编码 MS
部署描述
节点数量 >= 2
计算规格 1G、1 核、100G
包含组件 redis redis 单机
编辑页面 (opens new window)

← API文档→