jubatusにおけるLOGレベルガイドライン(素案)

gistfile1.txt

1. 利用するライブラリ

http://code.google.com/p/google-glog/
google-glog を利用する。

2. ログレベル

Jubatusは通常モードとデバッグモードのログレベルが存在する。
通常モードでのJubatusで利用するログレベルは、以下の三種類とする。

- ERROR
 クライアントもしくは、システム操作者が何かしらの変更点を加えないと、システムが正しく動作しない場合
 cf. サーバで例外を返した場合
 LOG(ERROR) << "Exception : " << exp_str;

- WARNING
 システムとしては動作しているが、正しい結果を返していない可能性がある場合
 そのうちエラーが発生する可能性がある状態の場合
 cf. 機械学習などアルゴリズム内でINF, NaNなどの異常値が返っている場合
     分散環境で起動しているにも関わらず、サーバが一台しかない場合
     分散環境でノードが落ちた場合
 LOG(WARN) << "classify returns" << ret_val;

- INFO
 開始時、設定変更時、保存データロード時など、Jubatusクラスタ全体が大きく変化するときに記録する。
 LOG(INFO) << "jubaclassifier sta" << ret_val;

デバッグモードのログレベルは、以上に加え
- DLOG
 状態が変わるとき
 他のサーバとのやりとりが発生したとき
 - すべてのモデルの更新を伴う処理を記録
 - 他のサーバへの要求が発生した場合
 - 他のサーバから要求を受けた場合
 - ZKとのやりとり
  c.f. 各サーバのupdate時、MIXプロトコルの開始時、終了時、master_lock取得時、他のサーバからの受信時