HiAppEvent

Введение

HiAppEvent — это модуль OpenHarmony, который предоставляет функцию логирования событий для приложений. С помощью этой функции приложения могут регистрировать события, связанные с ошибками, статистикой, безопасностью и поведением пользователей во время работы. На основе информации о событиях можно анализировать состояние работы приложений.

Рисунок 1. Архитектура HiAppEvent

Структура директорий

/base/hiviewdfx/hiappevent   # Исходный код HiAppEvent
├── frameworks               # Код фреймворка
│   └── native               # Реализация кода нативных API логирования
├── interfaces               # Внешние API
│   └── js                   # JS API
│       └── innerkits        # Реализация кода JS API
│           └── napi         # Реализация JS API на основе NAPI
├── test                     # Тестовые случаи

Компиляция и сборка

Используйте Clang 8.0.0 и C++11 или более позднюю версию.

Использование

Доступные API

JS API

Таблица 1. JS API для логирования событий

Входные аргументы:

• eventName: указывает имя события.
• type: указывает тип события.
• keyValues: указывает пары ключ-значение параметров события. Значение представлено в формате JSON.
• callback: указывает обратный вызов, используемый для обработки полученного возвращаемого значения. Значение 0 указывает на успешную проверку параметров события, и событие будет записано в файл событий асинхронно. Значение больше 0 указывает на наличие недопустимых параметров в событии, и событие будет записано в файл событий асинхронно после игнорирования недопустимых параметров. Значение меньше 0 указывает на сбой проверки параметров события, и событие не будет записано в файл событий асинхронно.* Тип массива char и его добавление в ParamList.*

Таблица 3. Собственные API для настройки логирования событий

Таблица 4. Предопределённые константы элементов конфигурации

Таблица 5. Предопределенные константы событий

Таблица 6. Предопределенные константы параметров

Как использовать

JS

1. Разработайте исходный код. Импортируйте модуль HiAppEvent.

import hiAppEvent from '@ohos.hiAppEvent'

2. Регистрируйте события приложения.

// Режим обратного вызова
hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => {
    if (err) {
        // Ошибка при записи события: событие содержит недопустимые параметры или проверка параметров события завершается неудачно.
        console.error(`failed to write event because ${err.code}`);
        return;
    }

    // Запись события прошла успешно.
    console.log(`success to write event: ${value}`);
});

// Режим Promise
hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"})
    .then((value) => {
        // Запись события прошла успешно.
        console.log(`success to write event: ${value}`);
    }).catch((err) => {
        // Ошибка при записи события: событие содержит недопустимые параметры или проверка параметров события завершается неудачно.
        console.error(`failed to write event because ${err.code}`);
    });

3. Настройте функцию логирования событий приложения по своему усмотрению.

// Установите переключатель логирования событий приложения.
hiAppEvent.configure({
    disable: true
})

// Задайте максимальный размер каталога, в котором хранятся файлы логирования событий.
hiAppEvent.configure({
    maxStorage: '100M'
})

Native

1. Разработайте исходный код. Импортируйте модуль HiAppEvent.

#include "hiappevent/hiappevent.h"

2. Зарегистрируйте события приложения.