應(yīng)用事件打點

導(dǎo)入模塊

import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent';

hiAppEvent.write

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

應(yīng)用事件打點方法，將事件寫入到當(dāng)天的事件文件中，可接收AppEventInfo類型的事件對象，使用callback方式作為異步回調(diào)。

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

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見應(yīng)用事件打點錯誤碼。

示例：

hiAppEvent.write({
    domain: "test_domain",
    name: "test_event",
    eventType: hiAppEvent.EventType.FAULT,
    params: {
        int_data: 100,
        str_data: "strValue"
    }
}, (err) => {
    if (err) {
        console.error(`code: ${err.code}, message: ${err.message}`);
        return;
    }
    console.log(`success to write event`);
});

hiAppEvent.write

write(info: AppEventInfo): Promise<void>

應(yīng)用事件打點方法，將事件寫入到當(dāng)天的事件文件中，可接收AppEventInfo類型的事件對象，使用Promise方式作為異步回調(diào)。

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

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見應(yīng)用事件打點錯誤碼。

示例：

hiAppEvent.write({
    domain: "test_domain",
    name: "test_event",
    eventType: hiAppEvent.EventType.FAULT,
    params: {
        int_data: 100,
        str_data: "strValue"
    }
}).then(() => {
    console.log(`success to write event`);
}).catch((err) => {
    console.error(`code: ${err.code}, message: ${err.message}`);
});

AppEventInfo

此接口提供了應(yīng)用事件信息的參數(shù)選項。

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

hiAppEvent.configure

configure(config: ConfigOption): void

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

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

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見應(yīng)用事件打點錯誤碼。

示例：

// 配置打點開關(guān)為關(guān)閉狀態(tài)
hiAppEvent.configure({
    disable: true
});

// 配置文件目錄存儲配額為100M
hiAppEvent.configure({
    maxStorage: '100M'
});

ConfigOption

此接口提供了對應(yīng)用事件打點功能的配置選項。

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

hiAppEvent.addWatcher

addWatcher(watcher: Watcher): AppEventPackageHolder

添加應(yīng)用事件觀察者方法，可用于訂閱應(yīng)用事件。

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

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見應(yīng)用事件打點錯誤碼。

示例：

// 1. 如果觀察者傳入了回調(diào)的相關(guān)參數(shù)，則可以選擇在自動觸發(fā)的回調(diào)函數(shù)中對訂閱事件進(jìn)行處理
hiAppEvent.addWatcher({
    name: "watcher1",
    appEventFilters: [
        {
            domain: "test_domain",
            eventTypes: [hiAppEvent.EventType.FAULT, hiAppEvent.EventType.BEHAVIOR]
        }
    ],
    triggerCondition: {
        row: 10,
        size: 1000,
        timeOut: 1
    },
    onTrigger: function (curRow, curSize, holder) {
        if (holder == null) {
            console.error("holder is null");
            return;
        }
        let eventPkg = null;
        while ((eventPkg = holder.takeNext()) != null) {
            console.info(`eventPkg.packageId=${eventPkg.packageId}`);
            console.info(`eventPkg.row=${eventPkg.row}`);
            console.info(`eventPkg.size=${eventPkg.size}`);
            for (const eventInfo of eventPkg.data) {
                console.info(`eventPkg.data=${eventInfo}`);
            }
        }
    }
});

// 2. 如果觀察者未傳入回調(diào)的相關(guān)參數(shù)，則可以選擇使用返回的holder對象手動去處理訂閱事件
let holder = hiAppEvent.addWatcher({
    name: "watcher2",
});
if (holder != null) {
    let eventPkg = null;
    while ((eventPkg = holder.takeNext()) != null) {
        console.info(`eventPkg.packageId=${eventPkg.packageId}`);
        console.info(`eventPkg.row=${eventPkg.row}`);
        console.info(`eventPkg.size=${eventPkg.size}`);
        for (const eventInfo of eventPkg.data) {
            console.info(`eventPkg.data=${eventInfo}`);
        }
    }
}

hiAppEvent.removeWatcher

removeWatcher(watcher: Watcher): void

移除應(yīng)用事件觀察者方法，可用于取消訂閱應(yīng)用事件。

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

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見應(yīng)用事件打點錯誤碼。

示例：

// 1. 定義一個應(yīng)用事件觀察者
let watcher = {
    name: "watcher1",
}

// 2. 添加一個應(yīng)用事件觀察者來訂閱事件
hiAppEvent.addWatcher(watcher);

// 3. 移除該應(yīng)用事件觀察者以取消訂閱事件
hiAppEvent.removeWatcher(watcher);

Watcher

此接口提供了應(yīng)用事件觀察者的參數(shù)選項。

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

TriggerCondition

此接口提供了回調(diào)觸發(fā)條件的參數(shù)選項，只要滿足任一條件就會觸發(fā)訂閱回調(diào)。

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

AppEventFilter

此接口提供了過濾應(yīng)用事件的參數(shù)選項。

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

AppEventPackageHolder

訂閱數(shù)據(jù)持有者類，用于對訂閱事件進(jìn)行處理。

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

constructor

constructor(watcherName: string)

類構(gòu)造函數(shù)，在添加應(yīng)用事件觀察者時，會由系統(tǒng)自動調(diào)用來創(chuàng)建一個該觀察者對應(yīng)的訂閱數(shù)據(jù)持有者對象，并返回給開發(fā)者。

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

參數(shù)：

示例：

let holder = hiAppEvent.addWatcher({
    name: "watcher",
});

setSize

setSize(size: number): void

設(shè)置每次取出的應(yīng)用事件包的數(shù)據(jù)大小閾值。

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

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見應(yīng)用事件打點錯誤碼。

示例：

let holder = hiAppEvent.addWatcher({
    name: "watcher",
});
holder.setSize(1000);

takeNext

takeNext(): AppEventPackage

根據(jù)設(shè)置的數(shù)據(jù)大小閾值來取出訂閱事件數(shù)據(jù)，當(dāng)訂閱事件數(shù)據(jù)全部被取出時返回null作為標(biāo)識。

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

示例：

let holder = hiAppEvent.addWatcher({
    name: "watcher",
});
let eventPkg = holder.takeNext();

AppEventPackage

此接口提供了訂閱返回的應(yīng)用事件包的參數(shù)定義。

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

hiAppEvent.clearData

clearData(): void

應(yīng)用事件打點數(shù)據(jù)清理方法，將應(yīng)用存儲在本地的打點數(shù)據(jù)進(jìn)行清除。

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

示例：

hiAppEvent.clearData();

EventType

事件類型枚舉。

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

event

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

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

param

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

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