程序包 ohos.hiviewdfx

类 HiAppEvent

java.lang.Object

ohos.hiviewdfx.HiAppEvent

public class HiAppEvent
extends Object

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.

You need to customize event names, parameters, and types based on your own requirements.

The following is an example of the event logging code:

 HiAppEvent.write("app_exception", HiAppEvent.EventType.FAULT, "num", 101, "reason", "connect fail");
 

从以下版本开始:

6

嵌套类概要

嵌套类

限定符和类型	类	说明
class	HiAppEvent.Event	Preset event.
static class	HiAppEvent.EventType	Enumerates application event types.
class	HiAppEvent.Param	Preset param.

字段概要

字段

限定符和类型	字段	说明
static String	DISABLE	Application event logging switch.
static String	MAX_STORAGE	Event file directory storage quota size.

构造器概要

构造器

构造器	说明
HiAppEvent()

方法概要

限定符和类型	方法	说明
static boolean	configure(String name, String value)	Application event logging configuration interface, which is used to configure event logging switch, event file directory storage quota size and other functions.
static int	write(String eventName, HiAppEvent.EventType type, Object... keyValues)	Implements asynchronous logging of application events whose parameters are of a variable length.
static int	write(String eventName, HiAppEvent.EventType type, Map<String,Object> keyValues)	Implements asynchronous logging of application events whose parameters are of the Map type.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DISABLE

public static final String DISABLE

Application event logging switch.

从以下版本开始:

6

另请参阅:

常量字段值

MAX_STORAGE

public static final String MAX_STORAGE

Event file directory storage quota size.

从以下版本开始:

6

另请参阅:

常量字段值

构造器详细资料

HiAppEvent

public HiAppEvent()

方法详细资料

write

public static int write(String eventName,
                        HiAppEvent.EventType type,
                        Object... keyValues)

Implements asynchronous logging of application events whose parameters are of a variable length. Before logging an application event, this API will first verify parameters of this event. If the verification is successful, the API will write the event to the event file asynchronously.

参数:

eventName - Indicates the event name. You can customize the event name as needed.

type - Indicates the event type, which is defined in EventType.

keyValues - Indicates an array of event parameters, each of which is comprised of the parameter name and parameter value. The parameter name must be a string, and the parameter value must be a basic data element, a string, or a list (which can only be a basic data element or a string).

返回:

Returns 0 if the event parameter verification is successful, and the event will be written to the event file asynchronously; returns a positive integer if invalid parameters are present in the event, and the event will be written to the event file asynchronously after the invalid parameters are ignored; returns a negative integer if the event parameter verification fails, and the event will not be written to the event file asynchronously.

从以下版本开始:

6

write

public static int write(String eventName,
                        HiAppEvent.EventType type,
                        Map<String,Object> keyValues)

Implements asynchronous logging of application events whose parameters are of the Map type. Before logging an application event, this API will first verify parameters of this event. If the verification is successful, the API will write the event to the event file asynchronously.

参数:

eventName - Indicates the event name. You can customize the event name as needed.

type - Indicates the event type, which is defined in EventType.

keyValues - Indicates an array of event parameters, each of which is comprised of the parameter name and parameter value. The parameter name must be a map key, and the parameter value must be a basic data element, a string, or a list (which can only be a basic data element or a string).

返回:

Returns 0 if the event parameter verification is successful, and the event will be written to the event file asynchronously; returns a positive integer if invalid parameters are present in the event, and the event will be written to the event file asynchronously after the invalid parameters are ignored; returns a negative integer if the event parameter verification fails, and the event will not be written to the event file asynchronously.

从以下版本开始:

6

configure

public static boolean configure(String name,
                                String value)

Application event logging configuration interface, which is used to configure event logging switch, event file directory storage quota size and other functions.

参数:

name - Configuration item name.

value - Configuration item value.

返回:

Configuration result.

从以下版本开始:

6