HiCollie

概述

提供检测业务线程卡死或卡顿的能力。请注意：要在非业务线程中调用。

本模块函数可用于：

（1）注册应用业务线程卡死的周期性检测任务；

（2）注册应用业务线程卡顿检测的回调函数；

（3）上报应用业务线程卡死事件。

起始版本： 12

汇总

文件

结构体

类型定义

枚举

函数

类型定义说明

HiCollie_DetectionParam

typedef struct HiCollie_DetectionParamHiCollie_DetectionParam

描述 检测业务线程卡顿的相关参数。请注意，API 12及以上支持。

起始版本： 12

HiCollie_ErrorCode

typedef enum HiCollie_ErrorCodeHiCollie_ErrorCode

描述 错误码定义。

起始版本： 12

HiCollie_Flag

typedef enum HiCollie_FlagHiCollie_Flag

描述 定义函数执行超时时发生的动作。

起始版本： 18

HiCollie_SetTimerParam

typedef struct HiCollie_SetTimerParamHiCollie_SetTimerParam

描述 定义OH_HiCollie_SetTimer函数的输入参数。

起始版本： 18

OH_HiCollie_BeginFunc

typedef void(* OH_HiCollie_BeginFunc) (const char *eventName)

描述 卡顿检测中,函数用于记录业务线程处理事件的开始时间。

检查处理事件的执行时间，HiCollie将检查每个事件的持续时间。如果超过预设阈值，上报jank事件。

该函数是在每个事件处理之前插入的回调函数。

起始版本： 12

参数:

OH_HiCollie_Callback

typedef void(* OH_HiCollie_Callback) (void *)

描述 当用户调用OH_HiCollie_SetTimer后，未在其自定义的任务超时时间阈值内调用OH_HiCollie_CancelTimer，回调函数将被执行。

起始版本： 18

OH_HiCollie_EndFunc

typedef void(* OH_HiCollie_EndFunc) (const char *eventName)

描述 卡顿检测中, 该函数用于检测业务线程处理事件是否卡顿。

检查处理事件的执行时间，HiCollie将检查每个事件的持续时间。如果超过预设阈值，上报jank事件。

该函数是在每个事件处理之后插入的回调函数。

起始版本： 12

参数:

OH_HiCollie_Task

typedef void(* OH_HiCollie_Task) (void)

描述 在业务线程卡死检测中，通过实现该函数来检测业务线程是否卡住。

HiCollie将在独立线程中每3秒调用一次该函数。

例如：该函数可实现向业务线程发送消息，在业务线程接收到消息之后，设置一个标记，检查这个标记，确定业务线程是否卡住。

起始版本： 12

枚举类型说明

HiCollie_ErrorCode

enum HiCollie_ErrorCode

描述 错误码定义。

起始版本： 12

HiCollie_Flag

enum HiCollie_Flag

描述 定义函数执行超时时发生的动作。

起始版本： 18

函数说明

OH_HiCollie_CancelTimer()

void OH_HiCollie_CancelTimer (int id)

描述 取消定时器。

结合OH_HiCollie_SetTimer接口配套使用，执行函数或代码块后使用，OH_HiCollie_CancelTimer通过id将该任务取消；

若未在自定义时间内取消，则执行回调函数，在特定自定义超时动作下，生成故障日志。

起始版本： 18

参数:

OH_HiCollie_Init_JankDetection()

HiCollie_ErrorCode OH_HiCollie_Init_JankDetection (OH_HiCollie_BeginFunc * beginFunc, OH_HiCollie_EndFunc * endFunc, HiCollie_DetectionParam param )

描述 注册应用业务线程卡顿检测的回调函数。

线程卡顿监控功能需要开发者实现两个卡顿检测回调函数, 分别放在业务线程处理事件的前后。作为插桩函数，监控业务线程处理事件执行情况。

起始版本： 12

参数:

返回：

HICOLLIE_SUCCESS 0 - 成功。

HICOLLIE_INVALID_ARGUMENT 401 - 开始函数和结束函数两者都必须有值或为空，否则将返回该错误值。

HICOLLIE_WRONG_THREAD_CONTEXT 29800001 - 调用线程错误。在非主线程中调用该函数。

