BEログ管理

この文書では、主にBackend (BE) プロセスのログ管理について紹介します。

この文書は、Dorisバージョン2.1.4以降に適用されます。

ログカテゴリ

sh bin/start_be.sh --daemonを使用してBEプロセスを開始すると、BEログディレクトリに以下の種類のログファイルが生成されます：

• be.INFO

  BEプロセス実行ログ。BEのメインログファイルです。すべてのレベルのBEプロセス実行ログ（DEBUG、INFO、WARN、ERRORなど）がこのログファイルに出力されます。

  このファイルは現在の最新のBE実行ログファイルを指すシンボリックリンクであることに注意してください。

• be.WARNING

  BEプロセス実行ログ。ただし、WARNレベル以上の実行ログのみが出力されます。be.WARNINGの内容はbe.INFOログ内容のサブセットです。主に警告またはエラーレベルのログを迅速に確認するために使用されます。

  このファイルは現在の最新のBE警告ログファイルを指すシンボリックリンクであることに注意してください。

• be.out

  標準出力ストリームとエラーデータストリームを受信するために使用されます。たとえば、開始スクリプト内のechoコマンドからの出力、またはglogフレームワークによってキャプチャされない他のログ情報。通常、実行ログの補完として使用されます。

  通常、BEクラッシュの場合、例外のスタックトレースを取得するためにこのログを確認する必要があります。

• jni.log

  BEプロセスがJNIを通じてJavaプログラムを呼び出す際にJavaプログラムによって出力されるログ。

  TODO: 将来のバージョンでは、このログの部分はbe.INFOログに統合される予定です。

• be.gc.log

  BE JVMのGCログ。このログの動作は、be.confのJVM起動オプションJAVA_OPTSによって制御されます。

ログ設定

ログの保存パス、保持時間、保持数、サイズなどの設定を含みます。

以下の設定項目はbe.confファイルで設定されます。

設定項目	デフォルト値	オプション	説明
LOG_DIR	ENV(DORIS_HOME)/log		すべてのログの保存パス。デフォルトでは、BE配置パス下のlog/ディレクトリです。これは環境変数であり、設定名は大文字にする必要があることに注意してください。
sys_log_level	INFO	INFO, WARNING, ERROR, FATAL	be.INFOのログレベル。デフォルトはINFOです。INFOレベルには多くの重要なログ情報が含まれているため、変更は推奨されません。
sys_log_roll_num	10		be.INFOとbe.WARNINGの最大ファイル数を制御します。デフォルトは10です。ログローリングまたは分割によりログファイル数がこの閾値を超えた場合、古いログファイルが削除されます。
sys_log_verbose_modules			特定のコードディレクトリでDEBUGレベルログを有効にするよう設定できます。詳細は「DEBUGログの有効化」セクションを参照してください。
sys_log_verbose_level			「DEBUGログの有効化」セクションを参照してください。
sys_log_verbose_flags_v			「DEBUGログの有効化」セクションを参照してください。
sys_log_roll_mode	SIZE-MB-1024	TIME-DAY, TIME-HOUR, SIZE-MB-nnn	be.INFOとbe.WARNINGログのローリング戦略。デフォルトはSIZE-MB-1024で、各ログが1024MBのサイズに達した後に新しいログファイルが生成されることを意味します。日または時間でローリングするよう設定することも可能です。
log_buffer_level	Empty	EmptyまたはEmptyまたは-1	BEログ出力モード。デフォルトでは、BEログは非同期でディスクログファイルにフラッシュされます。-1に設定すると、ログ内容がリアルタイムでフラッシュされます。リアルタイムフラッシュはログパフォーマンスに影響しますが、最新のログを可能な限り保持できます。これにより、BEクラッシュの場合に最後のログ情報を確認できます。
disable_compaction_trace_log	true	true, false	デフォルトはtrueで、compaction操作のトレースログが無効になっていることを意味します。falseに設定すると、トラブルシューティングのためにCompaction操作に関連するトレースログが出力されます。
aws_log_level	0		AWS SDKのログレベルを制御します。デフォルトは0で、AWS SDKログがオフになっていることを示します。デフォルトでは、AWS SDKログはglogによってアクティブにキャプチャされ、正常に出力されます。場合によっては、キャプチャされないより多くのログを表示するためにAWS SDKログを有効にする必要があります。異なる数値は異なるログレベルを表します：Off = 0、Fatal = 1、Error = 2、Warn = 3、Info = 4、Debug = 5、Trace = 6。
s3_file_writer_log_interval_second	60		S3 Upload操作を実行する際、デフォルトでは60秒ごとに操作の進行状況が出力されます。
enable_debug_log_timeout_secs	0		値が0より大きい場合、pipelineエクゼキューションエンジンの詳細な実行ログが一部出力されます。主にトラブルシューティングに使用されます。デフォルトでは無効です。
sys_log_enable_custom_date_time_format	false		ログでカスタム日付フォーマットを許可するかどうか（バージョン2.1.7以降サポート）
sys_log_custom_date_time_format	%Y-%m-%d %H:%M:%S		ログ日付のデフォルトカスタムフォーマット。sys_log_enable_custom_date_time_formaがtrueの場合のみ有効（バージョン2.1.7以降サポート）
sys_log_custom_date_time_ms_format	,{:03d}		ログ日付のデフォルト時間精度。これはsys_log_enable_custom_date_time_formatがtrueの場合のみ有効（バージョン2.1.7以降サポート）

