Skip to content

03.zkdoctor使用文档

Elevenlxl edited this page Jun 20, 2018 · 1 revision

一、登录说明

1、默认使用注册+登录

(登录模式可参考:zkdoctor快速开始 第三节介绍)。使用admin超级管理员进行登录即可

2、LDAP模式

登录后,可自行在数据库中插入对应的用户信息。zk_user表中用户角色user_role字段说明如下:

0:普通用户
1:管理员用户
2:超级管理员用户

二、ZooKeeper集群纳入zkdoctor管理

1、已经存在的ZooKeeper集群

可直接一键加入到zkdoctor系统中进行监控管理。在【集群管理】→ 【添加集群】中进行操作,填写信息要求:

1)集群名称,必填,要求可包含字母、数字和下划线,唯一识别一个ZooKeeper集群

2)负责人,选填

3)实例数,选填。该集群中包含的实例个数

4)服务器host列表,必填。每行表示一台服务器信息,每行格式为ip:port(服务的ip与端口)

5)部署类型,必填。说明该集群是集群模式还是standalone模式

6)业务线,选填。区分该集群隶属哪个业务线

7)zk版本号,选填。表示该集群服务的版本信息

8)描述,选填。用于描述该集群的作用

页面配置如下:

添加集群

2、未部署的ZooKeeper集群

可提供指定配置信息,一键完成集群服务的安装部署。在【运维管理】→ 【集群部署】中进行操作,填写信息要求:

1)集群名称,必填,要求可包含字母、数字和下划线,唯一识别一个ZooKeeper集群

2)负责人,选填

3)server配置,必填。每行为一台服务器配置,格式:server.id=host:quorumPort:electionPort:peerType。将会对其中每台服务进行安装以及配置

4)安装包名称,必填。用于解压对应的安装包使用

5)安装包所在服务器目录,必填。服务将以这个目录下的安装包为准,进行安装

6)安装包下载路径,必填。如果安装包不存在,则会从指定的下载目录下进行下载

7)dataDir,必填。ZooKeeper服务数据目录配置

8)clientPort,必填。服务客户端端口配置

9)tickTime,必填。tickTime配置

10)initLimit,必填。initLimit配置

11)syncLimit,必填。syncLimit配置

12)业务线,选填。区分该集群隶属哪个业务线

13)指定配置项,选填。用于填写某些特性配置,格式:配置项=配置值,不同配置进行换行

页面配置如下:

服务部署

三、统计监控

1、集群信息统计

【集群管理】→ 【集群列表】中,监控开关控制集群信息统计。监控任务一分钟执行一次,通过ZooKeeper的四字命令mntr收集服务端的数据,完成数据处理和存储。统计数据详情可在【集群管理】→ 【集群列表】的【监控统计】中进行查看,示例如下:

集群统计

2、实例连接信息统计

【集群管理】→ 【集群列表】→ 【拓扑结构】→ 【监控统计】 → 【连接信息】中,具体说明请看zkdoctor权限以及开关说明中的第三部分介绍。

该功能默认关闭,仅在查询问题,考虑到某客户端连接操作异常时使用,建议在实例连接数比较多的情况下慎用。

示例如下:

实例连接收集开关

3、机器信息统计

【机器管理】→ 【机器列表】中,监控开关控制机器信息收集。具体说明请看zkdoctor权限以及开关说明中的第三部分介绍。

示例如下:

机器信息收集开关

四、运维管理

1、集群运维

【运维管理】→ 【集群运维】,包含:集群信息(基本信息)修改、动态扩容、下线集群、重启集群。

示例如下:

集群运维

对动态扩容功能进行简要说明。扩容前需将待扩容机器正确填写配置信息进行启动,如未启动,系统在扩容过程中将自动进行启动,运行正常后再进行扩容操作。

填写信息要求如下:

1)新服务器id,必填,与myid配置相同,唯一标识一个zk服务进程

2)ip,必填,新扩容的服务器ip

3)域名,选填,新扩容的服务器域名

4)客户端端口,必填,新扩容服务的客户端端口号

5)法人端口,必填,对提议进行投票相关消息传递使用的端口号

6)选举端口,必填,leader选举使用

7)新服务器类型,必填,可选项有:participate和observer

动态扩容

2、实例运维

【运维管理】→ 【集群运维】→ 【实例运维】,包含:实例的下线、重启、配置修改、配置文件上传(主要是myid信息)、服务升级等实例运维功能。

示例如下:

实例运维

对服务升级功能做简要说明。该功能支持对服务端进行二次开发,再次打包后进行升级的情况,仅支持Jar升级情况。需要上传待升级Jar包到zkdoctor服务器上。

升级过程中,会检测zkdoctor对应目录下是否有对应的Jar包,备份原Jar文件后,将推送新Jar文件至待升级实例目录下,重启实例,完成升级过程。

服务升级

3、系统配置

【运维管理】→ 【系统配置】,可以动态更新系统功能依赖的一些配置信息,具体配置值说明可以参考:04.zkdoctor快速开始下的第五节。

示例如下:

系统配置

4、业务线配置

【运维管理】→ 【业务线配置】,主要是为了区分不同的zk集群隶属哪个业务线,系统默认会增加“默认”业务线信息,也可以不进行设置,仅做区分使用

示例如下:

业务线配置

五、报警管理

【监控报警】列表下,包含所有监控指标以及监控任务。共计16项监控指标,涉及集群、实例以及机器维度。默认所有开关均处于开启状态。

当监控指标关闭时,所有其下的监控任务将全部关闭且不能被开启,当且仅当监控指标开关开启时,监控任务开关可做更改。

示例如下:

监控报警

报警信息会发送给谁呢?关注哪个集群,可以在【集群列表】对应的集群的【监控统计】下,自行添加用户即可(该用户需为登录过zkdoctor的用户)。默认所有报警信息都将会发送给超级管理员用户

六、注意事项

1、所有服务端数据采集采用zookeeper服务端提供的四字命令。支持3.4.0+版本以上的zookeeper服务监控

2、机器监控默认关闭,与服务监控相互隔离,两者相互不影响

3、其他说明可参考其他相关文档描述