具体可参考HiCollie_ErrorCode。

OH_HiCollie_Init_StuckDetection()

HiCollie_ErrorCode OH_HiCollie_Init_StuckDetection (OH_HiCollie_Task task)

描述 注册应用业务线程卡死的周期性检测任务。用户实现回调函数, 用于定时检测业务线程卡死情况。

默认检测时间：3s上报BUSSINESS_THREAD_BLOCK_3S告警事件，6s上报BUSSINESS_THREAD_BLOCK_6S卡死事件。

起始版本： 12

参数:

返回：

HICOLLIE_SUCCESS 0 - 成功。

HICOLLIE_WRONG_THREAD_CONTEXT 29800001 - 调用线程错误。在非主线程中调用该函数。

具体可参考HiCollie_ErrorCode。

OH_HiCollie_Init_StuckDetectionWithTimeout()

HiCollie_ErrorCode OH_HiCollie_Init_StuckDetectionWithTimeout (OH_HiCollie_Task task, uint32_t stuckTimeout )

描述 注册应用业务线程卡死的周期性检测任务。用户实现回调函数, 用于定时检测业务线程卡死情况。

开发者可以设置卡死检测时间，可设置的时间范围：[3, 15]，单位：秒。

起始版本： 18

参数:

返回：

HICOLLIE_SUCCESS 0 - 成功。

HICOLLIE_INVALID_ARGUMENT 401 - 卡死检测时间设置错误。

HICOLLIE_WRONG_THREAD_CONTEXT 29800001 - 调用线程错误。在非主线程中调用该函数。

具体可参考HiCollie_ErrorCode。

OH_HiCollie_Report()

HiCollie_ErrorCode OH_HiCollie_Report (bool * isSixSecond)

描述 上报应用业务线程卡死事件，生成卡死故障日志，辅助定位应用卡死问题。

先调用OH_HiCollie_Init_StuckDetection或OH_HiCollie_Init_StuckDetectionWithTimeout接口，初始化检测的task；

如果task任务超时，结合业务逻辑，调用OH_HiCollie_Report接口上报卡死事件。

起始版本： 12

参数:

返回：

HICOLLIE_SUCCESS 0 - 成功。

HICOLLIE_INVALID_ARGUMENT 401 - 开始函数和结束函数两者都必须有值或为空，否则将返回该错误值。

HICOLLIE_WRONG_THREAD_CONTEXT 29800001 - 调用线程错误。在非主线程中调用该函数。

HICOLLIE_REMOTE_FAILED 29800002 - 远程调用错误。请求IPC远程服务失败。

具体可参考HiCollie_ErrorCode。

OH_HiCollie_SetTimer()

HiCollie_ErrorCode OH_HiCollie_SetTimer (HiCollie_SetTimerParam param, int * id )

描述 注册定时器，用于检测函数或代码块执行是否超过自定义时间。

结合OH_HiCollie_CancelTimer接口配套使用，应在调用耗时的函数之前使用。

起始版本： 18

参数:

返回：

HICOLLIE_SUCCESS 0 - 成功。

HICOLLIE_INVALID_TIMER_NAME 29800003 - 无效的计时器名称，不应为NULL或空字符串。

HICOLLIE_INVALID_TIMEOUT_VALUE 29800004 - 无效的超时值。

HICOLLIE_WRONG_PROCESS_CONTEXT 29800005 - 无效的接入检测进程上下文，appspawn与nativespawn进程中不可调用。

HICOLLIE_WRONG_TIMER_ID_OUTPUT_PARAM 29800006 - 用于保存返回的计时器id的指针，不应该为NULL。

具体可参考HiCollie_ErrorCode。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Performance Analysis Kit（性能分析服务）

harmony 鸿蒙HiAppEvent

harmony 鸿蒙HiAppEvent_AppEventGroup

harmony 鸿蒙HiAppEvent_AppEventInfo

harmony 鸿蒙HiCollie_DetectionParam

harmony 鸿蒙HiCollie_SetTimerParam

harmony 鸿蒙HiDebug

harmony 鸿蒙HiDebug_JsStackFrame

harmony 鸿蒙HiDebug_MemoryLimit

harmony 鸿蒙HiDebug_NativeMemInfo