This topic describes how to create a MaxCompute sink connector to export data from a data source topic of a ApsaraMQ for Kafka instance to a MaxCompute table.
Prerequisites
The following requirements must be met:- ApsaraMQ for Kafka
- The connector feature is enabled for the ApsaraMQ for Kafka instance. For more information, see Enable the connector feature.
- A topic is created in the ApsaraMQ for Kafka instance. For more information, see Step 1: Create a topic.
A topic named maxcompute-test-input is used in this example.
- MaxCompute
- A MaxCompute table is created on the MaxCompute client. For more information, see Create tables.
In this example, a MaxCompute table named test_kafka is created in a project named connector_test. You can execute the following statement to create a MaxCompute table named test_kafka:
CREATE TABLE IF NOT EXISTS test_kafka(topic STRING,partition BIGINT,offset BIGINT,key STRING,value STRING) PARTITIONED by (pt STRING);
- A MaxCompute table is created on the MaxCompute client. For more information, see Create tables.
- Optional:EventBridge
- EventBridge is activated. For more information about how to activate EventBridge, see Activate EventBridge and grant permissions to a RAM user.
Note EventBridge is required to be activated only when the instance that contains the data source topic is in the China (Hangzhou) or China (Chengdu) region.
Precautions
- You can only export data from a data source topic of a ApsaraMQ for Kafka instance to a MaxCompute table within the same region. For more information about the limits on connectors, see Limits.
- If the instance that contains the data source topic is in the China (Hangzhou) or China (Chengdu) region, the connector task is published to EventBridge.
- At present, EventBridge is free of charge. For more information, see Billing.
- When you create a connector, EventBridge creates the AliyunServiceRoleForEventBridgeSourceKafka service-linked role for you.
- If the service-linked role is not available, EventBridge automatically creates one for you to allow EventBridge to access ApsaraMQ for Kafka.
- If the service-linked role is available, EventBridge does not create a new one.
- You cannot view the operational logs of connector tasks that are published to EventBridge. After a connector task is completed, you can view the consumption details of the groups that subscribe to the data source topic to see the status of the connector task. For more information, see View consumption details.
Procedure
To export data from a data source topic of a ApsaraMQ for Kafka instance to a MaxCompute table by using a MaxCompute sink connector, perform the following steps:
- Grant ApsaraMQ for Kafka the permissions to access MaxCompute.
- Optional: Create the topics and group that are required by a MaxCompute sink connector.
If you do not want to manually create the topics and group, skip this step and set the Resource Creation Method parameter to Auto in the next step.
Important Specific topics that are required by a MaxCompute sink connector must use a local storage engine. If the major version of your ApsaraMQ for Kafka instance is 0.10.2, topics that use a local storage engine cannot be created manually and must be created automatically. - Create and deploy a MaxCompute sink connector
- Verify the result.
Create a RAM role
You cannot select ApsaraMQ for Kafka as the trusted service when you create a RAM role. Therefore, select any service that can be the trusted service first. Then, manually modify the trust policy of the RAM role.
- Log on to the RAM console.
- In the left-side navigation pane, click RAM Roles.
- On the RAM Roles page, click Create RAM Role.
- In the Create Role panel, perform the following operations:
- Select Alibaba Cloud Service as the trusted entity and click Next.
- Set the Role Type parameter to Normal Service Role. In the RAM Role Name field, enter AliyunKafkaMaxComputeUser1. From the Select Trusted Service drop-down list, select MaxCompute. Then, click OK.
- On the Roles page, find and click AliyunKafkaMaxComputeUser1.
- On the AliyunKafkaMaxComputeUser1 page, click the Trust Policy Management tab and then click Edit Trust Policy.
- In the Edit Trust Policy panel, replace fc in the script with alikafka and click OK.
Add permissions
To use a MaxCompute sink connector to export messages to a MaxCompute table, you must grant the following permissions to the RAM role.
Object | Operation | Description |
---|---|---|
Project | CreateInstance | The permissions to create instances in projects. |
Table | Describe | The permissions to read the metadata of tables. |
Table | Alter | The permissions to modify the metadata of tables and the permissions to create and delete partitions. |
Table | Update | The permissions to overwrite data in tables and insert data into tables. |
For more information about the preceding permissions and how to grant these permissions, see MaxCompute permissions.
To grant the required permissions to AliyunKafkaMaxComputeUser1, perform the following steps:
- Log on to the MaxCompute client.
- Run the following command to add the AliyunKafkaMaxComputeUser1 RAM role as a RAM user:
add user `RAM$<accountid>:role/aliyunkafkamaxcomputeuser1`;
Note Replace <accountid> with the ID of your Alibaba Cloud account. - Grant the RAM user the minimum permissions that are required to access MaxCompute.
Create the topics that are required by a MaxCompute sink connector
In the ApsaraMQ for Kafka console, you can manually create the five topics that a MaxCompute sink connector requires. The five topics are the task offset topic, task configuration topic, task status topic, dead-letter queue topic, and error data topic. The five topics differ in partition count and storage engine. For more information, see Parameters in the Configure Source Service step.
- Log on to the ApsaraMQ for Kafka console.
- In the Resource Distribution section of the Overview page, select the region where your instance is deployed. Important You must create topics in the region where your application is deployed. When you create a topic, select the region where your Elastic Compute Service (ECS) instance is deployed. A topic cannot be used across regions. For example, if your message producers and consumers run on ECS instances that are deployed in the China (Beijing) region, create topics in the China (Beijing) region.
- On the Instances page, click the name of the instance that you want to manage.
- In the left-side navigation pane, click Topics.
- On the Topics page, click Create Topic.
- In the Create Topic panel, configure the parameters and click OK.
Parameter Description Example Name The name of the topic. demo Description The description of the topic. demo test Partitions The number of partitions in the topic. 12 Storage Engine Note For Standard Edition Message Queue for Apache Kafka instances, you can specify only Cloud Storage for the Storage Engine parameter.The storage engine of the topic. ApsaraMQ for Kafka supports the following storage engines:
- Cloud Storage: If you specify this value, the system uses Alibaba Cloud disks for the topic and stores data in three replicas in distributed mode. This storage engine provides the following benefits: low latency, high performance, durability, and high reliability. If you set the Instance Edition parameter to Standard (High Write) when you created the instance, you can specify only Cloud Storage as the value of the Storage Engine parameter.
- Local Storage: If you specify this value, the system uses the in-sync replicas (ISR) algorithm of open source Apache Kafka and stores data in three replicas in distributed mode.
Cloud Storage Message Type The message type of the topic. - Normal Message: By default, messages of the same key are stored in the same partition in the order in which the messages are sent. When a broker in the cluster fails, the order of the messages may not be preserved in affected partitions. If you set the Storage Engine parameter to Cloud Storage, this parameter is automatically set to Normal Message.
- Partitionally Ordered Message: By default, messages of the same key are stored in the same partition in the order in which the messages are sent. When a broker in the cluster fails, the messages are still stored in the affected partitions in the order in which the messages are sent. The affected partitions cannot store new messages until the partitions are restored. If you set the Storage Engine parameter to Local Storage, this parameter is automatically set to Partitionally Ordered Message.
Normal Message Log Cleanup Policy The log cleanup policy for the topic. If you set the Storage Engine parameter to Local Storage, you must configure the Log Cleanup Policy parameter. You can set the Storage Engine to Local Storage only for Professional Edition Message Queue for Apache Kafka instances.
ApsaraMQ for Kafka provides the following log cleanup policies:
- Delete: The default log cleanup policy is used. If sufficient storage space is available in the system, messages are retained based on the maximum retention period. After the storage usage exceeds 85%, the system deletes messages in the order in which the messages are stored. The earliest message that is stored is the first message that is deleted. This helps ensure that the performance of the service is not degraded.
- Compact: The Apache Kafka log compaction policy is used. Log compaction ensures that Apache Kafka retains at least the last known value for each message key. This policy applies to scenarios such as restoring the system state after the application crashes or the system fails, or reloading caches after the application restarts during operational maintenance. For example, when you use Kafka Connect or Confluent Schema Registry, you must store the information about the system status and configurations in a log-compacted topic. Important You can use log-compacted topics only in specific cloud-native components such as Kafka Connect and Confluent Schema Registry. You cannot use the log compaction policy for a topic that is used to send and receive messages in other components. For more information, see aliware-kafka-demos.
Compact Tag The tags that you want to attach to the topic. demo After the topic is created, the topic is displayed on the Topics page.
Create the group that is required by a MaxCompute sink connector
In the ApsaraMQ for Kafka console, you can manually create the group that is required by a MaxCompute sink connector. The name of the group must be in the connect-task name format. For more information, see Parameters in the Configure Source Service step.
- Log on to the ApsaraMQ for Kafka console.
- In the Resource Distribution section of the Overview page, select the region where your instance is deployed.
- On the Instances page, click the name of the instance that you want to manage.
- In the left-side navigation pane, click Groups.
- On the Groups page, click Create Group.
- In the Create Group panel, enter the group name in the Group ID field and the group description in the Description field, attach tags to the group, and then click OK. After the group is created, you can view the group on the Groups page.
Create and deploy a MaxCompute sink connector
To create and deploy a MaxCompute sink connector that is used to export data from ApsaraMQ for Kafka to MaxCompute, perform the following steps:
- Log on to the ApsaraMQ for Kafka console.
- In the Resource Distribution section of the Overview page, select the region where your instance is deployed.
- On the Instances page, click the name of the instance that you want to manage.
- In the left-side navigation pane, click Connectors.
- On the Connectors page, click Create Connector.
- In the Create Connector wizard, perform the following steps:
- Go to the Connectors page, find the connector that you created, and then click Deploy in the Actions column.
Send a test message
After you deploy the MaxCompute sink connector, you can send a message to the data source topic in ApsaraMQ for Kafka to test whether the message can be exported to MaxCompute.
- On the Connectors page, find the connector that you want to use and click Test in the Actions column.
- In the Send Message panel, configure the required parameters to send a test message.
- Set the Method of Sending parameter to Console.
- In the Message Key field, enter the key of the message. For example, you can enter demo as the key of the message.
- In the Message Content field, enter the content of the message. For example, you can enter {"key": "test"} as the content of the message.
- Configure the Send to Specified Partition parameter to specify whether to send the message to a specified partition.
- If you want to send the message to a specified partition, click Yes and enter the partition ID in the Partition ID field. For example, you can enter 0 as the partition ID. For information about how to query partition IDs, see View partition status.
- If you do not want to send the message to a specified partition, click No.
- Set the Method of Sending parameter to Docker and run the docker commands that are provided in the Run the Docker container to produce a sample message section to send a test message.
- Set the Method of Sending parameter to SDK and click the link to the topic that describes how to obtain and use the SDK that you want to use. Then, use the SDK to send and consume a test message. Message Queue for Apache Kafka provides topics that describe how to use SDKs for different programming languages based on different connection types.
- Set the Method of Sending parameter to Console.
View data in the MaxCompute table
After you send a message to the data source topic in ApsaraMQ for Kafka, you can log on to the MaxCompute client to check whether the message is received.
To view the test_kafka table, perform the following steps:
- Log on to the MaxCompute client.
- Run the following command to view the partitions of the table:
show partitions test_kafka;
In this example, the following result is returned:pt=11-17-2020 15 OK
- Run the following command to view the data stored in the partitions:
select * from test_kafka where pt ="11-17-2020 14";
In this example, the following result is returned:+----------------------+------------+------------+-----+-------+---------------+ | topic | partition | offset | key | value | pt | +----------------------+------------+------------+-----+-------+---------------+ | maxcompute-test-input| 0 | 0 | 1 | 1 | 11-17-2020 14 | +----------------------+------------+------------+-----+-------+---------------+