通过Logstash将PolarDB-X（DRDS）数据同步至Elasticsearch

使用限制

准备工作

1. 创建PolarDB-X 1.0实例、数据库、表，并准备测试数据。
   具体操作，请参见PolarDB-X 1.0快速入门。

   本文使用的建表语句如下。

   CREATE table food(
   id int PRIMARY key AUTO_INCREMENT,
   name VARCHAR (32),
   insert_time DATETIME,
   update_time DATETIME );

   插入数据语句如下。

   INSERT INTO food values(null,'巧克力',now(),now());
   INSERT INTO food values(null,'酸奶',now(),now());
   INSERT INTO food values(null,'火腿肠',now(),now());

2. 创建阿里云Elasticsearch实例，并开启自动创建索引功能。
   创建实例时，所选专有网络要与PolarDB-X 1.0实例一致。具体操作，请参见创建阿里云Elasticsearch实例和快速访问与配置。本文使用6.7.0版本的实例。
3. 创建阿里云Logstash实例，并上传与PolarDB-X数据库版本兼容的SQL JDBC驱动。
   创建时所选专有网络和版本要与目标Elasticsearch实例一致。具体操作，请参见创建阿里云Logstash实例和配置扩展文件。本文使用mysql-connector-java-5.1.35.jar驱动。

   说明

   • 您也可以使用公网环境的服务，前提是需要通过配置NAT网关实现与公网的连通。详细信息，请参见配置NAT公网数据传输。
   • 本文使用MySQL JDBC驱动连接PolarDB-X数据库。您也可以使用PolarDB JDBC驱动，但对于一些高版本PolarDB-X数据库，使用PolarDB JDBC驱动会有问题，建议您使用MySQL JDBC驱动。
4. 在PolarDB-X数据库白名单中加入阿里云Logstash节点的IP地址（可在基本信息页面获取）。
   具体操作，请参见设置白名单。

配置Logstash管道

1. 登录阿里云Elasticsearch控制台。
2. 进入目标实例。
   1. 在顶部菜单栏处，选择地域。
   2. 在Logstash实例中单击目标实例ID。
3. 单击左侧导航栏的管道管理。
4. 单击创建管道。
5. 在创建管道任务页面，输入管道ID，并进行Config配置。
   本文使用的Config配置如下。

   input {
     jdbc {
       jdbc_driver_class => "com.mysql.jdbc.Driver"
       jdbc_driver_library => "/ssd/1/share/<Logstash实例ID>/logstash/current/config/custom/mysql-connector-java-5.1.35.jar"
       jdbc_connection_string => "jdbc:mysql://drdshbga51x6****.drds.aliyuncs.com:3306/<数据库名称>?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowLoadLocalInfile=false&autoDeserialize=false"
       jdbc_user => "db_user"
       jdbc_password => "db_password"
       jdbc_paging_enabled => "true"
       jdbc_page_size => "50000"
       statement => "select * from food where update_time >= :sql_last_value"
       schedule => "* * * * *"
       record_last_run => true
       last_run_metadata_path => "/ssd/1/<Logstash实例ID>/logstash/data/last_run_metadata_update_time.txt"
       clean_run => false
       tracking_column_type => "timestamp"
       use_column_value => true
       tracking_column => "update_time"
     }
   }
   filter {
   
   }
   output {
     elasticsearch {
       hosts => "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
       user => "elastic"
       password => "es_password"
       index => "drds_test"
       document_id => "%{id}"
     }
   }

   说明 代码中<Logstash实例ID>需要替换为您创建的Logstash实例的ID。获取方式，请参见实例列表概览。

   表 1. input参数说明

   参数	描述
   jdbc_driver_class	JDBC Class配置。
   jdbc_driver_library	指定JDBC连接MySQL驱动文件。具体操作请参见配置扩展文件。
   jdbc_connection_string	配置数据库连接的域名、端口及数据库。
   jdbc_user	数据库用户名。
   jdbc_password	数据库密码。
   jdbc_paging_enabled	是否启用分页，默认false。
   jdbc_page_size	分页大小。
   statement	指定SQL语句。
   schedule	指定定时操作，"* * * * *"表示每分钟定时同步数据。
   record_last_run	是否记录上次执行结果。如果为true，则会把上次执行到的tracking_column字段的值记录下来，保存到last_run_metadata_path指定的文件中。
   last_run_metadata_path	指定最后运行时间文件存放的地址。目前后端开放了/ssd/1/<Logstash实例ID>/logstash/data/路径来保存文件。指定参数路径后，Logstash会在对应路径下自动生成文件，但不支持查看文件内容。
   clean_run	是否清除last_run_metadata_path的记录，默认为false。如果为true，那么每次都要从头开始查询所有的数据库记录。
   use_column_value	是否需要记录某个column的值。
   tracking_column_type	跟踪列的类型，默认是numeric。
   tracking_column	指定跟踪列，该列必须是递增的，一般是表的主键。

   表 2. output参数说明

   参数	说明
   hosts	阿里云Elasticsearch实例的访问地址，格式为http://<实例的内网地址>:9200。其中实例的内网地址可在基本信息页面获取，详细信息请参见查看实例的基本信息。
   user	访问阿里云Elasticsearch实例的用户名，默认为elastic。
   password	对应用户的密码。elastic用户的密码在创建实例时设定，如果忘记可重置。重置密码的注意事项和操作，请参见重置实例访问密码。
   index	索引名称。
   document_id	文档ID。设置为%{id}，表示与源数据库中的ID字段保持一致。

   重要

   • 以上配置按照测试数据配置，在实际业务中，请按照业务需求进行合理配置。input插件支持的其他配置选项，请参见官方Logstash Jdbc input plugin。
   • 如果配置中有类似last_run_metadata_path的参数，需要阿里云Logstash服务提供文件路径。目前后端开放了/ssd/1/<Logstash实例ID>/logstash/data/路径供您测试使用，且该目录下的数据不会被删除。因此在使用时，请确保磁盘有充足的使用空间。指定参数路径后，Logstash会在对应路径下自动生成文件，但不支持查看文件内容。
   • 为了提升安全性，如果在配置管道时使用了JDBC驱动，需要在jdbc_connection_string参数后面添加allowLoadLocalInfile=false&autoDeserialize=false，否则当您在添加Logstash配置文件时，调度系统会抛出校验失败的提示，例如jdbc_connection_string => "jdbc:mysql://drdshbga51x6****.drds.aliyuncs.com:3306/<数据库名称>?allowLoadLocalInfile=false&autoDeserialize=false"。

   更多Config配置，请参见Logstash配置文件说明。

