SLS同步至ClickHouse集群

更新时间:
复制 MD 格式

本文为您介绍如何使用数据传输服务DTS(Data Transmission Service)将日志服务SLS的数据同步至云数据库ClickHouse集群。

重要

此功能目前处于灰度阶段。如需使用该功能,请提交工单与我们联系,以便为您开启相关功能。

前提条件

  • 已将待同步的数据采集到日志服务的Logstore中,详情请参见数据采集概述

  • 已创建目标ClickHouse集群,详情请参见新建集群

  • 已在目标ClickHouse集群创建用于接收数据的数据库和表,详情请参见创建数据库创建表对象命名规范限制

    说明
    • 日志服务SLS中的Logstore对应ClickHouse集群的数据库,Topic对应数据表。

    • ClickHouse集群中,无需为Logstore中以__开头并__结尾的索引字段创建相应的列。

注意事项

类型

说明

源库限制

  • 需保待同步Logstore的数据保存时间为7天以上。

其他限制

  • 不支持DTS Serverless实例。

  • 不支持库表结构同步,您需要手动在目标端创建接收数据的表,并在表中添加额外的字段。创建表的要求和字段信息,请参见表和字段信息

  • 不支持修改同步对象。

  • 不支持同步以__开头并__结尾的索引字段。

  • 若您需要将Logstore中所有Topic的数据同步到ClickHouse集群的同一张表,请在配置同步对象时在表名文本框中填入.*,否则可能会因Topic被过滤而导致相应数据丢失。

  • 重启任务可能会导致少量的数据重复。

  • 实例包含全量同步和增量同步,在任务列表合并显示为增量同步。

  • 待同步数据库的数量符合云数据库ClickHouse的限制,即不超过256个。

  • 全量数据初始化,DTS将会占用源和目标库一定的读写资源,可能会导致数据库的负载上升。因此建议在执行数据同步前评估源库和目标库的性能,并在业务低峰期执行数据同步(例如源库和目标库的CPU负载在30%以下)。

  • DTS同步期间,不允许有除DTS外的数据写入目标库,否则会导致源库与目标库数据不一致。

  • 若实例运行失败,DTS技术支持人员将在8小时内尝试恢复该实例。在恢复失败实例的过程中,可能会对该实例进行重启、调整参数等操作。

    说明

    在调整参数时,仅会修改DTS实例的参数,不会对数据库中的参数进行修改。可能修改的参数,包括但不限于修改实例参数中的参数。

费用说明

同步类型

链路配置费用

全量数据同步

不收费。

增量数据同步

收费,详情请参见计费概述

数据库账号的权限要求

数据库

所需权限

创建及授权方式

目标ClickHouse集群

  • 22.8及以上版本:目标库的读写权限,高权限账号符合要求。

  • 21.8版本:读写和设置权限允许DDL

社区兼容版账号管理

准备工作

在创建DTS实例之前,需进行相应的授权,以确保DTS能够读取日志服务中待同步的数据。您可以通过直接RAM用户的 AccessKey IDAccessKey Secret 或通过安全令牌(STS Token)两种方式进行授权。

使用RAM用户

  1. 创建RAM用户。

    1. 访问RAM用户列表

    2. 在页面左上角,单击创建用户

    3. 填入登录名称,并在访问方式区域选中使用永久 AccessKey 访问

    4. 单击确定

      重要

      RAM用户创建成功后,请保存AccessKey IDAccessKey Secret信息。

  2. 返回RAM用户列表,查找创建好的RAM用户。

  3. 在目标RAM用户的操作列,单击添加权限

  4. 权限策略下方的文本框中,搜索并选中AliyunLogReadOnlyAccess策略。

    说明

    AliyunLogReadOnlyAccess策略拥有日志服务的只读权限,授权了该策略的子账号可以访问日志服务。您也可以按需进行自定义策略,更多信息请参见创建自定义权限策略

  5. 单击确认新增授权,完成授权操作。

使用STS Token

  1. 创建RAM用户并授权。

    1. 访问RAM用户列表

      1. 在页面左上角,单击创建用户

      2. 填入登录名称,并在访问方式区域选中使用永久 AccessKey 访问

      3. 单击确定

        重要

        RAM用户创建成功后,请保存AccessKey IDAccessKey Secret信息。

    2. 返回RAM用户列表,查找创建好的RAM用户。

    3. 在目标RAM用户的操作列,单击添加权限

    4. 权限策略下方的文本框中,搜索并选中AliyunSTSAssumeRoleAccess策略,授权当前RAM用户调用STS服务AssumeRole接口的权限。

    5. 单击确认新增授权,完成授权操作。

  2. 创建RAM角色并授权。

    1. 访问RAM角色列表

    2. 在页面左上角,单击创建角色

    3. 创建角色页面,选择信任主体类型云账号,然后设置具体的阿里云账号,并单击确定

    4. 填写角色名称,单击确定

    5. 在角色详情页内,单击新增授权,在权限策略下方的文本框中,搜索并选中AliyunLogReadOnlyAccess策略。

      说明

      AliyunLogReadOnlyAccess策略拥有日志服务的只读权限,授权了该策略的子账号可以访问日志服务。您也可以按需进行自定义策略,更多信息请参见创建自定义权限策略

  3. 获取STS Token。

    使用RAM用户调用STS APIAssumeRole - 获取扮演角色的临时身份凭证获得当前RAM角色的安全令牌(STS Token)。

