ITManager应用监控产品需求规格说明书

文档编号：xxx-xxx-xx-xx ITManager应用监控产品需求规格说明 文档版本号：   文档编号：   文档密级：   归属部门/项目：   产品名： ITManger应用监控 子系统名：   编写人：   编写日期：   审核人：   审核日期：   批准人：   批准日期：           修订记录： 版本号 修订人 修订日期 修订描述                                                                                                                 目 录 1 简介    4 1.1 目的    4 1.2 范围    4 1.3 定义、首字母缩写词和缩略语    4 1.4 参考资料    5 1.5 假定    5 2 产品定位    5 2.1 产品背景    5 2.2 问题说明    5 2.3 产品定位说明    5 3 相关方和用户说明    5 3.1 相关方摘要    6 3.2 用户摘要    6 3.3 用户环境    6 3.4 关键的相关方/用户需要    6 4 产品概述    6 4.1 产品总体效果    7 4.2 功能摘要    7 4.3 假设与依赖关系    7 5 产品功能性需求概述    7 6 产品功能关联    8 7 产品功能性需求描述    9 7.1 应用监控添加    9 7.1.1 监控对象添加    9 7.1.2 监控指标添加    10 7.2 应用监控数据采集    10 7.2.1 DNS解析时间    10 7.2.2 FTP连接时间    11 7.2.3 FTP下载指定文件的时间和速率    11 7.2.4 POP3服务连接时间    11 7.2.5 SMTP发信时间    12 7.2.6 一般TCP服务探测    12 7.2.7 指定URL下载时间    13 7.2.8 指定URL下载字节长度    13 7.2.9 指定URL内容匹配    14 7.2.10 指定URL返回码    14 7.2.11 事件和告警的形成    15 7.3 应用监控展现    15 7.3.1 监控指标展现    15 7.3.2 告警展现    16 8 约束    16 9 接口    16 10 产品非功能性需求    17 10.1 适用的标准    17 10.2 系统需求    17 10.3 用户界面需求    18 10.4 易用性    19 10.5 可靠性    19 10.6 性能    19 10.7 可支持性    20 10.8 安全性需求    20 10.9 可扩展性需求    20 10.10 兼容性需求    20 10.11 可移植性需求    21 11 文档需求    21 11.1 用户手册    21 11.2 联机帮助    21 11.3 安装指南、配置文件、自述文件    21 12 附录A：需求确认    21 13 附录B：需求评审辅助列表    23 14 附录C：待定需求列表    23 1 简介 网络、主机、数据库作为传统的监控对象早已得到用户的重视,业界也有很多成熟的产品，实现对这些对象的监控.ITManager就是其中比较成功的一员。 在这些监控做得比较成熟后,最终用户对运营商提出了更高的要求.最终用户使用的是运营商提供的具体的服务，如WWW服务、邮件服务、FTP服务等、有时在网络、主机,、数据库等对象都正常运行时，由于服务本身的原因，不能提供应有的可用性。因此，有必要建立直接对各种应用服务的监控，直接站在最终用户的角度监控应用服务的可用性。 本项目完成后，与ITManager系统集成到一起，实现对用户应用的实时监控。 1.1 目的 此文档的目的是收集、分析和定义“ITManager应用监控”的产品的需要和特性。它包括相关方和目标用户需要的功能和这些需要存在的原因，以及详细地说明所确定的产品的关键外部流程、接口和非功能性特性的需求、设计约束。 1.2 范围 项目的名称：应用监控软件项目 产品的名称：ITManager系统的应用监控子系统 项目的组织者：浙大快威－成都勤智数码有限责任公司 产品的生产者：浙大快威－成都勤智数码有限责任公司，应用监控项目组 产品的设计者：浙大快威－成都勤智数码有限责任公司，应用监控项目组 产品的所有权：浙大快威－成都勤智数码有限责任公司 1.3 定义、首字母缩写词和缩略语 需求：用户解决问题或达到目标所需的条件或功能；系统或系统部件要满足、标准，或其它正式规定文档所需具有的条件或权能。 需求分析：包括提炼，分析和仔细审查已收集到的需求，以确保所有的风险承担者都明其含义并找出其中的错误，遗憾或其它不足的地方。 模块的独立性：是指软件系统中每个模块只涉及软件要求的具体的子功能，而和软件系统中其他的模块的接口是简单的。 ITM － ITManager的简称 KPI－监控指标 优先级：高～必须完成；中～在时间不足，或是发生风险时，可以考虑暂缓；低～属于优化功能，若资源足够，也可以实现 实现难度：高～不熟悉的技术；中～未做过类似的但熟悉技术；低～曾做过类似的 1.4 参考资料 《ITManager用户需求说明书》 《ITManager用户手册》 1.5 假定 读者应对现有ITManager系统的功能，系统架构，应用监控的目的，含义，以及用户需求有一定了解。 2 产品定位 本产品首先作为现有ITM系统的一个子系统，能完整嵌入到现有系统中运行，其数据流程和存储结构等与ITM系统兼容。 2.1 产品背景 现有ITM系统实现了对网络、主机、数据库等对象的实时监控，随着网络条件的改善，用户越来越将注意力集中于应用，直接关注应用的可用性。 本模块应为ITM提供应用监控功能。 2.2 问题说明 本产品首先作为现有ITM系统的一个子系统，能完整嵌入到现有系统中运行，其数据流程和存储结构等与ITM系统兼容。 同时，开发过程中应注意模块独立性，在将来也能够将本模块扩充为一个独立系统。 2.3 产品定位说明 本模块使ITM系统具有在应用密集环境下的实时监控能力，从而扩大ITM的适应范围，比如IDC机房，网站，以及政府，公司的日常业务监控。 3 相关方和用户说明 3.1 相关方摘要 3.2 用户摘要 3.3 用户环境 3.4 关键的相关方/用户需要 4 产品概述 4.1 产品总体效果 对客户提供类似于主机监控的使用方法。 在 定制－设备管理－应用监控 中管理（增删改）监控对象和指标 在 首页 中显示树状监控对象，单击一个监控对象后，在右边主窗口中展现属于它的所有指标的情况。 4.2 功能摘要 能对一下应用（服务）提供实时监控 ● DNS ● FTP ● POP3 ● SMTP ● 一般TCP ● URL(WWW) 4.3 假设与依赖关系 5 产品功能性需求概述 应实现以下模块/功能： 编号 功能类别 编号 子功能 1 应用监控添加 应用监控-SRR-1.1 监控对象添加 应用监控-SRR-1.2 监控指标（KPI）添加     2 应用监控数据采集 应用监控-SRR-2.1 DNS解析时间 应用监控-SRR-2.2 FTP连接时间 应用监控-SRR-2.3 FTP下载指定文件的时间和速率 应用监控-SRR-2.4 POP3服务连接时间 应用监控-SRR-2.5 SMTP发信时间 应用监控-SRR-2.6 一般TCP服务探测 应用监控-SRR-2.7 指定URL下载时间 应用监控-SRR-2.8 指定URL下载字节长度 应用监控-SRR-2.9 指定URL内容匹配 应用监控-SRR-2.10 指定URL返回码 应用监控-SRR-2.11 事件和告警 3 应用监控展现 应用监控-SRR-3.1 应用监控指标展现 应用监控-SRR-3.2 告警方式         6 产品功能关联 所有的监控对象和指标需要先添加，然后借用ITM的调度策略进行周期性采集，并保存于数据库，最后展现。 1. 监控对象和指标添加 应于ITM系统融合到一起，可考虑 添加监控对象 添加指标 2. 采集 ● 调度 借用ITM原有的对主机采集的调度模块： 一个监控对象相当于一个主机 监控对象的指标相当于主机的指标 ● 采集 具体的采集模块需要全新编写，后文描述 ● 数据库 每一个指标增加一个表，表结构除能容纳所有采集信息外，其风格和命名于原有主机表一致。 3. 展现 能将所有监控对象列在一个树状列表中，单击一个监控对象后，自动到数据库中寻找对应的表/数据，按图表或走势图两种方式展现。 对超过阈值的监控对象，在树状列表的对应位置实现闪烁告警，并产生相应的文字信息，以颜色区分严重级别。 主要展现安排在首页。 7 产品功能性需求描述 7.1 应用监控添加 7.1.1 监控对象添加 名称、标识符 应用监控-SRR-1.1 功能描述 描述 监控对象添加 相关参数及其范围 监控类型，选择 位置，选择，默认为主监控视图 设备名称，输入 IP地址，输入，应检查有效性， 主机名，输入 优先级 高 难度 低 输入（键盘输入或鼠标点击；数据流/报文流入） 键盘输入和鼠标点击 正确操作序列（可用图）   输出（界面显示；数据流/报文输出） 界面显示；数据入库 错误处理：对于错误的输入、错误的操作方式的处理办法说明 提醒用户重新输入 补充说明         7.1.2 监控指标添加 名称、标识符 应用监控-SRR-1.2 功能描述 描述 监控指标添加 相关参数及其范围 监控指标类型，选择 指标属性：不同的指标属性不同，请参考《ITManager应用监控用户需求说明书》5.1.2.1功能描述。 优先级 高 难度 中 输入（键盘输入或鼠标点击；数据流/报文流入） 键盘输入和鼠标点击 正确操作序列（可用图）   输出（界面显示；数据流/报文输出） 界面显示；数据入库 错误处理：对于错误的输入、错误的操作方式的处理办法说明 提醒用户重新输入 补充说明         7.2 应用监控数据采集 7.2.1 DNS解析时间 名称、标识符 应用监控-SRR-2.1 功能描述 描述 DNS解析时间采集 相关参数及其范围 DNS服务器地址 解析对象（如一个域名） 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 解析结果，解析花费时间 采集结果写入数据库 补充说明         7.2.2 FTP连接时间 名称、标识符 应用监控-SRR-2.2 功能描述 描述 FTP连接时间 相关参数及其范围 服务端口号 用户名，密码 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 连接到ftp服务，并成功登陆所耗费时间 采集结果写入数据库 补充说明         7.2.3 FTP下载指定文件的时间和速率 名称、标识符 应用监控-SRR-2.3 功能描述 描述 FTP下载指定文件的时间和速率 相关参数及其范围 端口号 用户名，密码 远程路径，本地存放路径 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 被下载文件的长度 下载该文件从登陆，到下载完成全程耗费的时间 平均速率 采集结果写入数据库 补充说明         7.2.4 POP3服务连接时间 名称、标识符 应用监控-SRR-2.4 功能描述 描述 POP3服务连接时间 相关参数及其范围 端口号 用户名，密码 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 连接到pop3服务，并成功登陆所耗费时间 采集结果写入数据库 补充说明         7.2.5 SMTP发信时间 名称、标识符 应用监控-SRR-2.5 功能描述 描述 SMTP发信时间 相关参数及其范围 端口号 用户名，密码 邮件信息（收信、发信email地址、邮件主题、内容） 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 连接到smtp服务，并成功发送测试邮件所耗费时间 采集结果写入数据库 补充说明         7.2.6 一般TCP服务探测 名称、标识符 应用监控-SRR-2.6 功能描述 描述 一般TCP服务探测 相关参数及其范围 TCP服务端口号 发送字符串（将此字符串发送到被探测端口，观察其相应字符串） 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 是否可以和对应端口建立tcp连接 通信字符串：向tcp端口发送指定字符串，接收主机响应字符串 采集结果写入数据库 补充说明         7.2.7 指定URL下载时间 名称、标识符 应用监控-SRR-2.7 功能描述 描述 指定URL下载时间 相关参数及其范围 URL 用户名 密码 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 从与web服务器建立连接，到指定url下载完毕所耗费的时间 采集结果写入数据库 补充说明         7.2.8 指定URL下载字节长度 名称、标识符 应用监控-SRR-2.8 功能描述 描述 指定URL下载字节长度 相关参数及其范围 URL 用户名 密码 错误参数处理   优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 指定url下载完毕的字节数 采集结果写入数据库 补充说明         7.2.9 指定URL内容匹配 名称、标识符 应用监控-SRR-2.9 功能描述 描述 指定URL内容匹配 相关参数及其范围 URL 用户名 密码 匹配内容 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 是否超时 是否匹配 匹配的字符串 采集结果写入数据库 补充说明         7.2.10 指定URL返回码 名称、标识符 应用监控-SRR-2.10 功能描述 描述 DNS解析时间采集 相关参数及其范围 URL 用户名 密码 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 连接指定url的http返回码 返回码的含义（中文，力求简明扼要） 采集结果写入数据库 补充说明         7.2.11 事件和告警的形成 名称、标识符 应用监控-SRR-2.11 功能描述 描述 时间和告警的形成 相关参数及其范围 各KPI的阈值，及事件描述 错误参数处理 无 优先级 高 难度 高 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 在采集时完成，当超过阈值限制时，调用ITM接口产生相应的告警，使用参数定义的事件描述。 补充说明         7.3 应用监控展现 7.3.1 监控指标展现 名称、标识符 应用监控-SRR-3.1 功能描述 描述 监控指标展现 相关参数及其范围 数据库表 错误参数处理 无 优先级 高 难度 中 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 从数据库表读取采集数据，按两种方式展现数据： 1． 图表，以形式展现 2． 走势图，对部分单指标的数值型数据，可按任意时间段画出走势图，时间段可手动调整。 3． 页面位置和风格，与ITM原有主机监控类似，可参考《ITManager应用监控用户需求说明书》 补充说明         7.3.2 告警展现 名称、标识符 应用监控-SRR-3.2 功能描述 描述 告警的展现 相关参数及其范围 数据库表 以及调用ITM事件模块 错误参数处理 无 优先级 高 难度 中 输入（键盘输入或鼠标点击；数据流/报文流入） 读取数据库 正确操作序列（可用图） 错误操作处理   输出（界面显示；数据流/报文输出） 调用ITM事件处理模块，对事件做如下处理： 1． 所有事件按不同优先级不同，用不同的颜色，显示在主页，要求能区分来源，对问题能做具体描述 2． 在每个监控对象展现页，能显示跟这个监控对象相关的事件 3． 当某个监控对象的相关事件中有达到告警级别的，左边对象树中的相关图标闪烁提示注意。 4． 以上事件只显示最近若干条（如50条），所有事件可调用ITM事件展现模块做灵活查询。 补充说明         8 约束 9 接口 为了能与ITM系统完整融合，并为将来的开发提供统一接口，定义以下接口功能。以下接口功能，必须严格按要求开发。 1． 每一类监控对象定义为一个类，如DNS，URL，SMTP等，并继承自MonObj类。每个监控对象类提供一个DoProbe()公用接口，它调用相关的所有KPI的DoProbe()接口，并将采集值存储在KPIValue中；它本身被其它模块调用，以监控特定应用。 2． 每一个KPI定义为一个类，如URLCode，SMTPTime等，并继承自MonKPI类。每个KPI类提供一个DoProbe()公用接口，被监控对象类调用，如有必要也可以被别的模块调用。 3． 每个KPI类的DoProbe()接口返回一个KPIValue类型的实例，存储所有采集数据。 4． 每个监控对象类必须提供store()公用接口，被外部模块（如调度模块）调用，将有关该对象的所有KPI的采集值存储（存储在KPIValue中）到数据库表中。 5． 每个监控对象必须提供alert()公用接口，负责处理告警。它调用ITM的事件处理模块，自身被ITM调度模块或其它模块调用。 KPIValue 10 产品非功能性需求 10.1 适用的标准 编号 需求名称 详细要求               …         10.2 系统需求 ● 硬件平台 Intel X86平台 CPU主频1.6G以上 内存1G以上 空闲硬盘空间10G以上 网络接口100M ● 软件平台 操作系统：Windows2000 Server SP4 客户端：IE5.0以上 10.3 用户界面需求 要求与ITM母系统风格一致 可参考以下Demo 1． 展现整体风格 2． 图表展示 3． 走势图展示 4． 告警 10.4 易用性 产品应具备易用性，要求现有ITM用户在经过简单培训（1－2天）后能熟练使用该功能。 10.5 可靠性 ● 平均故障次数 <= 3次/年 ● 对用户输入的字符串做合理性检查 ● 在监控对象失效，或网络失效的情况下不影响系统正常运行。保证能无需任何人工处理，在监控对象或网络恢复后，系统自动恢复正常运行。 ● 数据备份和一般数据维护时不中断系统运行 10.6 性能 在满足“系统需求”软硬件平台的条件下， 能同时监控对象 >= 100 台 最高采集频率 <= 5 分钟 对数据库压力不大 不明显影响被监控系统的性能 10.7 可支持性 编号 需求名称 详细要求               …         10.8 安全性需求 需使用itmanager的admin权限方能操作本部分功能 10.9 可扩展性需求 10.10 兼容性需求 本系统作为itmanager的子系统 10.11 可移植性需求 11 文档需求 11.1 用户手册 11.2 联机帮助 11.3 安装指南、配置文件、自述文件 12 附录A：需求确认 需求评审报告摘要 需求文档 输入名称，标识符，版本，作者，完成日期，… 需求评审报告 输入名称，标识符，评审日期，… 评审结论 [ ] 工作成果合格，“无需修改”或者“需要轻微修改但不必再审核”。 [√] 工作成果基本合格，需要作少量的修改，之后通过审核即可。 [ ] 工作成果不合格，需要作比较大的修改，之后必须重新对其评审。 评审意见   评审小组成员 输入评审小组成员     需求承诺 需求文档 输入名称，标识符，版本，作者，完成日期 客户承诺 承诺… 签字，日期 项目经理承诺 承诺… 签字，日期     13 附录B：需求评审辅助列表 编号 功能 编号 子功能 通过？Y/N 原因 后续操作                                                                                       14 附录C：待定需求列表 编号 功能 编号 子功能 当前状态 待定原因 可能造成的问题