ApsaraMQ for RocketMQ:メッセージトレースの照会

メッセージトレースデータ

ApsaraMQ for RocketMQでは、メッセージの完全なトレースには、プロデューサー、ブローカー、およびコンシューマーが含まれます。 各ロールがメッセージを処理すると、関連情報がトレースに追加されます。 集計された情報を使用して、メッセージのステータスを取得できます。

使用上の注意

メッセージの送信後、ApsaraMQ for RocketMQコンソールでメッセージの属性に基づいてメッセージのトレースを照会できます。 この機能は、すべてのタイプのメッセージに有効です。 メッセージトレース機能を使用する前に、次の点に注意してください。

メッセージトレースクエリの時間範囲

デフォルトでは、メッセージはApsaraMQ for RocketMQブローカーに3日間保存されます。 現在の時点の3日前に生成されたメッセージのトレースのみを照会できます。 たとえば、現在の時点が2023年11月30日の15:09:48の場合、2023年11月27日の15:09:48から2023年11月30日の15:09:48までに生成されたメッセージのトレースを照会できます。

クエリ結果に対する消費ステータスの影響

メッセージトレース機能をサポートするSDKのバージョン

拡張メッセージトレース機能を使用するための前提条件

基本的なメッセージトレース機能と比較して、拡張メッセージトレース機能を使用すると、ApsaraMQ for RocketMQコンソールでより多くのトレースデータを表示できます。 メッセージ消費中に生成されたトレースデータ、およびスケジュールされたメッセージ、遅延メッセージ、トランザクションメッセージのトレースデータを照会できます。 トレースクエリ結果で返されるパラメーターについては、「パラメーター」をご参照ください。

• Java用TCPクライアントSDK:

  • Java用TCPクライアントSDKがV2.x.x.Finalにアップグレードされました。

  • インスタンスは、中国 (杭州) 、中国 (青島) 、中国 (北京) 、中国 (張家口) 、中国 (フフホト) 、中国 (深セン) 、中国 (成都) 、ドイツ (フランクフルト) 、インドネシア (ジャカルタ) のいずれかのリージョンにデプロイする必要があります。

• C ++ のためのTCPクライアントSDK:

  • C ++ 用TCPクライアントSDKがV3.x.xにアップグレードされました。

  • インスタンスは任意のリージョンにデプロイできます。

一般的なシナリオ

本番環境でメッセージが送信または消費されない場合は、メッセージトレース機能を使用して問題のトラブルシューティングを行うことができます。 特定の時間範囲内のメッセージID、メッセージキー、またはトピックでメッセージのトレースを照会して、メッセージが期待どおりに送信されているかどうかを確認できます。

例：

期待どおりにメッセージが受信されず、関連するログに基づいて原因を特定する場合は、次の手順を実行して、メッセージトレースを使用して問題をトラブルシューティングします。

1. メッセージID、メッセージキー、トピック、メッセージが送信されたおおよその時点など、メッセージに関する情報を収集します。

2. ApsaraMQ for RocketMQコンソールにログインし、収集した情報に基づいてクエリタスクを作成し、メッセージトレースをクエリします。

3. クエリ結果を確認し、原因を分析します。

   • トレースに 未消費 が表示されている場合は、グループ ページに移動して消費ステータスを確認し、問題がメッセージの蓄積によるものかどうかを確認できます。 詳細については、「コンシューマーの詳細の表示」をご参照ください。

   • メッセージが消費された場合は、消費情報を確認して、対応する消費者クライアントとメッセージが消費された時刻を見つけます。 次に、コンシューマークライアントにログインして、関連するログを表示します。

手順

1. ApsaraMQ for RocketMQコンソールにログインします。 左側のナビゲーションウィンドウで、インスタンス数 をクリックします。

2. 上部のナビゲーションバーで、中国 (杭州) などのリージョンを選択します。 [インスタンス] ページで、管理するインスタンスの名前をクリックします。

3. 左側のナビゲーションウィンドウで、メッセージトレース をクリックします。 表示されるページの左上隅で、クエリタスクの作成 をクリックします。

4. メッセージトレースクエリタスクの作成 パネルで、ビジネス要件に基づいてクエリ条件を設定します。 次に、[OK] をクリックします。

   重要

   時間範囲をできるだけ正確に設定して、クエリの範囲を絞り込み、クエリを高速化します。

   メッセージトレース機能では、次のクエリメソッドがサポートされています。

   • Message ID から検索: この方法は、正確な一致と高速性のために推奨されます。

   • Message Key から検索: このメソッドは、ファジー検索を使用します。 この方法を使用すると、最大1,000個のメッセージのトレースを照会できます。 この方法は、メッセージのIDを記録せず、メッセージを一意に識別するキーを指定したシナリオにのみ適しています。

   • トピックから検索: このメソッドは範囲クエリを使用します。 この方法は、メッセージIDを記録したり、メッセージキーを指定したりしなかったメッセージ量の少ないシナリオに適しています。 このクエリ方法は使用しないことを推奨します。 ほとんどの場合、特定の時間範囲内のトピックでは多数のメッセージが生成されます。 この方法を使用すると、クエリされたメッセージの中から特定のメッセージを特定することはほとんどできません。

   クエリタスクを作成した後、メッセージトレース ページでクエリタスクを表示できます。 ステータス 列に クエリ中 が表示されている場合、メッセージトレースは表示できません。 タスクリストの右上隅にあるボタンをクリックすると、タスクのステータスが検索完了に変わるまで、タスクのステータスを更新できます。

パラメーター

[メッセージトレース] ページで、クエリタスクを見つけ、操作 列の 検索結果 をクリックします。 表示されるページで、クエリされたメッセージの送信ステータスと消費ステータスを 送信ステータス および 消費ステータス 列に表示できます。 また、メッセージトレースの詳細ページのプロデューサーセクションとコンシューマーセクションで、各メッセージの送信ステータスと消費ステータスを表示することもできます。 次の表に、送信ステータスと消費ステータスを示します。

よくある質問

メッセージのトレースを照会できないのはなぜですか?

• SDKのバージョンが有効かどうかを確認します。 メッセージトレース機能をサポートするSDKのバージョンについては、「メッセージトレース機能をサポートするSDKのバージョン」をご参照ください。

• 指定した時間範囲が有効かどうかを確認します。

  デフォルトでは、メッセージはApsaraMQ for RocketMQブローカーに3日間保存されます。 現在の時点の3日前に生成されたメッセージのトレースのみを照会できます。 たとえば、現在の時点が2023年11月30日の15:09:48の場合、2023年11月27日の15:09:48から2023年11月30日の15:09:48までに生成されたメッセージのトレースを照会できます。

  重要

  ストレージ容量が不十分なため、ApsaraMQ for RocketMQブローカーにメッセージトレースが3日間保持されない場合があります。 メッセージのトレースを3日間保持する場合は、ApsaraMQ for RocketMQ Enterprise Platinum Editionインスタンスの使用を推奨します。 これらのインスタンスでは、メッセージトレースのカスタム保存期間を指定できます。

• メッセージトレース機能は非同期リンクで実装されているため、メッセージのトレースデータが不完全な場合があります。 指定したクエリ条件が有効であっても、システムはクエリに対して結果を返さない場合があります。 この場合、クライアントのログを照会して消費の詳細を取得できます。 詳細については、「ロギング設定」をご参照ください。

関連ドキュメント

ApsaraMQ for RocketMQが提供する次のAPI操作を呼び出して、メッセージトレースを照会することもできます。

• OnsTraceQueryByMsgId

• OnsTraceQueryByMsgKey

• OnsTraceGetResult