Amazon Kinesis Data Streams
開発者ガイド

Node.js での Kinesis Client Library コンシューマーの開発

Kinesis データストリームのデータを処理するアプリケーションを構築するには、Kinesis Client Library (KCL) を使用できます。Kinesis Client Library は、複数の言語で使用できます。このトピックでは、Node.js について説明します。

KCL は Java ライブラリです。Java 以外の言語のサポートは、MultiLangDaemon という多言語インターフェイスを使用して提供されます。このデーモンは Java ベースで、Java 以外の KCL 言語を使用するときに実行されます。 そのため、KCL for Node.js をインストールして、コンシューマーアプリケーションをすべて Node.js で書く場合でも、MultiLangDaemon を使用するために、Java をシステムにインストールする必要があります。さらに、MultiLangDaemon には、接続先の AWS リージョンなど、ユースケースに合わせてカスタマイズする必要のあるデフォルト設定例があります。GitHub の MultiLangDaemon の詳細については「KCL MultiLangDaemon project」のページを参照してください。

GitHub から Node.js KCL をダウンロードするには、Kinesis Client Library (Node.js) を参照してください。

サンプルコードのダウンロード

Node.js の KCL で使用可能な 2 つのサンプルコードがあります。

  • 基本サンプル

    Node.js で KCLコンシューマーアプリケーションを構築する方法の基本を説明する次のセクションで使用されます。

  • click-stream-sample

    基本サンプルコードを理解したあとの、やや上級で実際のシナリオを使用したサンプル。このサンプルはここでは説明しませんが、詳細を説明した README ファイルがあります。

Node.js で KCLコンシューマーアプリケーションを実装する場合は、次のタスクを完了する必要があります。

レコードプロセッサを実装する

KCL for Node.js を使用した最もシンプルなコンシューマーは、recordProcessor 関数を実装する必要があります。この関数には、initializeprocessRecords、および shutdown の各関数が含まれます。このサンプルでは、開始点として使用できる実装を提供しています (sample_kcl_app.js を参照してください)。

