2025年12月22日に最終更新

デバッグポイント

デバッグポイントは FE または BE のコードに挿入するコード片です。

プログラムの実行がそのコードに到達すると、変数やプログラムの動作を変更できます。

主に、通常の方法では特定の例外を発生させられない場合に、単体テストや回帰テストで使用します。

各デバッグポイントには任意の名前を付けられます。デバッグポイントの有効化と無効化を切り替えられます。

デバッグポイントにデータを渡すこともできます。

FE と BE はどちらもデバッグポイントをサポートします。デバッグポイントのコードを挿入した後は、FE または BE の再コンパイルが必要です。

コード例

FE の例

private Status foo() {
	// dbug_fe_foo_do_nothing is the debug point name
	// when it's active, DebugPointUtil.isEnable("dbug_fe_foo_do_nothing") returns true
	if (DebugPointUtil.isEnable("dbug_fe_foo_do_nothing")) {
      	return Status.Nothing;
    }
      	
    do_foo_action();
    
    return Status.Ok;
}

BE の例

void Status foo() {
     // dbug_be_foo_do_nothing is the debug point name
     // when it's active, DBUG_EXECUTE_IF will execute the code block
     DBUG_EXECUTE_IF("dbug_be_foo_do_nothing",  { return Status.Nothing; });
   
     do_foo_action();
     
     return Status.Ok;
}

グローバル設定

デバッグポイントをグローバルに有効化するには、enable_debug_points を true に設定します。

enable_debug_points は FE の fe.conf と BE の be.conf にあります。

特定のデバッグポイントを有効化する

デバッグポイントをグローバルに有効化した後、デバッグポイント名を指定した HTTP リクエストを FE または BE ノードに送信します。
その後、プログラムの実行が指定したデバッグポイントに到達すると、対応するコードが実行されます。

API

POST /api/debug_point/add/{debug_point_name}[?timeout=<int>&execute=<int>]

クエリパラメータ

debug_point_name デバッグポイント名です。必須パラメータです。
timeout タイムアウトまでの秒数です。タイムアウトするとデバッグポイントは無効化されます。デフォルトは -1 で、タイムアウトしません。省略可能です。
execute 有効化後にデバッグポイントを実行できる最大回数です。デフォルトは -1 で、回数に制限はありません。省略可能です。

リクエストボディ

なし

レスポンス

{
    msg: "OK",
    code: 0
}

例

デバッグポイント foo を有効化し、実行回数を五回以下に制限します。

curl -X POST "http://127.0.0.1:8030/api/debug_point/add/foo?execute=5"

カスタムパラメータを渡す

デバッグポイントを有効化する際は、上記の「timeout」と「execute」に加えて、カスタムパラメータも渡せます。
パラメータは URL パス内の「key=value」形式のキーと値の組で、デバッグポイント名の後に「?」を付けて指定します。
以下の例を参照してください。

API

POST /api/debug_point/add/{debug_point_name}[?k1=v1&k2=v2&k3=v3...]

k1=v1
k1 はパラメータ名です。
v1 はパラメータの値です。
複数のキーと値の組は & で連結します。

リクエストボディ

なし

レスポンス

{
    msg: "OK",
    code: 0
}

例

FE ノードの fe.conf で http_port=8030 が設定されているとします。
次の HTTP リクエストは、FE ノードのデバッグポイント foo を有効化し、パラメータ percent と duration を渡します。

注: ユーザー名とパスワードが必要な場合があります。

curl -u root: -X POST "http://127.0.0.1:8030/api/debug_point/add/foo?percent=0.5&duration=3"

NOTE:
Inside FE and BE code, names and values of parameters are taken as strings.
Parameter names and values are case sensitive in http request and FE/BE code.
FE and BE share same url paths of REST API, it's just their IPs and Ports are different.

FE と BE のコードでパラメータを使用する

次のリクエストは、FE のデバッグポイント OlapTableSink.write_random_choose_sink を有効化し、パラメータ needCatchUp と sinkNum を渡します。

curl -u root: -X POST "http://127.0.0.1:8030/api/debug_point/add/OlapTableSink.write_random_choose_sink?needCatchUp=true&sinkNum=3"

FE のコードはデバッグポイント OlapTableSink.write_random_choose_sink を確認し、パラメータの値を取得します。

private void debugWriteRandomChooseSink(Tablet tablet, long version, Multimap<Long, Long> bePathsMap) {
    DebugPoint debugPoint = DebugPointUtil.getDebugPoint("OlapTableSink.write_random_choose_sink");
    if (debugPoint == null) {
        return;
    }
    boolean needCatchup = debugPoint.param("needCatchUp", false);
    int sinkNum = debugPoint.param("sinkNum", 0);
    ...
}

次のリクエストは、BE のデバッグポイント TxnManager.prepare_txn.random_failed を有効化し、パラメータ percent を渡します。

curl -X POST "http://127.0.0.1:8040/api/debug_point/add/TxnManager.prepare_txn.random_failed?percent=0.7

BE のコードはデバッグポイント TxnManager.prepare_txn.random_failed を確認し、パラメータの値を取得します。

DBUG_EXECUTE_IF("TxnManager.prepare_txn.random_failed",
		{if (rand() % 100 < (100 * dp->param("percent", 0.5))) {
		        LOG_WARNING("TxnManager.prepare_txn.random_failed random failed");
		        return Status::InternalError("debug prepare txn random failed");
		}}
);