최종 수정: 2026년 5월 17일에

디버그 포인트

디버그 포인트는 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" 외에도 사용자 정의 매개변수를 전달할 수 있습니다.
매개변수는 "key=value" 형식의 키-값 쌍으로, URL 경로의 디버그 포인트 이름 뒤에 '?' 문자로 연결합니다.
아래 예제를 참고하세요.

API

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

k1=v1
k1은 매개변수 이름입니다.
v1은 매개변수 값입니다.
여러 키-값 쌍은 &로 연결합니다.

요청 본문

없음

응답

{
    msg: "OK",
    code: 0
}

예제

fe.conf에서 http_port=8030으로 설정된 FE 노드가 있다고 가정하면,
다음 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");
		}}
);