function recordProcessor() { // return an object that implements initialize, processRecords and shutdown functions.}

initialize

レコードプロセッサが起動すると、KCL は initialize 関数を呼び出します。このレコードプロセッサは initializeInput.shardId として渡されるシャード ID のみを処理し、通常、その逆も真です (このシャードはこのレコードプロセッサによってのみ処理されます)。ただし、コンシューマーでは、データレコードが複数回処理される可能性に対応する必要があります。これは、Kinesis Data Streams では「少なくとも 1 回」をセマンティクスとしており、シャードの各データレコードがコンシューマーのワーカーによって 1 回以上処理されるためです。特定のシャードが複数のワーカーによって処理される可能性がある場合の詳細については、「リシャーディング、拡張、並列処理」を参照してください。

initialize: function(initializeInput, completeCallback)

processRecords

KCL は、この関数を呼び出すために initialize 関数に指定したシャードのデータレコードのリストが含まれている入力を使用します。実装するレコードプロセッサは、コンシューマーのセマンティクスに従って、これらのレコードのデータを処理します。たとえば、ワーカーはデータの変換を実行し、その結果を Amazon Simple Storage Service (Amazon S3) バケットに保存する場合があります。

processRecords : function (processRecordsInput, completeCallback)

データ自体に加えて、レコードにもシーケンス番号とパーティションキーが含まれ、ワーカーはデータを処理するときに、これらを使用できます。たとえば、ワーカーは、パーティションのキーの値に基づいて、データを格納する S3 バケットを選択できます。record ディクショナリは、レコードのデータ、シーケンス番号、およびパーティションキーにアクセスする次のキーと値のペアを公開します。

record.data record.sequenceNumber record.partitionKey

データは Base64 でエンコードされていることに注意してください。

基本サンプルでは、関数 processRecords に、ワーカーでレコードのデータ、シーケンス番号、およびパーティションキーにアクセスする方法を示すコードが含まれています。

Kinesis Data Streams では、シャードで既に処理されたレコードを追跡するためにレコードプロセッサが必要です。KCL は、processRecordsInput.checkpointer として渡した checkpointer オブジェクトを使用して、この追跡を処理します。レコードプロセッサは、checkpointer.checkpoint 関数を呼び出して、シャード内のレコードの処理の進行状況を KCL に知らせます。ワーカーでエラーが発生した場合、シャードの処理を再開するときに、処理されたことが分かっている最後のレコードから再開するように、KCL はこの情報を使用します。

分割または結合オペレーションの場合、KCL は、元のシャードのプロセッサが checkpoint を呼び出して元のシャードの処理がすべて完了したことを通知するまで、新しいシャードの処理を開始しません。

checkpoint 関数にシーケンス番号を渡さないと、checkpoint への呼び出しは、レコードプロセッサに最後のレコードを渡した時点までのすべてのレコードが処理済みであることを意味すると KCL で見なされます。したがって、レコードプロセッサは、渡されたリストにあるすべてのレコードの処理が完了した場合に限りcheckpoint を呼び出す必要があります。レコードプロセッサは、checkpoint の各呼び出しで processRecords を呼び出す必要はありません。たとえば、プロセッサは checkpoint を 3 回の呼び出しごとに呼び出したり、レコードプロセッサの外部イベント (実装したカスタムの認証または検証サービスなど) で呼び出したりできます。

オプションでレコードの正確なシーケンス番号をパラメータとして checkpoint に指定できます。この場合、KCL は、すべてのレコードがそのレコードまで処理されたと見なします。

基本サンプルアプリケーションでは、checkpointer.checkpoint 関数の最もシンプルな呼び出しを示します。関数のこの時点でコンシューマーに必要な他のチェックポイントロジックを追加できます。

shutdown

KCL は、処理が終了した場合 (shutdownInput.reasonTERMINATE) またはワーカーが応答していない場合 (shutdownInput.reasonZOMBIE)、shutdown 関数を呼び出します。

shutdown: function(shutdownInput, completeCallback)

シャードが分割または結合されたか、ストリームが削除されたため、レコードプロセッサがシャードからこれ以上レコードを受信しない場合は、処理が終了します。

また、KCL は、shutdownInput.checkpointer オブジェクトを shutdown に渡します。シャットダウンの理由が TERMINATE である場合、レコードプロセッサがすべてのデータレコードの処理を終了したことを確認し、このインターフェイスの checkpoint 関数を呼び出します。

設定プロパティを変更する

このサンプルでは、設定プロパティのデフォルト値を提供します。これらのプロパティを独自の値にオーバーライドできます (基本サンプルの sample.properties を参照してください)。

アプリケーション名

KCL には、複数のアプリケーション間、および同じリージョン内の Amazon DynamoDB テーブル間で一意のアプリケーションが必要です。次のようにアプリケーション名の設定値を使用します。

  • このアプリケーション名と関連付けられたすべてのワーカーは、連係して同じストリームを処理していると見なされます。これらのワーカーは複数のインスタンスに分散している場合もあります。同じアプリケーションコードの追加のインスタンスを実行するときに、アプリケーション名が異なる場合、KCL は 2 番目のインスタンスを、同じストリームで動作するまったく別のアプリケーションと見なします。

  • KCL はアプリケーション名を使用して DynamoDB テーブルを作成し、このテーブルを使用してアプリケーションの状態情報 (チェックポイントやワーカーとシャードのマッピングなど) を保存します。各アプリケーションには、それぞれ DynamoDB テーブルがあります。詳細については、「Amazon Kinesis Data Streams Application の状態の追跡」を参照してください。

認証情報の設定

デフォルトの認証情報プロバイダチェーンのいずれかの認証情報プロバイダで AWS の認証情報を使用できるようにする必要があります。AWSCredentialsProvider プロパティを使用して認証情報プロバイダーを設定できます。sample.properties ファイルでは、デフォルトの認証情報プロバイダーチェーンのいずれかの認証情報プロバイダーに対して、ユーザーの認証情報を使用可能にする必要があります。Amazon EC2 インスタンスでコンシューマーを実行している場合は、インスタンスに IAM ロールを設定することをお勧めします。この IAM ロールに関連付けられたアクセス許可を反映する AWS の認証情報は、インスタンスメタデータを通じて、インスタンス上のアプリケーションで使用できるようになります。これは、EC2 インスタンスで実行されるコンシューマーアプリケーションの認証情報を管理するための最も安全な方法です。

次の例では、KCL を設定し、sample_kcl_app.js で指定されているレコードプロセッサを使用して「kclnodejssample」という Kinesis data stream を処理します。

# The Node.js executable script executableName = node sample_kcl_app.js # The name of an Amazon Kinesis stream to process streamName = kclnodejssample # Unique KCL application name applicationName = kclnodejssample # Use default AWS credentials provider chain AWSCredentialsProvider = DefaultAWSCredentialsProviderChain # Read from the beginning of the stream initialPositionInStream = TRIM_HORIZON