クライアントログは記録され、ApsaraMQ for RocketMQクライアントの実行中に発生する例外のトラブルシューティングに役立ちます。 このトピックでは、クライアントログの設定項目について説明します。 このトピックでは、クライアントのログ印刷機能を有効にする方法と、カスタムクライアントログを設定する方法についても説明します。
最新のRocketMQ 5.x SDKを使用することを推奨します。 これらのSDKは、ApsaraMQ for RocketMQ 5.xブローカーと完全に互換性があり、より多くの機能と強化された機能を提供します。 詳細については、「リリースノート」をご参照ください。
Alibaba Cloudは、RocketMQ 3.x、4.x、およびTCPクライアントSDKのみを保持します。 既存のビジネスにのみ使用することを推奨します。
クライアントのログ印刷機能を有効にする
ApsaraMQ for RocketMQが提供するJava用SDKは、SLF4J APIを使用して開発されています。
- SDK for Java 1.7.8.Final以降: デフォルトでは、これらのバージョンのSDK for Javaでログ印刷機能がサポートされています。 機能を設定する必要はありません。
ApsaraMQ for RocketMQが提供するSDK for Java 1.7.8.Finalには、ログ記録用の組み込みフレームワークがあります。 ApsaraMQ for RocketMQクライアントのログを印刷する前に、クライアント上のアプリケーションの対応するロギングフレームワークに依存関係を追加する必要はありません。
- SDK for Javaバージョン1.7.8より前のバージョン: 対応するロギングフレームワークに依存関係を追加する必要があります。
ApsaraMQ for RocketMQ Java 1.7.8 SDK. Finalまたはそれ以前はLog4jとLogbackのみをサポートし、Log4j2はサポートしません。 対応するロギングフレームワークの依存関係を
pom.xmlファイルに追加する必要があります。ApsaraMQ for RocketMQクライアントのログを印刷する前のlibファイル。 最新バージョンのSDK for Javaを使用して、クライアントログを印刷することを推奨します。
mvn clean dependency:tree | grep logコマンドを実行して問題のトラブルシューティングを行うことができます。 クライアントログの設定項目
クライアントログの設定項目を次の表に示します。 クライアントの起動後、システムはデフォルト設定に基づいてログファイルを生成します。 設定項目のカスタム値を指定することもできます。 詳細については、このトピックの「カスタムクライアントログの構成」をご参照ください。
| 設定アイテム | デフォルト設定 | カスタム設定 | パラメーター | カスタム値 |
| ログストレージパス | ログファイルの保存パスは /{user.home} /logs/ons.logです。 パスの {user.home} は、Javaプロセスを実行するアカウントのルートディレクトリです。 | 可 | ons.client.logRoot | コンピューターにカスタムパスを指定して、ログファイルを保存できます。 アプリケーションプロセスにパスの書き込み権限が付与されていることを確認します。 そうしないと、ログを印刷できません。 |
| ログレベル | 情報 | 可 | ons.client.logLevel | 有効な値：
|
| 保持される履歴ログファイルの最大数 | 10 | 可 | ons.client.logFileMaxIndex | 設定可能な値は 1～100 です。 指定された値が有効な範囲にない場合、または無効な形式の場合は、デフォルト値10が使用されます。 |
| ログファイルのサイズ | 64 MB | 任意 | 非該当 | 非該当 |
カスタムクライアントログの設定
- メソッド: 統合開発環境 (IDE) のスタートアップスクリプトまたは仮想マシン (VM) オプションで、
-Dコマンドを実行して、クライアントログの構成項目を指定します。 - 例:
- Linuxのサンプルコード
-Dons.client.logRoot=/home/admin/logs -Dons.client.logLevel=WARN -Dons.client.logFileMaxIndex=20 - Windowsのサンプルコード
-Dons.client.logRoot=D:\logs -Dons.client.logLevel=WARN -Dons.client.logFileMaxIndex=20
- Linuxのサンプルコード