1. Home
  2. Cloud
  3. Confluent Cloud への外部システムの接続

重要

このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。

Amazon Kinesis Source Connector for Confluent Cloud

注釈

Confluent Platform 用にコネクターをローカルにインストールする場合は、「Amazon Kinesis Source Connector for Confluent Platform」を参照してください。

Kafka Connect Amazon Kinesis Source Connector for Confluent Cloud を使用すると、Amazon Kinesis からデータをプルして、そのデータを Apache Kafka® トピックに保持することができます。

機能

Amazon Kinesis Source Connector には、以下の機能があります。

  • トピックの自動作成: このコネクターは Kafka トピックを自動的に作成できます。
  • 1 つの Kinesis ストリームの すべてのシャードからレコードをフェッチ します。
  • 厳選された構成プロパティ:
    • オフセット位置
      • AT_TIMESTAMP
      • LATEST
      • TRIM_HORIZON
      • kinesis.shard.timestamp.ms
    • その他のプロパティ
      • kinesis.region
      • kinesis.record.limit
      • kinesis.throughput.exceeded.backoff.ms

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

制限

以下の情報を確認してください。

クイックスタート

このクイックスタートを使用して、Confluent Cloud Kinesis Source Connector の利用を開始することができます。このクイックスタートでは、コネクターを選択してから、Amazon Kinesis からデータをプルして Apache Kafka® トピックに保存するようにコネクターを構成する方法について説明します。コネクターは、それ以降に発生する行レベルの変更をすべてモニタリングして記録するようになります。

前提条件
  • Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
    • 既存の サービスアカウント のリソース ID を入力する。
    • コネクター用の Confluent Cloud サービスアカウント を作成します。「サービスアカウント」のドキュメントで、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
    • Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。

Confluent Cloud Console の使用

ステップ 1: Confluent Cloud クラスターを起動します。

インストール手順については、「Quick Start for Confluent Cloud」を参照してください。

ステップ 2: コネクターを追加します。

左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。

ステップ 3: コネクターを選択します。

Click the Amazon Kinesis Source connector card.

Amazon Kinesis Source Connector Card

ステップ 4: コネクターの詳細情報を入力します。

注釈

  • すべての 前提条件 を満たしていることを確認してください。
  • アスタリスク （ * ）は必須項目であることを示しています。

Add Amazon Kinesis Source Connector 画面で、以下を実行します。

Topics リストから、データの送信先のトピックを選択します。新しいトピックを作成するには、+Add new topic をクリックします。

ステップ 5: Kafka トピックを確認します。

コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

../_images/topology.ja.png

Confluent CLI の使用

以下の手順に従うと、Confluent CLI を使用してコネクターをセットアップし、実行できます。

注釈

重要

このコネクターを作成して起動する前に、トピック名を作成しておく必要があります。このクイックスタートの例では、ソースとして使用するデータベーステーブルの名前は kinesis-testing です。この手順を開始する前に、次のコマンドを使用して、kinesis-testing という名前の Kafka トピックを作成してください。

confluent kafka topic create kinesis-testing

ステップ 1: 使用可能なコネクターをリスト表示します。

以下のコマンドを入力して、使用可能なコネクターをリスト表示します。

confluent connect plugin list

ステップ 2: コネクターの必須の構成プロパティを表示します。

以下のコマンドを実行して、コネクターの必須プロパティを表示します。

confluent connect plugin describe <connector-catalog-name>

例:

confluent connect plugin describe KinesisSource

出力例:

Following are the required configs:
connector.class
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
kafka.topic
aws.access.key.id
kinesis.region
aws.secret.key.id
kinesis.stream
kinesis.position
tasks.max

ステップ 3: コネクターの構成ファイルを作成します。

コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティを示しています。

{
    "name" : "confluent-kinesis-source",
    "connector.class": "KinesisSource",
    "kafka.auth.mode": "KAFKA_API_KEY",
    "kafka.api.key": "<my-kafka-api-key>",
    "kafka.api.secret" : "<my-kafka-api-secret>",
    "kafka.topic" : "kinesis-testing",
    "aws.access.key.id" : "<my-aws-access-key>",
    "aws.secret.key.id": "<my-aws-access-key-secret>",
    "kinesis.stream": "my-kinesis-stream",
    "kinesis.region" : "us-west-2",
    "kinesis.position": "AT_TIMESTAMP",
    "kinesis.shard.timestamp.ms": "1590692978237"
    "tasks.max" : "1"
}

