ApsaraMQ for Kafka:メッセージの取得

課金

• ApsaraMQ for Kafka のメッセージ取得機能はパブリック プレビュー中です。ApsaraMQ for Kafka は、パブリック プレビュー中はメッセージ取得機能に対して課金されません。

• メッセージ取得機能のパブリック プレビュー中は、Tablestore に自動的に作成されるインスタンスとテーブルに対して課金されません。

使用上の注意

• デフォルトでは、ApsaraMQ for Kafka インスタンスの最大 3 つのトピックに対して、同時にメッセージ取得機能を有効にできます。

• Tablestore の STRING 型の属性列の値は 2 MB を超えることはできません。サイズが 2 MB を超えるメッセージは同期または取得できません。

• Tablestore は、ApsaraMQ for Kafka インスタンスから同期されたメッセージを、ApsaraMQ for Kafka がメッセージを保持するのと同じ期間保持します。保持期間が経過すると、Tablestore は自動的にメッセージをクリアし、関連するインデックスを削除します。ApsaraMQ for Kafka でのメッセージ保持期間の構成と説明については、「メッセージの構成を変更する」をご参照ください。

  Tablestore のデータ有効期限ポリシーは、ApsaraMQ for Kafka のデータ有効期限ポリシーとは異なります。そのため、各メッセージ取得タスクによって取得されたメッセージは、指定された検索条件を満たすメッセージとは異なる場合があります。この場合、最終的な取得結果が優先されます。

メッセージ取得の手順

ステップ 1：メッセージ取得機能を有効にする

ApsaraMQ for Kafka インスタンスのトピックに対してメッセージ取得機能を有効にすると、ビジネス要件に基づいてトピック内のメッセージを取得できます。

1. ApsaraMQ for Kafka コンソール にログインします。

2. リソースの分布概要 ページの セクションで、管理する ApsaraMQ for Kafka インスタンスが存在するリージョンを選択します。

3. 左側のナビゲーションペインで、Instances をクリックします。

4. Instances ページで、管理するインスタンスの名前をクリックします。

5. 左側のナビゲーションペインで、メッセージ検索 をクリックします。表示されるページで、メッセージ検索の有効化 をクリックします。

6. メッセージ検索の有効化 パネルで、パラメータを構成し、[OK] をクリックします。

   説明

   ApsaraMQ for Kafka インスタンスのトピックに対して初めてメッセージ取得機能を有効にする場合、メッセージ検索の有効化 をクリックした後に、インスタンスのコネクタ機能を有効にしていないことを示すメッセージが表示されます。この場合、メッセージ内の [OK] をクリックし、メッセージ検索の有効化 パネルのパラメータを構成します。

   

   メッセージ取得機能を有効にするためのパラメータ

   パラメータ	説明	例
   データソース Topic	メッセージ取得機能を有効にするトピック。	test
   消費の開始位置	メッセージ消費を開始するオフセット。デフォルト値：一番新しいオフセット。有効な値： 一番古いオフセット：最も古いオフセットからメッセージを消費します。 一番新しいオフセット：最新のオフセットからメッセージを消費します。	一番新しいオフセット
   記録時間	取得された各メッセージが記録された時間。デフォルト値：インスタント時間。有効な値： ネイティブタイム：ApsaraMQ for Kafka によって記録されたメッセージ作成時間。これは、メッセージが送信されたときにプロデューサーによって記録されたタイムスタンプ、または ProducerRecord に指定した timestamp フィールドの値です。 インスタント時間：メッセージが Tablestore に同期された時間。 この値は、メッセージが生成された時間ではなく、Tablestore に同期された時間を指定します。そのため、検索結果の値は、メッセージが生成された時間と異なる場合があります。	ネイティブタイム

   メッセージ検索 ページで、メッセージ取得機能を有効にしたトピックを表示できます。

ステップ 2：テスト メッセージを送信する送信メッセージ

ApsaraMQ for Kafka インスタンスのトピックに対してメッセージ取得機能を有効にすると、トピックにメッセージを送信して、メッセージ取得タスクが作成されたかどうかをテストできます。