操作步骤

  1. 进入目标地域的同步任务列表页面(二选一)。

    通过DTS控制台进入

    1. 登录数据传输服务DTS控制台

    2. 在左侧导航栏,单击数据同步

    3. 在页面左上角,选择同步实例所属地域。

    通过DMS控制台进入

    说明

    实际操作可能会因DMS的模式和布局不同,而有所差异。更多信息,请参见极简模式控制台自定义DMS界面布局与样式

    1. 登录DMS数据管理服务

    2. 在顶部菜单栏中,选择Data + AI > 数据传输(DTS) > 数据同步

    3. 同步任务右侧,选择同步实例所属地域。

  2. 单击创建任务,进入任务配置页面。

  3. 配置源库及目标库信息。

    类别

    配置

    说明

    任务名称

    DTS会自动生成一个任务名称,建议配置具有业务意义的名称(无唯一性要求),便于后续识别。

    源库信息

    选择已有连接信息

    • 若您需要使用已录入系统(新建或保存)的数据库实例,请在下拉列表中选择所需的数据库实例,下方的数据库信息将自动进行配置。

      说明

      DMS控制台的配置项为选择DMS数据库实例

    • 若您未将数据库实例录入到系统,或无需使用已录入系统的数据库实例,则需要手动配置下方的数据库信息。

    数据库类型

    选择SLS

    接入方式

    选择云实例

    实例地区

    选择源日志服务中待同步数据所属项目(Project)的地域。

    Project

    选择源日志服务中待同步数据所属的Project。

    Logstore

    选择源日志服务中待同步数据所属的Logstore。

    AccessKey ID AccessKey Secret

    根据您的业务情况,填入在准备工作中所创建的RAM用户的AccessKey IDAccessKey SecretSTS Token。

    STS Token

    目标库信息

    选择已有连接信息

    • 若您需要使用已录入系统(新建或保存)的数据库实例,请在下拉列表中选择所需的数据库实例,下方的数据库信息将自动进行配置。

      说明

      DMS控制台的配置项为选择DMS数据库实例

    • 若您未将数据库实例录入到系统,或无需使用已录入系统的数据库实例,则需要手动配置下方的数据库信息。

    数据库类型

    选择ClickHouse

    接入方式

    选择云实例

    实例地区

    选择目标ClickHouse集群所属地域。

    是否跨阿里云账号

    本示例使用当前阿里云账号下的数据库实例,需选择不跨账号

    集群类型

    请根据实际情况选择ClickHouse集群的类型。

    集群ID

    选择目标ClickHouse集群的ID。

    数据库账号

    填入目标ClickHouse集群的数据库账号。权限要求,请参见数据库账号的权限要求

    数据库密码

    填入该数据库账号对应的密码。

  4. 配置完成后,在页面下方单击测试连接以进行下一步

    说明

    请确保DTS服务的IP地址段能够被自动或手动添加至源库和目标库的安全设置中,以允许DTS服务器的访问。更多信息,请参见添加DTS服务器IP地址白名单

  5. 配置任务对象。

    1. 对象配置页面,配置待同步的对象。

      配置

      说明

      同步类型

      仅支持全量同步 + 增量同步。预检查完成后,DTS会将源实例中待同步对象的全量数据在目标集群中初始化,作为后续增量同步数据的基线数据。

      目标已存在表的处理模式

      • 预检查并报错拦截:检查目标数据库中是否有同名的表。如果目标数据库中没有同名的表,则通过该检查项目;如果目标数据库中有同名的表,则在预检查阶段提示错误,数据同步任务不会被启动。

        说明

        如果目标库中同名的表不方便删除或重命名,您可以更改该表在目标库中的名称,请参见库表列名映射

      • 忽略报错并继续执行:跳过目标数据库中是否有同名表的检查项。

        警告

        选择为忽略报错并继续执行,可能导致数据不一致,给业务带来风险,例如:

        • 表结构一致的情况下,如在目标库遇到与源库主键或唯一键的值相同的记录:

          • 全量期间,DTS会保留目标集群中的该条记录,即源库中的该条记录不会同步至目标数据库中。

          • 增量期间,DTS不会保留目标集群中的该条记录,即源库中的该条记录会覆盖至目标数据库中。

        • 表结构不一致的情况下,可能会导致无法初始化数据、只能同步部分列的数据或同步失败,请谨慎操作。

      目标库对象名称大小写策略

      您可以配置目标实例中同步对象的库名、表名和列名的英文大小写策略。默认情况下选择DTS默认策略,您也可以选择与源库、目标库默认策略保持一致。更多信息,请参见目标库对象名称大小写策略

      已选择对象

      1. 指定接收数据的数据库。

        1. 将鼠标指针悬停在已选择对象中待同步的Logstore,并单击该Logstore后出现的编辑

        2. 在弹出的编辑Schema对话框中,将Schema名称修改为目标ClickHouse集群中接收数据的数据库名称。

          说明

          DTS默认将Logstore的名称映射为目标ClickHouse集群的数据库名称,若Logstore名称中包含-字符,则该字符将被替换为_

        3. 单击确定

      2. 指定接收数据的表。

        1. 单击Table后的新增表

        2. 在弹出的添加表对话框中,配置同步对象和接收数据的表。

          同步对象的粒度支持配置为LogstoreTopic:

          • 同步粒度为Logstore:在表名文本框中,填入.*

            重要

            .*表示Logstore中的所有Topic,且仅支持将Logstore中所有Topic的数据写入到同一张表中。

          • 同步粒度为Topic:在表名文本框中,填入Logstore中待同步的Topic名称。

        3. 目标表名文本框中,填入目标ClickHouse集群中接收数据的表名称。

          说明
          • 若待同步对象的粒度为Logstore,请勿单击添加表

          • 若待同步对象的粒度为Topic,请单击添加表,并逐一将每个TopicClickHouse集群中的表进行映射。

        4. 单击确定

      3. 指定接收数据的列。

        说明

        若待同步对象的粒度为Topic,您需要重复以下操作,逐一将每个TopicClickHouse集群中的表进行映射。

        1. 将鼠标指针悬停在已选择对象中刚创建的表,并单击该表后出现的编辑

        2. 在弹出的编辑表对话框中,确定待同步的索引字段(列)。

          说明

          对于无需同步的字段,您可以单击该字段操作列的image

        3. 目标列名文本框中,将其修改为目标表中用于接收相应索引字段数据的列名。

        4. 可选:目标类型列中,选择对应列的数据类型。

          说明

          DTS对数据类型的默认映射,请参见数据类型映射

        5. 可选:配置待同步的无索引的字段。

          说明

          您可以重复以下操作,配置需要同步的无索引的字段。

          1. 单击image,新增一行数据然后进行配置。

          2. 列名称列,填入需要同步的无索引的字段名称。

          3. 目标列名列,填入ClickHouse集群中接收数据的列名称。

          4. 可选:目标类型列中,选择对应列的数据类型。

            说明

            DTS对数据类型的默认映射,请参见数据类型映射

        6. 将每个待同步的字段配置完成后,单击确认

    2. 单击下一步高级配置,进行高级参数配置。

      配置

      说明

      选择调度该任务的专属集群

      DTS默认将任务调度到共享集群上,您无需选择。若您希望任务更加稳定,可以购买专属集群来运行DTS同步任务。更多信息,请参见什么是DTS专属集群

      源库、目标库无法连接后的重试时间

      在同步任务启动后,若源库或目标库连接失败则DTS会报错,并会立即进行持续的重试连接,默认持续重试时间为720分钟,您也可以在取值范围(10~1440分钟)内自定义重试时间,建议设置30分钟以上。如果DTS在设置的重试时间内重新连接上源库、目标库,同步任务将自动恢复。否则,同步任务将会失败。

      说明
      • 针对同源或者同目标的多个DTS实例,如DTS实例ADTS实例B,设置网络重试时间时A设置30分钟,B设置60分钟,则重试时间以低的30分钟为准。

      • 由于连接重试期间,DTS将收取任务运行费用,建议您根据业务需要自定义重试时间,或者在源和目标库实例释放后尽快释放DTS实例。

      源库、目标库出现其他问题后的重试时间

      在同步任务启动后,若源库或目标库出现非连接性的其他问题(如DDLDML执行异常),则DTS会报错并会立即进行持续的重试操作,默认持续重试时间为10分钟,您也可以在取值范围(1~1440分钟)内自定义重试时间,建议设置10分钟以上。如果DTS在设置的重试时间内相关操作执行成功,同步任务将自动恢复。否则,同步任务将会失败。

      重要

      源库、目标库出现其他问题后的重试时间的值需要小于源库、目标库无法连接后的重试时间的值。

      是否从选择的位点进行增量同步

      您可以根据实际情况,选择是否从指定的时间点开始同步数据。本示例保持默认设置

      说明

      若您选择为,还需要在下拉框中选择位点信息。

      是否限制增量同步速率

      您也可以根据实际情况,选择是否对增量同步任务进行限速设置(设置每秒增量同步的行数RPS每秒增量同步的数据量(MB)BPS),以缓解目标库的压力。

      环境标签

      您可以根据实际情况,选择用于标识实例的环境标签。本示例无需选择。

      配置 ETL 功能

      选择是否配置ETL功能。关于ETL的更多信息,请参见什么是ETL

      监控告警

      是否设置告警,当同步失败或延迟超过阈值后,将通知告警联系人。

  6. 保存任务并进行预检查。

    • 若您需要查看调用API接口配置该实例时的参数信息,请将鼠标光标移动至下一步保存任务并预检查按钮上,然后单击气泡中的预览OpenAPI参数

    • 若您无需查看或已完成查看API参数,请单击页面下方的下一步保存任务并预检查

    说明
    • 在同步作业正式启动之前,会先进行预检查。只有预检查通过后,才能成功启动同步作业。

    • 如果预检查失败,请单击失败检查项后的查看详情,并根据提示修复后重新进行预检查。

    • 如果预检查产生警告:

      • 对于不可以忽略的检查项,请单击失败检查项后的查看详情,并根据提示修复后重新进行预检查。

      • 对于可以忽略无需修复的检查项,您可以依次单击点击确认告警详情确认屏蔽确定重新进行预检查,跳过告警检查项重新进行预检查。如果选择屏蔽告警检查项,可能会导致数据不一致等问题,给业务带来风险。

  7. 购买实例。

    1. 预检查通过率显示为100%时,单击下一步购买

    2. 购买页面,选择数据同步实例的计费方式、链路规格,详细说明请参见下表。

      类别

      参数

      说明

      信息配置

      计费方式

      • 预付费(包年包月):在新建实例时支付费用。适合长期需求,价格比按量付费更实惠,且购买时长越长,折扣越多。

      • 后付费(按量付费):按小时扣费。适合短期需求,用完可立即释放实例,节省费用。

      资源组配置

      实例所属的资源组,默认为default resource group。更多信息,请参见什么是资源管理

      链路规格

      DTS为您提供了不同性能的同步规格,同步链路规格的不同会影响同步速率,您可以根据业务场景进行选择。更多信息,请参见数据同步链路规格说明

      订购时长

      在预付费模式下,选择包年包月实例的时长和数量,包月可选择1~9个月,包年可选择1年、2年、3年和5年。

      说明

      该选项仅在付费类型为预付费时出现。

    3. 配置完成后,阅读并勾选《数据传输(按量付费)服务条款》

    4. 单击购买并启动,并在弹出的确认对话框,单击确定

      您可在数据同步界面查看具体任务进度。

