重要
このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。
Amazon SQS Source Connector for Confluent Cloud¶
注釈
Confluent Platform 用にコネクターをローカルにインストールする場合は、「Amazon SQS Source Connector for Confluent Platform」を参照してください。
Kafka Connect Amazon Simple Queue Service(SQS)Source Connector を使用すると、メッセージを Amazon SQS Queue のキューから Apache Kafka® に移動できます。標準キュー と FIFO(先入れ先出し)キュー の両方がサポートされます。コネクターは、Amazon SQS キューをポーリングし、SQS メッセージを Kafka レコードに変換して、それを Kafka のトピックにプッシュします。
コネクターは、Amazon SQS メッセージを以下の構造の Kafka レコードに変換します。
- キーによって、SQS キュー名とメッセージ ID が構造体にエンコードされます。FIFO キューの場合は、メッセージグループ ID も含まれます。
- 値によって、SQS メッセージの本文とさまざまなメッセージ属性が構造体にエンコードされます。
- 各ヘッダーによって、SQS メッセージに存在する可能性があるメッセージ属性がエンコードされます。
レコードスキーマの詳細については、「レコードスキーマ」を参照してください。
標準キュー の場合、コネクターは、ベストエフォート方式の順序付け保証をサポートしています。これは、Kafka にレコードが異なる順序で書き込まれる可能性があることを意味します。
FIFO キュー の場合、コネクターは、送信先の Kafka のトピックが厳密に 1 パーティションである場合に限り、レコードが Amazon SQS に挿入されたときと同じ順番で Kafka に挿入されることを保証します。送信先トピックに複数のパーティションがある場合は、Single Message Transforms(SMT) を使用して、キーの MessageGroupId フィールドに基づくパーティションを設定できます。
コネクターでは 少なくとも 1 回のデリバリー が行われます。これは、コネクターが、標準キューと FIFO キューの両方で Kafka に重複レコードを書き込む可能性があることを意味します。
機能¶
Amazon SQS Source Connector には、以下の機能があります。
- トピックの自動作成: このコネクターは Kafka トピックを自動的に作成できます。
- 少なくとも 1 回のデリバリー: コネクターによって、レコードが Kafka のトピックに少なくとも 1 回は配信されることが保証されます。
- 複数のタスクのサポート: このコネクターは、1 つまたは複数のタスクの実行をサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。
- 自動再試行: Amazon SQS サービスで障害が発生した場合は、すべてのリクエスト(再試行可能なもの)がコネクターによって再試行されます。再試行のデフォルト値は 3 回です。
- サポートされるデータフォーマット: このコネクターは、Avro、JSON スキーマ(JSON-SR)、Protobuf、および JSON(スキーマレス)出力フォーマットをサポートします。スキーマレジストリ ベースのフォーマット(Avro、JSON スキーマ、Protobuf など)を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。
Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。
制限¶
以下の情報を確認してください。
- コネクターの制限事項については、Amazon SQS Source Connector の制限事項を参照してください。
- 1 つ以上の Single Message Transforms(SMT)を使用する場合は、「SMT の制限」を参照してください。
- Confluent Cloud Schema Registry を使用する場合は、「スキーマレジストリ Enabled Environments」を参照してください。
クイックスタート¶
このクイックスタートを使用して、Confluent Cloud Amazon SQS Source Connector の利用を開始することができます。このクイックスタートでは、コネクターを選択し、イベントをストリーミングするようにコネクターを構成するための基本的な方法について説明します。
- 前提条件
- アマゾンウェブサービス (AWS)、Microsoft Azure (Azure)、または Google Cloud Platform (GCP)上の Confluent Cloud クラスターへのアクセスを許可されていること。
- Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
- ネットワークに関する考慮事項については、「Networking and DNS Considerations」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。
- アクセスキー を構成した AWS アカウント。コネクターを設定するときに、これらのアクセスキーを使用します。
- Amazon SQS 接続の詳細情報。詳細については、『Amazon SQS のセットアップ』を参照してください。
Confluent Cloud Console の使用¶
ステップ 1: Confluent Cloud クラスターを起動します。¶
インストール手順については、「Quick Start for Confluent Cloud」を参照してください。
ステップ 2: コネクターを追加します。¶
左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。
Step 4: Enter the connector details.¶
注釈
- すべての 前提条件 を満たしていることを確認してください。
- アスタリスク ( * ) は必須項目であることを示しています。
At the Add Amazon SQS Source Connector screen, complete the following:
- Select the way you want to provide Kafka Cluster credentials. You can
choose one of the following options:
- Global Access: Allows your connector to access everything you have access to. With global access, connector access will be linked to your account. This option is not recommended for production.
- Granular access: Limits the access for your connector. You will be able to manage connector access through a service account. This option is recommended for production.
- Use an existing API key: Allows you to enter an API key and secret part you have stored. You can enter an API key and secret (or generate these in the Cloud Console).
- Click Continue.
- Amazon SQS connection の詳細情報を入力します。
- AWS Access Key: The Amazon Access Key used to connector to SQS.
- AWS Secret Key: The Amazon Secret Key used to connector to SQS.
- Fully qualified SQS URL: Fully qualified Amazon SQS URL to read
messages from. For example,
https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue
. For details, see Amazon SQS queue and message identifiers. - SQS Region: SQS キューが属する AWS リージョン。何も指定しない場合、コネクターは SQS URL からリージョンが推測しようとします。
- Click Continue.
Select the output record value format (Data going to the Kafka topic): AVRO, JSON_SR (JSON Schema), PROTOBUF, or JSON. Schema Registry must be enabled to use a スキーマレジストリ-based format (for example, Avro, JSON Schema, or Protobuf). See スキーマレジストリ Enabled Environments for additional information.
注釈
For transforms and predicates, see the Single Message Transforms (SMT) documentation for details. Also, see 構成プロパティ for all property values and descriptions.
Click Continue.
Based on the number of topic partitions you select, you will be provided with a recommended number of tasks.
- To change the number of tasks, use the Range Slider to select the desired number of tasks.
- Click Continue.
Verify the connection details by previewing the running configuration.
Once you've validated that the properties are configured to your satisfaction, click Launch.
コネクターのステータスが Provisioning から Running に変わります。
Step 5: Check for records.¶
レコードが Kafka のトピックに生成されていることを確認します。
Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。
Confluent CLI の使用¶
以下の手順に従うと、Confluent CLI を使用してコネクターをセットアップし、実行できます。
注釈
- すべての 前提条件 を満たしていることを確認してください。
- コマンド例では Confluent CLI バージョン 2 を使用しています。詳細については、「Confluent CLI v2 への移行 <https://docs.confluent.io/confluent-cli/current/migrate.html#cli-migrate>`__」を参照してください。
ステップ 2: コネクターの必須の構成プロパティを表示します。¶
以下のコマンドを実行して、コネクターの必須プロパティを表示します。
confluent connect plugin describe <connector-catalog-name>
例:
confluent connect plugin describe SqsSource
出力例:
Following are the required configs:
connector.class: SqsSource
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
sqs.url
kafka.topic
aws.access.key.id
aws.secret.key.id
output.data.format
tasks.max
ステップ 3: コネクターの構成ファイルを作成します。¶
コネクター構成プロパティを含む JSON ファイルを作成します。以下の入力例は、必須の構成プロパティを示しています。
{
"name": "SqsSource_0",
"config": {
"connector.class": "SqsSource",
"name": "SqsSource_0",
"kafka.auth.mode": "KAFKA_API_KEY",
"kafka.api.key": "<my-kafka-api-key>",
"kafka.api.secret": "<my-kafka-api-secret>",
"sqs.url": "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue",
"kafka.topic": "stocks",
"aws.access.key.id": "<INSERT AWS API KEY>",
"aws.secret.access.key": "<INSERT AWS API SECRET>",
"output.data.format": "JSON",
"tasks.max": "1"
}
}
以下のプロパティ定義に注意してください。
"connector.class"
: コネクターのプラグイン名を指定します。"name"
: 新しいコネクターの名前を設定します。
"kafka.auth.mode"
: 使用するコネクターの認証モードを指定します。オプションはSERVICE_ACCOUNT
またはKAFKA_API_KEY
(デフォルト)です。API キーとシークレットを使用するには、構成プロパティkafka.api.key
とkafka.api.secret
を構成例(前述)のように指定します。サービスアカウント を使用するには、プロパティkafka.service.account.id=<service-account-resource-ID>
に リソース ID を指定します。使用できるサービスアカウントのリソース ID のリストを表示するには、次のコマンドを使用します。confluent iam service-account list
例:
confluent iam service-account list Id | Resource ID | Name | Description +---------+-------------+-------------------+------------------- 123456 | sa-l1r23m | sa-1 | Service account 1 789101 | sa-l4d56p | sa-2 | Service account 2
"sqs.url"
:https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue
のように入力します。詳細については、『Amazon SQS キューとメッセージの識別子』を参照してください。"sqs.region"
: SQS キューが属する AWS リージョン。このプロパティを使用しない場合、コネクターは SQS URL からリージョンが推測しようとします。"aws.access.key.id"
および"aws.secret.access.key"
: AWS のアクセスキー ID とシークレットを入力します。これらのセットアップ方法については、「プログラムによるアクセス」を参照してください。"output.data.format"
: 出力データフォーマット( Kafka トピックに送られるデータ)として AVRO、JSON_SR(JSON スキーマ)、PROTOBUF、または JSON(スキーマレス)を入力します。スキーマレジストリ ベースのフォーマット(Avro、JSON_SR(JSON スキーマ)、Protobuf など)を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。"tasks.max"
: このコネクターで使用する タスク の数を入力します。タスクが多いほどパフォーマンスが向上する可能性があります。
Single Message Transforms: CLI を使用する SMT の追加の詳細については、Single Message Transforms(SMT) のドキュメントを参照してください。
すべてのプロパティの値と説明については、「構成プロパティ」を参照してください。
ステップ 4: プロパティファイルを読み込み、コネクターを作成します。¶
以下のコマンドを入力して、構成を読み込み、コネクターを起動します。
confluent connect create --config <file-name>.json
例:
confluent connect create --config sqs-source-config.json
出力例:
Created connector SqsSource_0 lcc-do6vzd
ステップ 5: コネクターのステータスを確認します。¶
以下のコマンドを入力して、コネクターのステータスを確認します。
confluent connect list
出力例:
ID | Name | Status | Type | Trace
+------------+------------------+---------+--------+-------+
lcc-do6vzd | SqsSource_0 | RUNNING | source | |
ステップ 6: レコードを確認します。¶
レコードが Kafka のトピックに生成されていることを確認します。
Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。
構成プロパティ¶
このコネクターでは、以下のコネクター構成プロパティを使用します。
データへの接続方法(How should we connect to your data?)¶
name
コネクターの名前を設定します。
- 型: string
- 指定可能な値: 最大 64 文字の文字列
- 重要度: 高
Kafka クラスターの認証情報(Kafka Cluster credentials)¶
kafka.auth.mode
Kafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。
- 型: string
- デフォルト: KAFKA_API_KEY
- 指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
- 重要度: 高
kafka.api.key
- 型: password
- 重要度: 高
kafka.service.account.id
Kafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。
- 型: string
- 重要度: 高
kafka.api.secret
- 型: password
- 重要度: 高
データの送信先トピック(Which topic do you want to send data to?)¶
kafka.topic
データの書き込み先トピック名を指定します。
- 型: string
- 重要度: 高
AWS 認証情報(AWS Credentials)¶
aws.access.key.id
SQS への接続に使用される Amazon アクセスキー。
- 型: password
- 重要度: 高
aws.secret.key.id
SQS への接続に使用される Amazon シークレットキー。
- 型: password
- 重要度: 高
Amazon SQS への接続方法(How should we connect to Amazon SQS?)¶
sqs.url
メッセージの読み取り元の完全修飾 Amazon SQS URL。
- 型: string
- 重要度: 高
sqs.region
SQS キューが属する AWS リージョン。何も指定しない場合、コネクターは SQS URL からリージョンの推論を試みます。
- 型: string
- 重要度: 中
出力メッセージ(Output messages)¶
output.data.format
Kafka 出力レコード値のフォーマットを設定します。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、または JSON です。スキーマベースのメッセージフォーマット(AVRO、JSON_SR、PROTOBUF など)を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください
- 型: string
- 重要度: 高
このコネクターのタスク数(Number of tasks for this connector)¶
tasks.max
- 型: int
- 指定可能な値: [1,...]
- 重要度: 高
レコードスキーマ¶
Amazon SQS Source Connector では、以下のスキーマを使用してレコードが作成されます。
キースキーマ¶
キーは以下のフィールドを持つ struct
です。
フィールド名 | スキーマの型 | 省略可能かどうか | 説明 |
---|---|---|---|
QueueUrl | string | 必須 | レコードの生成元の完全修飾 SQS キュー URL。 |
MessageId | string | 必須 | Amazon SQS 内のメッセージの一意のメッセージ ID。 |
MessageGroupId | string | 省略可能 | FIFO キューの場合、これはメッセージグループ ID です。 |
値スキーマ¶
値は以下のフィールドを持つ struct
です。
フィールド名 | スキーマの型 | 省略可能かどうか | 説明 |
---|---|---|---|
Body | string | SQS メッセージの本文。 | |
ApproximateFirstReceiveTimestamp | int64 | キューからメッセージが最初に受信された時刻をエポック時間(ミリ秒)で返します。 | |
ApproximateReceiveCount | int32 | すべてのキューでメッセージが受信されても削除されなかった回数を返します。 | |
SenderId | string | このメッセージを SQS に送信した IAM ユーザーまたはロール。 | |
SentTimestamp | int64 | メッセージがキューに送信された時刻をエポック時間(ミリ秒)で返します。 | |
MessageDeduplicationId | string | 省略可能 | SendMessage アクションを呼び出すプロデューサーによって提供される値を返します。 |
MessageGroupId | string | 省略可能 | SendMessage アクションを呼び出すプロデューサーによって提供される値を返します。同じ MessageGroupId のメッセージは順に返されます。 |
SequenceNumber | string | Amazon SQS によって提供される値を返します。 |
詳細については『 Request Parameters 』を参照してください。
ヘッダースキーマ¶
SQS の各メッセージ属性は、Kafka でヘッダーに変換されます。
- ヘッダーキーは、メッセージ属性の名前です。
- ヘッダー値は、メッセージ属性の値です。
- ヘッダースキーマは、メッセージ属性のデータ型に依存します。
- 文字列のメッセージ属性は、文字列スキーマを使用します。
- 数字のメッセージ属性は、文字列スキーマを使用します。
- バイナリのメッセージ属性は、バイトスキーマを使用します。
- カスタムのメッセージ属性は、カスタム属性の型に応じて、文字列またはバイトを使用します。
詳細については、「メッセージ属性コンポーネント」を参照してください。
次のステップ¶
参考
フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。