Debug Point

Debug Point

Debug point is used in code test. When enabling a debug point, it can run related code.

Both FE and BE support debug points.

Code Example

FE example

private Status foo() {
    // dbug_fe_foo_do_nothing is the debug point name.
    // When it's active，DebugPointUtil.isEnable("dbug_fe_foo_do_nothing") will return 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，DEBUG_EXECUTE_IF will execute the code block.
     DEBUG_EXECUTE_IF("dbug_be_foo_do_nothing",  { return Status.Nothing; });
   
     do_foo_action();
     
     return Status.Ok;
}

Global config

To activate debug points, need set enable_debug_points to true.

enable_debug_points was located in FE's fe.conf and BE's be.conf。

Enable Debug Point

API

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

Query Parameters

• debug_point_name Debug point name. Require.

• timeout Timeout in seconds. When timeout, the debug point will be disable. Default is -1, not timeout. Optional.

• execute Max active times。Default is -1, unlimit active times. Optional.

Request body

None

Response

```
{
    msg: "OK",
    code: 0
}
```

Examples

Enable debug point foo, activate no more than five times.

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

```

Disable Debug Point

API

    POST /api/debug_point/remove/{debug_point_name}

Query Parameters

• debug_point_name Debug point name. Require.

Request body

None

Response

    {
        msg: "OK",
        code: 0
    }

Examples

Disable debug point foo。

```
curl -X POST "http://127.0.0.1:8030/api/debug_point/remove/foo"

```

Clear Debug Points

API

    POST /api/debug_point/clear

Request body

None

Response

```
{
    msg: "OK",
    code: 0
}
```

Examples

```
curl -X POST "http://127.0.0.1:8030/api/debug_point/clear"
```