@ohos.hiSysEvent (系统事件打点)

本模块提供了系统事件打点能力，包括系统事件的埋点、落盘系统事件的订阅及已落盘的系统事件的查询能力。

说明：

• 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块的接口为系统接口。

导入模块

import hiSysEvent from '@ohos.hiSysEvent';

EventType

系统事件类型枚举。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

SysEventInfo

系统事件信息对象接口。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

hiSysEvent.write

write(info: SysEventInfo, callback: AsyncCallback<void>): void

系统事件打点方法，接收SysEventInfo类型的对象作为事件参数，使用callback方式作为异步回调。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

参数：

错误码：

以下错误码的详细介绍请参见系统事件错误码。

示例：

import hiSysEvent from '@ohos.hiSysEvent';

try {
    hiSysEvent.write({
        domain: "RELIABILITY",
        name: "STACK",
        eventType: hiSysEvent.EventType.FAULT,
        params: {
            PID: 487,
            UID: 103,
            PACKAGE_NAME: "com.ohos.hisysevent.test",
            PROCESS_NAME: "syseventservice",
            MSG: "no msg."
        }
    }, (err, val) => {
        // do something here.
    })
} catch (error) {
    console.error(`error code: ${error.code}, error msg: ${error.message}`);
}

hiSysEvent.write

write(info: SysEventInfo): Promise<void>

系统事件打点方法，接收SysEventInfo类型的对象作为事件参数，使用promise方式作为异步回调。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

参数：

返回值：

错误码：

以下错误码的详细介绍请参见系统事件错误码。

示例：

import hiSysEvent from '@ohos.hiSysEvent';

try {
    hiSysEvent.write({
        domain: "RELIABILITY",
        name: "STACK",
        eventType: hiSysEvent.EventType.FAULT,
        params: {
            PID: 487,
            UID: 103,
            PACKAGE_NAME: "com.ohos.hisysevent.test",
            PROCESS_NAME: "syseventservice",
            MSG: "no msg."
        }
    }).then(
        (val) => {
            // do something here.
        }
    ).catch(
        (err) => {
            // do something here.
        }
    )
} catch (error) {
    console.error(`error code: ${error.code}, error msg: ${error.message}`);
}

RuleType

匹配规则类型枚举。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

WatchRule

系统事件订阅规则对象接口。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

Watcher

系统事件订阅者对象接口。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

hiSysEvent.addWatcher

addWatcher(watcher: Watcher): void

订阅系统事件，接收Watcher类型的对象作为事件参数。

需要权限： ohos.permission.READ_DFX_SYSEVENT

系统能力： SystemCapability.HiviewDFX.HiSysEvent

参数：

错误码：

以下错误码的详细介绍请参见系统事件错误码。

示例：

import hiSysEvent from '@ohos.hiSysEvent';

let watcher = {
    rules: [{
        domain: "RELIABILITY",
        name: "STACK",
        tag: "STABILITY",
        ruleType: hiSysEvent.RuleType.WHOLE_WORD,
    }],
    onEvent: (info) => {
        // do something here.
    },
    onServiceDied: () => {
        // do something here.
    }
}
try {
    hiSysEvent.addWatcher(watcher)
} catch (error) {
    console.error(`error code: ${error.code}, error msg: ${error.message}`);
}

hiSysEvent.removeWatcher

removeWatcher(watcher: Watcher): void

取消订阅系统事件，接收Watcher类型的对象作为事件参数。

需要权限： ohos.permission.READ_DFX_SYSEVENT

系统能力： SystemCapability.HiviewDFX.HiSysEvent

参数：

错误码：

以下错误码的详细介绍请参见系统事件错误码。

示例：

import hiSysEvent from '@ohos.hiSysEvent';

let watcher = {
    rules: [{
        domain: "RELIABILITY",
        name: "STACK",
        tag: "STABILITY",
        ruleType: hiSysEvent.RuleType.WHOLE_WORD,
    }],
    onEvent: (info) => {
        // do something here.
    },
    onServiceDied: () => {
        // do something here.
    }
}
try {
    hiSysEvent.addWatcher(watcher)
    hiSysEvent.removeWatcher(watcher)
} catch (error) {
    console.error(`error code: ${error.code}, error msg: ${error.message}`);
}

QueryArg

系统事件查询参数对象接口。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

QueryRule

系统事件查询规则对象接口。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

Querier

系统事件查询者对象接口。

系统能力： SystemCapability.HiviewDFX.HiSysEvent

hiSysEvent.query

query(queryArg: QueryArg, rules: QueryRule[], querier: Querier): void

查询系统事件。

需要权限： ohos.permission.READ_DFX_SYSEVENT

系统能力： SystemCapability.HiviewDFX.HiSysEvent

参数：

错误码：

以下错误码的详细介绍请参见系统事件错误码。

示例：

import hiSysEvent from '@ohos.hiSysEvent';

try {
    hiSysEvent.write({
        domain: "RELIABILITY",
        name: "STACK",
        eventType: hiSysEvent.EventType.FAULT,
        params: {
            PID: 487,
            UID: 103,
            PACKAGE_NAME: "com.ohos.hisysevent.test",
            PROCESS_NAME: "syseventservice",
            MSG: "no msg."
        }
    }, (err, val) => {
        // do something here.
    })
    hiSysEvent.query({
        beginTime: -1,
        endTime: -1,
        maxEvents: 5,
    }, [{
        domain: "RELIABILITY",
        names: ["STACK"],
    }], {
        onQuery: function (infos) {
            // do something here.
        },
        onComplete: function(reason, total) {
            // do something here.
        }
    })
} catch (error) {
    console.error(`error code: ${error.code}, error msg: ${error.message}`);
}