DEBUGログの有効化

静的設定

be.confでsys_log_verbose_modulesとsys_log_verbose_levelを設定します：

sys_log_verbose_modules=plan_fragment_executor,olap_scan_node
sys_log_verbose_level=3

sys_log_verbose_modules は開くファイルの名前を指定します。ワイルドカード * で指定することができます。例：

sys_log_verbose_modules=*

全てのBE詳細ログを有効にします。

sys_log_verbose_levelはDEBUGレベルを示します。数値が高いほど、DEBUG ログがより詳細になります。値の範囲は1から10です。

ほとんどの状況では、be.confでsys_log_verbose_modulesとsys_log_verbose_levelを設定すれば十分です。 デバッグログが期待通りに表示されない場合など稀なケースでのみ、モジュールスコープに制限されないsys_log_verbose_flags_vの設定が必要になる場合があります。

sys_log_verbose_flags_vはglogのFLAGS_vで、VLOG(n)ログの全体的な詳細レベルを制御し、n <= FLAGS_vのメッセージが印刷され、ログ出力の詳細をきめ細かく制御できます。

動的変更

2.1以降、BEのDEBUGログは以下のRESTful APIを通じて動的変更をサポートしています:

curl -X POST "http://<be_host>:<webport>/api/glog/adjust?module=<module_name>&level=<level_number>"

動的調整メソッドはワイルドカードもサポートしており、例えばmodule=*&level=10を使用するとすべてのBE vlogが有効になりますが、ワイルドカードは個別のモジュール名には関連付けられません。例えば、moduleAのvlogレベルを10に調整してから、module=*&level=-1を使用しても、moduleAのvlogは無効になりません。

注意: 動的に調整された設定は永続化されず、BEの再起動後に期限切れになります。

さらに、GLOGは使用する方法に関係なく、モジュールが存在しない場合は対応するlogモジュールを作成し（実際の効果はありません）、エラーを返しません。

Container環境のLog設定

場合によっては、FEプロセスはcontainer環境（k8sなど）を通じてデプロイされます。すべてのlogは、ファイルではなく標準出力ストリームを通じて出力する必要があります。

この場合、sh bin/start_be.sh --consoleコマンドを使用してBEプロセスをフォアグラウンドで開始し、すべてのlogを標準出力ストリームに出力できます。

同じ標準出力ストリーム内で異なるタイプのlogを区別するために、各logの前に異なるprefixが追加されます。例えば:

RuntimeLogger W20240624 00:36:46.325274 1460943 olap_server.cpp:710] Have not get FE Master heartbeat yet
RuntimeLogger I20240624 00:36:46.325999 1459644 olap_server.cpp:208] tablet checkpoint tasks producer thread started
RuntimeLogger I20240624 00:36:46.326066 1460954 olap_server.cpp:448] begin to produce tablet meta checkpoint tasks.
RuntimeLogger I20240624 00:36:46.326093 1459644 olap_server.cpp:213] tablet path check thread started
RuntimeLogger I20240624 00:36:46.326190 1459644 olap_server.cpp:219] cache clean thread started
RuntimeLogger I20240624 00:36:46.326336 1459644 olap_server.cpp:231] path gc threads started. number:1
RuntimeLogger I20240624 00:36:46.326643 1460958 olap_server.cpp:424] try to start path gc thread!

異なるプレフィックスの意味は以下の通りです：

• RuntimeLogger: be.log 内のログに対応します。

jni.log のサポートは将来のバージョンで追加される予定です。

さらに、コンテナ環境用の追加設定パラメータがあります：

設定項目	デフォルト値	オプション	説明
enable_file_logger	true	true, false	ファイルログを有効にするかどうか。デフォルトは true です。--console コマンドでBEプロセスを開始すると、ログは標準出力ストリームと通常のログファイルの両方に出力されます。false に設定すると、ログは標準出力ストリームにのみ出力され、ログファイルは生成されません。