1. メッセージ検索 ページで、管理するトピックを見つけ、詳細操作 列の をクリックします。

2. [タスクの詳細] ページの右上隅にある テスト をクリックします。

3. メッセージの送信 パネルで、パラメータを構成し、[OK] をクリックします。

   1. メッセージキー フィールドに、メッセージ キーを入力します。例：demo。

   2. メッセージの内容 フィールドに、メッセージの内容を入力します。例：{"key": "test"}。

   3. 指定されたパーティションに送信 パラメータを構成して、テスト メッセージを特定のパーティションに送信するかどうかを指定します。

      • テスト メッセージを特定のパーティションに送信する場合は、はい をクリックし、パーティション ID フィールドにパーティション ID を入力します。例：0。パーティション ID を照会する方法については、「パーティション ステータスの表示」をご参照ください。

      • テスト メッセージを特定のパーティションに送信しない場合は、いいえ をクリックします。

ステップ 3: メッセージを取得する

1. メッセージ検索 ページで、管理するトピックを見つけ、検索操作 列の をクリックします。

2. 検索 パネルで、次の操作を実行して検索条件を指定します。検索条件ドロップダウンリストから項目を選択し、[検索条件を追加] をクリックし、[値] 列に検索条件を指定して、[OK] をクリックします。

   

   説明

   • 検索条件を指定する場合、パーティション、オフセットの範囲、時間の範囲、[キー]、[値] を含む、1 つ以上の値を選択できます。

   • メッセージを送信するときは、一意のビジネス識別子をキー値として使用することをお勧めします。こうすることで、検索中にメッセージを正確に一致させることができます。

   検索パラメータ

   取得するメッセージのキーまたは内容。次の項目では、検索キーワードを指定する際に従う必要があるルールについて説明します。フレーズ一致は、検索パターンとして使用されます。たとえば、メッセージキーが「ApsaraMQ for Kafka は、Alibaba Cloud によって提供される分散型の高スループットでスケーラブルなメッセージキューサービスです」である場合、検索キーワードを「分散型」または「Alibaba Cloud」と「分散型」の組み合わせに設定できます。検索キーワードにアスタリスク (*) または疑問符 (?) が含まれている場合、ワイルドカード一致パターンが使用されます。アスタリスク (*) は任意の文字列を指定します。疑問符 (?) は任意の文字を指定します。文字の大文字と小文字は区別されません。たとえば、メッセージの内容が「AliKafkaTest001qaz」の場合、検索キーワードを「AliKafkaTe*」と指定できます。検索効率を向上させるために、ワイルドカード文字で始まるキーワードは使用しないことをお勧めします。ワイルドカード文字を含む文字列は、長さが 20 文字を超えないようにしてください。トークン化、フレーズ一致、ワイルドカード一致の使用方法と制限の詳細については、「トークン化」、「一致フレーズクエリ」、および「ワイルドカードクエリ」をご参照ください。

   検索条件	説明
   パーティション	メッセージを取得するパーティション。
   オフセットの範囲	取得するメッセージのオフセット範囲。
   時間の範囲	取得するメッセージが該当する時間範囲。過去 3 日間以内の時間範囲を選択するか、カスタムの時間範囲を指定できます。指定できる時間範囲は分単位です。
   キー	取得するメッセージのキーまたは内容。 検索キーワードを指定する際に従う必要があるルールを以下に示します。 フレーズ一致は検索パターンとして使用されます。たとえば、メッセージ キーが「ApsaraMQ for Kafka は、Alibaba Cloud が提供する分散型の高スループットでスケーラブルなメッセージ キュー サービスです」の場合、検索キーワードを「分散型」または「Alibaba Cloud」と「分散型」の組み合わせに設定できます。 検索キーワードにアスタリスク (*) または疑問符 (?) が含まれている場合、ワイルドカード一致パターンが使用されます。アスタリスク (*) は任意の文字列を指定します。疑問符 (?) は任意の文字を指定します。文字の大文字と小文字は区別されません。たとえば、メッセージの内容が「AliKafkaTest001qaz」の場合、検索キーワードを「AliKafkaTe*」と指定できます。 取得効率を向上させるために、ワイルドカード文字で始まるキーワードを使用しないことをお勧めします。ワイルドカード文字を含む文字列の長さが 20 文字を超えないようにしてください。 トークン化、フレーズ一致、およびワイルドカード一致の使用法と制限については、「トークン化」、「一致フレーズ クエリ」、および「ワイルドカード クエリ」をご参照ください。
   値