以下のプロパティ定義に注意してください。

  • "name": 新しいコネクターの名前を設定します。
  • "connector.class": コネクターのプラグイン名を指定します。

  • "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

  • "kinesis.region": Kinesis データストリームが存在する AWS リージョンを指定します。たとえば、us-west-2、us-east-2、ap-northeast-1、eu-central-1 などです。

  • （オプション） "kinesis.position": ストリームのオフセット位置を指定します。これは、Kinesis ストリームのメッセージの消費を開始する位置です。指定可能なオフセット位置は次のとおりです。

    • AT_TIMESTAMP: 特定の時点からレコードの取得を開始します。以下のタイムスタンプフォーマットと一緒に使用します。
    • LATEST: 最新のレコードから開始します。
    • TRIM_HORIZON （デフォルト） : トリミングされていない最後のレコード（一番古いレコード）から開始します。

  • （省略可能） "kinesis.shard.timestamp.ms": AT_TIMESTAMP を選択する場合に使用するタイムスタンプフォーマット。指定可能なフォーマットは、単純な日付-時間フォーマットの yyyy-MM-dd'T'HH:mm:ss.SSSXXX またはエポック時間（ミリ秒）です。

  • "tasks.max": コネクターの タスク の最大数。

Single Message Transforms: SMT 追加の詳細については、Single Message Transforms（SMT） のドキュメントを参照してください。このコネクターでサポートされていない SMT のリストについては、「サポートされない変換」を参照してください。

すべてのプロパティの値と定義については、「構成プロパティ」を参照してください。

ステップ 4: プロパティファイルを読み込み、コネクターを作成します。

以下のコマンドを入力して、構成を読み込み、コネクターを起動します。

confluent connect create --config <file-name>.json

例:

confluent connect create --config kinesis-source.json

出力例:

Created connector confluent-kinesis-source lcc-ix4dl

ステップ 5: コネクターのステータスを確認します。

以下のコマンドを入力して、コネクターのステータスを確認します。

confluent connect list

出力例:

ID          |           Name           | Status  |  Type
+-----------+--------------------------+---------+--------+
lcc-ix4dl   | confluent-kinesis-source | RUNNING | source

ステップ 6: Kafka トピックを確認します。

コネクターが実行中になったら、メッセージが 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

Kinesis への接続に使用される Amazon アクセスキー。

  • 型: password
  • 重要度: 高
aws.secret.key.id

Kinesis への接続に使用される Amazon シークレットキー。

  • 型: password
  • 重要度: 高

Kinesis の詳細（Kinesis details）

kinesis.region

Kinesis ストリームの AWS リージョン。

  • 型: string
  • デフォルト: us-west-2
  • 重要度: 高
kinesis.stream

読み取る Kinesis ストリーム。

  • 型: string
  • 重要度: 高
kinesis.shard.timestamp

タイムスタンプ（精度がミリ秒の Unix エポック日付）。この後からレコードの読み取りが開始されます。kinesis.shard.position=AT_TIMESTAMP との組み合わせでのみ使用されます。許可されているフォーマットは、yyyy-MM-dd'T'HH:mm:ss.SSSXXX またはエポック時刻（ミリ秒）です。注: これは、ストリーム内の指定されたすべてのシャードに適用されます。

  • 型: string
  • 重要度: 低
kinesis.position

オフセットが保管されていない場合にリセットされるストリーム内の位置。

  • 型: string
  • デフォルト: TRIM_HORIZON
  • 重要度: 低
kinesis.record.deaggregation.enable

Set this value as true if you want to de-aggregate individual Kinesis Record (aggregated using KPL) into separate Source Record(s)

  • Type: boolean
  • Default: false
  • 重要度: 低

接続の詳細（Connection details）

kinesis.record.limit

Kinesis シャードに対する 1 回のポーリングで読み取るレコード数。

  • 型: int
  • デフォルト: 500
  • 指定可能な値: [1、…、10000]
  • 重要度: 低
kinesis.throughput.exceeded.backoff.ms

スループット超過の例外がスローされた場合にバックオフする時間（ミリ秒）。

  • 型: long
  • デフォルト: 10000（10 秒）
  • 指定可能な値: [500、…]
  • 重要度: 低
kinesis.empty.records.backoff.ms

ストリームが空の場合にバックオフする時間（ミリ秒）。

  • 型: long
  • デフォルト: 5000（5 秒）
  • 指定可能な値: [500、…]
  • 重要度: 低

このコネクターのタスク数（Number of tasks for this connector）

tasks.max
  • 型: int
  • 指定可能な値: [1、…]
  • 重要度: 高

おすすめの記事

以下のブログ記事には、Confluent Cloud Amazon Kinesis Source Connector を使用して、Amazon Kinesis の模擬支払いストリームを Confluent Cloud に取り込むサンプルパイプラインのセットアップ手順が記載されています。

ブログ記事: How Merging Companies Will Give Rise to Unified Data Streams

次のステップ

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

../_images/topology.ja.png