應(yīng)用打點(diǎn)

本模塊提供了應(yīng)用事件打點(diǎn)能力，包括對(duì)打點(diǎn)數(shù)據(jù)的落盤(pán)，以及對(duì)打點(diǎn)功能的管理配置。

說(shuō)明： 本模塊首批接口從API version 7開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。 開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導(dǎo)入模塊

import hiAppEvent from '@ohos.hiAppEvent';

hiAppEvent.write

write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback): void

應(yīng)用事件打點(diǎn)方法，將事件寫(xiě)入到當(dāng)天的事件文件中，可接收類(lèi)型為Json對(duì)象的事件參數(shù)，使用callback方式作為異步回調(diào)。

系統(tǒng)能力： SystemCapability.HiviewDFX.HiAppEvent

參數(shù)：

示例：

hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) = > {
    if (err) {
        // 事件寫(xiě)入異常：事件存在異常參數(shù)時(shí)忽略異常參數(shù)后繼續(xù)寫(xiě)入，或者事件校驗(yàn)失敗時(shí)不執(zhí)行寫(xiě)入
        console.error(`failed to write event because ${err.code}`);
        return;
    }

    // 事件寫(xiě)入正常
    console.log(`success to write event: ${value}`);
});

hiAppEvent.write

write(eventName: string, eventType: EventType, keyValues: object): Promise

應(yīng)用事件打點(diǎn)方法，將事件寫(xiě)入到當(dāng)天的事件文件中，可接收類(lèi)型為Json對(duì)象的事件參數(shù)，使用promise方式作為異步回調(diào)。

系統(tǒng)能力： SystemCapability.HiviewDFX.HiAppEvent

參數(shù)：

返回值：

示例：

hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"})
    .then((value) = > {
        // 事件寫(xiě)入正常
        console.log(`success to write event: ${value}`);
    }).catch((err) = > {
        // 事件寫(xiě)入異常：事件存在異常參數(shù)時(shí)忽略異常參數(shù)后繼續(xù)寫(xiě)入，或者事件校驗(yàn)失敗時(shí)不執(zhí)行寫(xiě)入
        console.error(`failed to write event because ${err.code}`);
    });

hiAppEvent.configure

configure(config: ConfigOption): boolean

應(yīng)用事件打點(diǎn)配置方法，可用于配置打點(diǎn)開(kāi)關(guān)、文件目錄存儲(chǔ)限額大小等功能。

系統(tǒng)能力： SystemCapability.HiviewDFX.HiAppEvent

參數(shù)：

返回值：

示例：

// 配置應(yīng)用事件打點(diǎn)功能開(kāi)關(guān)
hiAppEvent.configure({
    disable: true
});

// 配置事件文件目錄存儲(chǔ)限額大小
hiAppEvent.configure({
    maxStorage: '100M'
});

ConfigOption

此接口提供了應(yīng)用打點(diǎn)的配置選項(xiàng)。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.HiviewDFX.HiAppEvent。

EventType

事件類(lèi)型枚舉。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.HiviewDFX.HiAppEvent。

Event

此接口提供了所有預(yù)定義事件的事件名稱(chēng)常量。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.HiviewDFX.HiAppEvent。

Param

此接口提供了所有預(yù)定義參數(shù)的參數(shù)名稱(chēng)常量。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.HiviewDFX.HiAppEvent。