@ohos.hiviewdfx.hiAppEvent (Application Event Logging)

The hiAppEvent module provides application event-related functions, including flushing application events to a disk, querying and clearing application events, and customizing application event logging configuration.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

hiAppEvent.write

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

Writes events to the event file of the current day through AppEventInfo objects. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Error codes

For details about the error codes, see Application Event Logging Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

hiAppEvent.write

write(info: AppEventInfo): Promise<void>

Writes events to the event file of the current day through AppEventInfo objects. This API uses a promise to return the result.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Return value

Error codes

For details about the error codes, see Application Event Logging Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

AppEventInfo

Defines parameters for an AppEventInfo object.

System capability: SystemCapability.HiviewDFX.HiAppEvent

hiAppEvent.configure

configure(config: ConfigOption): void

Configures the application event logging function, such as setting the event logging switch and maximum size of the directory that stores the event logging files.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Error codes

For details about the error codes, see Application Event Logging Error Codes.

Example

// Disable the event logging function.
let config1: hiAppEvent.ConfigOption = {
  disable: true,
};
hiAppEvent.configure(config1);

// Set the maximum size of the file storage directory to 100 MB.
let config2: hiAppEvent.ConfigOption = {
  maxStorage: '100M',
};
hiAppEvent.configure(config2);

ConfigOption

Provides configuration options for application event logging.

System capability: SystemCapability.HiviewDFX.HiAppEvent

hiAppEvent.addWatcher

addWatcher(watcher: Watcher): AppEventPackageHolder

Adds a watcher to subscribe to application events.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Return value

Error codes

For details about the error codes, see Application Event Logging Error Codes.

Example

// 1. If callback parameters are passed to the watcher, you can have subscription events processed in the callback that is automatically triggered.
hiAppEvent.addWatcher({
  name: "watcher1",
  appEventFilters: [
    {
      domain: "test_domain",
      eventTypes: [hiAppEvent.EventType.FAULT, hiAppEvent.EventType.BEHAVIOR]
    }
  ],
  triggerCondition: {
    row: 10,
    size: 1000,
    timeOut: 1
  },
  onTrigger: (curRow: number, curSize: number, holder: hiAppEvent.AppEventPackageHolder) => {
    if (holder == null) {
      console.error("holder is null");
      return;
    }
    console.info(`curRow=${curRow}, curSize=${curSize}`);
    let eventPkg: hiAppEvent.AppEventPackage | null = 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. If no callback parameters are passed to the watcher, you can have subscription events processed manually through the subscription data holder.
let holder = hiAppEvent.addWatcher({
  name: "watcher2",
});
if (holder != null) {
  let eventPkg: hiAppEvent.AppEventPackage | null = 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

Removes a watcher to unsubscribe from application events.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Error codes

For details about the error codes, see Application Event Logging Error Codes.

Example

// 1. Define a watcher for application events.
let watcher: hiAppEvent.Watcher = {
  name: "watcher1",
}

// 2. Add the watcher to subscribe to application events.
hiAppEvent.addWatcher(watcher);

// 3. Remove the watcher to unsubscribe from application events.
hiAppEvent.removeWatcher(watcher);

Watcher

Defines parameters for a Watcher object.

System capability: SystemCapability.HiviewDFX.HiAppEvent

TriggerCondition

Defines callback triggering conditions. A callback is triggered when any specified condition is met.

System capability: SystemCapability.HiviewDFX.HiAppEvent

AppEventFilter

Defines parameters for an AppEventFilter object.

System capability: SystemCapability.HiviewDFX.HiAppEvent

AppEventPackageHolder

Defines a subscription data holder for processing subscription events.

constructor

constructor(watcherName: string)

A constructor used to create a holder object for subscription data. It is associated with a Watcher object based on its name.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Example

let holder1: hiAppEvent.AppEventPackageHolder = new hiAppEvent.AppEventPackageHolder("watcher1");

setSize

setSize(size: number): void

Sets the threshold for the data size of the application event package obtained each time.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Parameters

Error codes

For details about the error codes, see Application Event Logging Error Codes.

Example

let holder2: hiAppEvent.AppEventPackageHolder = new hiAppEvent.AppEventPackageHolder("watcher2");
holder2.setSize(1000);

takeNext

takeNext(): AppEventPackage

Extracts subscription event data based on the configured data size threshold. If all subscription event data has been extracted, null will be returned.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Return value

Example

let holder3: hiAppEvent.AppEventPackageHolder = new hiAppEvent.AppEventPackageHolder("watcher3");
let eventPkg = holder3.takeNext();

AppEventPackage

Defines parameters for an AppEventPackage object.

System capability: SystemCapability.HiviewDFX.HiAppEvent

hiAppEvent.clearData

clearData(): void

Clears local application event logging data.

System capability: SystemCapability.HiviewDFX.HiAppEvent

Example

hiAppEvent.clearData();

EventType

Enumerates event types.

System capability: SystemCapability.HiviewDFX.HiAppEvent

event

Provides constants that define the names of all predefined events.

System capability: SystemCapability.HiviewDFX.HiAppEvent

param

Provides constants that define the names of all predefined event parameters.

System capability: SystemCapability.HiviewDFX.HiAppEvent