附录

数据类型映射

日志服务SLS

ClickHouse集群

TEXT

STRING

JSON

STRING

DOUBLE

FLOAT64

LONG

INT64

表和字段信息

表信息

手动创建目标表时,需要满足如下要求。

重要

目标表的ENGINE必须为ENGINE = ReplicatedReplacingMergeTree(_version, _is_deleted),否则可能会导致数据不一致。

  • ClickHouse社区版实例:需要创建一个本地表和一个分布式表。分布式表的名称需与配置同步对象时指定的表名一致,本地表的名称为<分布式表名称>+_local

  • ClickHouse企业版实例:需创建一个与配置同步对象时指定的表名相同的表。

字段信息

目标表中除了包含与源端对应的字段外,还需要添加以下额外字段。您可以使用SELECT * FROM table_name final WHERE _sign>0;语句查询数据。其中,WHERE条件可以过滤删除的数据,表名后的final字段可以过滤相同排序键的数据。

版本

名称

数据类型

默认值

说明

23.8以下的社区版

_sign

Int8

1

DML操作的类型。

  • INSERT:记录为1。

  • UPDATE:记录为1。

  • DELETE:记录为-1。

_version

UInt64

1

数据写入ClickHouse的时间戳。

企业版和23.8及以上的社区版

_sign

Int8

1

DML操作的类型。

  • INSERT:记录为1。

  • UPDATE:记录为1。

  • DELETE:记录为-1。

_is_deleted

UInt8

0

记录是否被删除:

  • Insert:记录为0。

  • Delete:记录为1。

  • Update:记录为0。

_version

UInt64

1

数据写入ClickHouse的时间戳。