同步工具

介绍

同步工具是定期将本地磁盘中和新增的已持久化的tsfile文件上传至云端并加载到IoTDB的套件工具。

在同步工具的发送端，同步模块是一个独立的进程，独立于本地的IoTDB。通过独立的脚本进行启动和关闭(详见章节使用方式)，同步的频率周期可由用户设置。

在同步工具的的接收端，同步模块内嵌于IoTDB的引擎，和IoTDB处于同一个进程中。同步模块监听一个独立的端口，该端口可由用户设置(详见章节配置参数)。用户使用前，需要在同步接收端设置同步白名单，以网段形式表示，接收端的同步模块只接受位于白名单网段中的发送端同步的数据.

同步工具具有多对一的发送-接受模式，即一个同步接收端可以同时接受多个同步发送端传输的数据，一个同步发送端只能向一个同步接收端发送数据

注意：在使用同步工具前，同步工具的接收端和发送端需要单独配置。

应用场景

以一个工厂应用为例，通常有多个分厂和多个总厂，每个分厂中使用一个IoTDB实例收集数据，然后将数据定时汇总到总厂中进行备份或者分析等，一个总厂可以接收来自多个分厂的数据，一个分厂也可以给多个总厂同步数据，在这种场景下每个IoTDB实例所管理的设备各不相同。

在sync模块中，每个分厂是发送端，总厂是接收端，发送端定时将数据同步给接收端，在上述应用场景下一个设备的数据只能由一个发送端来收集，因此多个发送端同步的数据之间必须是没有设备重叠的，否则不符合sync功能的应用场景。

当出现异常场景时，即两个或两个以上的发送端向同一个接收端同步相同设备(其存储组设为root.sg)的数据时，后被接收端收到的含有该设备数据的发送端的root.sg数据将会被拒绝接收。示例：发动端1向接收端同步存储组root.sg1和root.sg2, 发动端2向接收端同步存储组root.sg2和root.sg3, 均包括时间序列root.sg2.d0.s0, 若接收端先接收到发送端1的root.sg2.d0.s0的数据，那么接收端将拒绝发送端2的root.sg2同步的数据。

配置参数

同步工具接收端

同步工具接收端的参数配置位于IoTDB的配置文件iotdb-engine.properties中，其安装目录为$IOTDB_HOME/conf/iotdb-engine.properties。在该配置文件中，有四个参数和同步接收端有关，配置说明如下:

参数名: is_sync_enable
描述同步功能开关，配置为true表示接收端允许接收同步的数据并加载，设置为false的时候表示接收端不允许接收同步的数据
类型Boolean
默认值true
改后生效方式重启服务器生效
参数名: IP_white_list
描述设置同步功能发送端IP地址的白名单，以网段的形式表示，多个网段之间用逗号分隔。发送端向接收端同步数据时，只有当该发送端IP地址处于该白名单设置的网段范围内，接收端才允许同步操作。如果白名单为空，则接收端不允许任何发送端同步数据。默认接收端接受全部IP的同步请求。
类型String
默认值0.0.0.0/0
改后生效方式重启服务器生效
参数名: sync_server_port
描述同步接收端服务器监听接口，请确认该端口不是系统保留端口并且未被占用。参数is_sync_enable设置为true时有效，参数is_sync_enable设置为false时无效
类型Short Int : [0,65535]
默认值5555
改后生效方式重启服务器生效

同步工具发送端

同步功能发送端的参数配置在一个单独的配置文件中，其安装目录为$IOTDB_HOME/conf/iotdb-sync-client.properties。在该配置文件中，有五个参数和同步发送端有关，配置说明如下：

参数名: server_ip
描述同步接收端的IP地址
类型String
默认值127.0.0.1
改后生效方式重启同步功能发送端生效
参数名: server_port
描述同步接收端服务器监听端口，需要保证该端口和同步接收端配置的监听端口一致
类型Short Int : [0,65535]
默认值5555
改后生效方式重启同步功能发送端生效
参数名: sync_period_in_second
描述同步周期，两次同步任务开始时间的间隔，单位为秒(s)
类型Int : [0,2147483647]
默认值600
改后生效方式重启同步功能发送端生效
参数名: sync_storage_groups
描述进行同步的存储组列表，存储组间用逗号分隔；若列表设置为空表示同步所有存储组，默认为空
类型String
示例root.sg1, root.sg2
改后生效方式重启同步功能发送端生效
参数名: max_number_of_sync_file_retry
描述发送端同步文件到接收端失败时的最大重试次数
类型Int : [0,2147483647]
示例5
改后生效方式重启同步功能发送端生效

使用方式

启动同步功能接收端

  1. 配置接收端的参数，例如： 同步工具 - 图1
  2. 启动IoTDB引擎，同步功能接收端会同时启动，启动时LOG日志会出现IoTDB: start SYNC ServerService successfully字样，表示同步接收端启动成功，如图所示： 同步工具 - 图2

关闭同步功能接收端

关闭IoTDB，同步功能接收端会同时关闭。

启动同步功能发送端

  1. 配置发送端的参数， 如图所示: 同步工具 - 图3
  2. 启动同步功能发送端

用户可以使用$IOTDB_HOME/bin文件夹下的脚本启动同步功能的发送端 Linux系统与MacOS系统启动命令如下：

  1.   Shell >$IOTDB_HOME/bin/start-sync-client.sh

Windows系统启动命令如下：

  1.   Shell >$IOTDB_HOME\bin\start-sync-client.bat

同步工具 - 图4

关闭同步功能发送端

用户可以使用$IOTDB_HOME/bin文件夹下的脚本关闭同步功能的发送端。 Linux系统与MacOS系统停止命令如下：

  1.   Shell >$IOTDB_HOME/bin/stop-sync-client.sh

Windows系统停止命令如下：

  1.   Shell >$IOTDB_HOME\bin\stop-sync-client.bat