6. 单击下一步，配置管道参数。
   

   参数	说明
   管道工作线程	并行执行管道的Filter和Output的工作线程数量。当事件出现积压或CPU未饱和时，请考虑增大线程数，更好地使用CPU处理能力。默认值：实例的CPU核数。
   管道批大小	单个工作线程在尝试执行Filter和Output前，可以从Input收集的最大事件数目。较大的管道批大小可能会带来较大的内存开销。您可以设置LS_HEAP_SIZE变量，来增大JVM堆大小，从而有效使用该值。默认值：125。
   管道批延迟	创建管道事件批时，将过小的批分派给管道工作线程之前，要等候每个事件的时长，单位为毫秒。默认值：50ms。
   队列类型	用于事件缓冲的内部排队模型。可选值： MEMORY：默认值。基于内存的传统队列。 PERSISTED：基于磁盘的ACKed队列（持久队列）。
   队列最大字节数	请确保该值小于您的磁盘总容量。默认值：1024 MB。
   队列检查点写入数	启用持久性队列时，在强制执行检查点之前已写入事件的最大数目。设置为0，表示无限制。默认值：1024。

   警告 配置完成后，需要保存并部署才能生效。保存并部署操作会触发实例重启，请在不影响业务的前提下，继续执行以下步骤。
7. 单击保存或者保存并部署。
   • 保存：将管道信息保存在Logstash里并触发实例变更，配置不会生效。保存后，系统会返回管道管理页面。可在管道列表区域，单击操作列下的立即部署，触发实例重启，使配置生效。
   • 保存并部署：保存并且部署后，会触发实例重启，使配置生效。

验证结果

1. 登录目标阿里云Elasticsearch实例的Kibana控制台。
   具体操作，请参见登录Kibana控制台。
2. 在左侧导航栏，单击Dev Tools（开发工具）。
3. 在Console中，执行以下命令，查看同步成功的索引数量。

   GET drds_test/_count
   {
     "query": {"match_all": {}}
   }

   运行成功后，结果如下。

   {
     "count" : 3,
     "_shards" : {
       "total" : 1,
       "successful" : 1,
       "skipped" : 0,
       "failed" : 0
     }
   }

4. 在表中更新并插入数据。

   UPDATE food SET name='Chocolates',update_time=now() where id = 1;
   INSERT INTO food values(null,'鸡蛋',now(),now());

5. 在Kibana控制台，查看更新后的数据。
   • 查询name为Chocolates的数据。

     GET drds_test/_search
     {
       "query": {
         "match": {
           "name": "Chocolates"
        }}
     }

     返回结果如下。
   • 查询所有数据。

     GET drds_test/_search
     {
       "query": {
         "match_all": {}
       }
     }

     返回结果如下。

常见问题

Logstash数据写入问题排查方案