HiAppEvent

• Introduction

• Directory Structure

• Compilation and Building

• Usage

  • Available APIs
  • How to Use

• Repositories Involved

Introduction

HiAppEvent is an OpenHarmony module that provides the event logging function for applications to log the fault, statistical, security, and user behavior events reported during running. Based on event information, you will be able to analyze the running status of applications.

Figure 1 HiAppEvent architecture

Directory Structure

/base/hiviewdfx/hiappevent   # HiAppEvent source code
├── frameworks               # Framework code
│   └── native               # Native implementation code of logging APIs
├── interfaces               # External APIs
│   └── js                   # JS APIs
│       └── innerkits        # JS API implementation code
│           └── napi         # JS APIs implemented based on NAPI
├── test                     # Test cases

Compilation and Building

Use Clang 8.0.0 and C++11 or higher.

Usage

Available APIs

JS APIs

Table 1 JS APIs for event logging

Table 2 JS event types (EventType)

Table 3 JS APIs for event logging configuration

Table 4 JS logging configuration options (ConfigOption)

Table 5 JS predefined event name constants (Event)

Table 6 JS predefined parameter name constants (Param)

Native APIs

Table 1 Native APIs for event logging

Table 2 Native APIs for constructing ParamList

Table 3 Native APIs for event logging configuration

Table 4 Predefined configuration item constants

Table 5 Predefined event name constants

Table 6 Predefined parameter name constants

How to Use

JS

1. Develop the source code.

   Import the HiAppEvent module.

   import hiAppEvent from '@ohos.hiAppEvent'

2. Log application events.

   // Callback mode
   hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => {
       if (err) {
           // Event writing failed: The event contains invalid parameters or the event parameter verification fails.
           console.error(`failed to write event because ${err.code}`);
           return;
       }
   
       // Event writing succeeded.
       console.log(`success to write event: ${value}`);
   });
   
   // Promise mode
   hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"})
       .then((value) => {
           // Event writing succeeded.
           console.log(`success to write event: ${value}`);
       }).catch((err) => {
           // Event writing failed: The event contains invalid parameters or the event parameter verification fails.
           console.error(`failed to write event because ${err.code}`);
       });

3. Customize the application event logging function.

   // Set the application event logging switch.
   hiAppEvent.configure({
       disable: true
   })
   
   // Set the maximum size of the directory that stores the event logging files.
   hiAppEvent.configure({
       maxStorage: '100M'
   })

Native

1. Develop the source code.

   Import the HiAppEvent module.

   #include "hiappevent/hiappevent.h"

2. Log application events.

   // 1. Create an empty <strong>ParamList</strong> object.
   ParamList list = OH_HiAppEvent_CreateParamList();
   
   // 2. Adds key-value pair parameters to the <strong>ParamList</strong> object.
   // 2.1 Pass a value in the int32_t format.
   int32_t num = 1;
   OH_HiAppEvent_AddInt32Param(list, "int32_key", num);
   // 2.2 Pass a value in the int32_t array format.
   int32_t nums3[] = {1, INT32_MAX, INT32_MIN};
   OH_HiAppEvent_AddInt32ArrayParam(list, "int32_arr_key", nums3, sizeof(nums3) / sizeof(nums3[0]));
   // 2.3 Pass a parameter value in the string array format.
   char str1[] = "hello";
   char str2[] = "world";
   char* strs[] = {str1, str2};
   OH_HiAppEvent_AddStringArrayParam(list, "string_arr_key", strs, sizeof(strs) / sizeof(strs[0]));
   
   // 3. Log application events.
   int result = OH_HiAppEvent_Write("domain", "name", BEHAVIOR, list);
   printf("HiAppEvent logging test, res=%d\n", result);
   
   // 4. Destroy the <strong>ParamLIst</strong> object to release the memory.
   OH_HiAppEvent_DestroyParamList(list);

3. Customize the application event logging function.

   // Disable the application event logging function.
   OH_HiAppEvent_Configure(DISABLE, "true");
   
   // Set the maximum size of the directory that stores the event logging files to 100M.
   OH_HiAppEvent_Configure(MAX_STORAGE, "100M");

Repositories Involved

DFX Subsystem

hiviewdfx_hiview

hiviewdfx_hilog

hiviewdfx_hiappevent

hiviewdfx_hisysevent

hiviewdfx_faultloggerd

hiviewdfx_hilog_lite

hiviewdfx_hievent_lite

hiviewdfx_hiview_lite