3. [トピック検索] ページで、取得したメッセージを表示します。

   

   説明

   • 検索結果には最大 10 件のメッセージが表示されます。正確な一致のために正確な検索条件を指定することをお勧めします。

   • 取得された各メッセージの内容は、ApsaraMQ for Kafka コンソールに最大 1 KB まで表示できます。取得されたメッセージのサイズが 1 KB を超える場合、システムは自動的に内容を切り捨てます。メッセージの内容全体を表示する場合は、メッセージをダウンロードしてください。

   検索結果のパラメータ

   パラメータ	説明
   パーティション	メッセージが取得されたパーティション。
   オフセット	メッセージ オフセット。
   Key	メッセージ キー。キーは文字列に変換されます。
   Value	メッセージ値。メッセージの内容とも呼ばれます。メッセージ値は文字列に変換されます。
   メッセージ作成時間	メッセージが作成された時間、またはメッセージが Tablestore に同期された時間。 メッセージ作成時間は、メッセージの送信時にプロデューサーによって記録されたタイムスタンプ、または ProducerRecord に指定した timestamp フィールドの値です。 説明 timestamp フィールドに値を指定した場合、指定した値が表示されます。 timestamp フィールドに値を指定しなかった場合、メッセージが送信されたときのローカル システム時間が表示されます。 1970/x/x x:x:x 形式の値は、timestamp フィールドが 0 または無効な値に設定されていることを示します。
   操作	キーのダウンロード をクリックして、メッセージ キーをダウンロードします。 値のダウンロード をクリックして、メッセージの内容をダウンロードします。

関連操作

メッセージ取得タスクの詳細を表示する

トピックのメッセージ取得機能を有効にすると、メッセージ取得タスクが自動的に作成されます。 ApsaraMQ for Kafkaインスタンスに自動的に作成されるトピックやグループ、Tablestoreに自動的に作成されるインスタンスとテーブルの名前など、タスクの詳細を表示できます。また、[タスクの詳細] ページからTablestore テーブルの詳細ページに移動することもできます。

消費の詳細を表示する

トピックに対してメッセージ取得機能を有効にすると、トピックの各パーティションのアクティブな グループ の消費の進捗状況を表示できます。これは、メッセージの消費と累積に関する情報を取得するのに役立ちます。

メッセージ取得タスクを一時停止する

1. メッセージ検索 ページで、管理するトピックを見つけ、詳細 > 一時停止[アクション] 列の を選択します。

2. 表示されるメッセージで、[OK] をクリックします。

メッセージ取得タスクを再開する

ビジネス要件に基づいて、一時停止されたメッセージ取得タスクを再開できます。

1. メッセージ検索 ページで、管理するトピックを見つけ、詳細 > 有効にする[アクション] 列の を選択します。

2. 表示されるメッセージで、[OK] をクリックします。

メッセージ取得タスクを削除する

トピックのメッセージ取得タスクを削除すると、関連する Tablestore テーブルと検索インデックスも削除されます。トピックは、メッセージ取得機能を提供しなくなります。トピックに対してメッセージ取得機能を再度使用する場合は、メッセージ取得タスクを再作成し、データの同期が完了するまで待ちます。

1. メッセージ検索 ページで、管理するトピックを見つけ、メッセージ取得タスクのステータスに基づいて次のいずれかの操作を実行します。

   • タスクが [実行中] または [一時停止中] 状態ではない場合、[アクション] 列の 削除 をクリックします。

   • タスクが [実行中] または [一時停止中] 状態の場合、詳細 > 削除[アクション] 列の を選択します。

2. 表示されるメッセージで、[OK] をクリックします。

   メッセージ検索 ページには、メッセージ取得タスクが削除されたトピックは表示されなくなります。