OpenHarmony子系统开发 - DFX（一）

一、DFX概述

简介

在OpenHarmony中，DFX(Design for X)是为了提升质量属性的软件设计，目前包含的内容主要有：DFR（Design for Reliability，可靠性）和DFT（Design for Testability，可测试性）特性。

提供以下功能：

HiLog流水日志，标准系统类设备（参考内存≥128MB）适用、HiLog_Lite轻量流水日志，轻量系统类设备（参考内存≥128KiB），小型系统类设备（参考内存≥1MiB）适用。
HiTraceChain分布式跟踪，标准系统类设备（参考内存≥128MiB）适用。
HiTraceMeter性能跟踪，标准系统类设备（参考内存≥128MiB）适用。
HiCollie卡死故障检测，标准系统类设备（参考内存≥128MiB）适用。
HiSysEvent系统事件埋点，标准系统类设备（参考内存≥128MiB）适用。
HiDumper信息导出，标准系统类设备（参考内存≥128MB）适用。
Faultlogger崩溃故障检测，标准系统类设备（参考内存≥128MB）适用。
Hiview插件平台，标准系统类设备（参考内存≥128MB）适用。
HiAppEvent应用事件及HiChecker缺陷扫描仅供应用开发者使用。

基本概念

流水日志：

流水日志是系统运行过程中产生的一些日志信息，用于开发人员了解系统或应用运行过程、状态。

分布式跟踪：

在一个分布式系统中，一次业务的发起往往会涉及多个软件模块，通过进程内、进程间、设备间的通信接口进行控制和数据传递，为了便于开发人员对这类复杂流程的理解和问题跟踪定界，DFX提供了一个分布式跟踪框架。

线程卡死故障：

线程在运行过程中，如果进入死循环，或者陷入内核态（Uninterruptable Sleep、Traced、Zombie等状态，或者其他同步等待状态），将无法响应正常的业务请求，且无法自己实现故障的感知和恢复。检测和定位这类故障需要通过一个简单的watchdog机制，在易于发生卡死的流程中插入检测点，在发生卡死故障的时候，进行故障恢复和日志采集。

埋点：

是在程序关键处理流程中加入一些代码，采集程序运行过程中信息的一种技术，用于支持分析产品的使用情况。

系统事件：

是OpenHarmony系统某种状态产生的一种标识，通过定义各种事件用于分析系统的状态变化情况。

二、HiLog开发指导

概述

HiLog是OpenHarmony日志系统，提供给系统框架、服务、以及应用打印日志，记录用户操作、系统运行状态等。

本章节内容对标准系统类设备（参考内存≥128MiB）适用。

接口说明

表1 C++、C的函数接口

C++		C
类	方法	方法/宏
HiLog	int Debug(const HiLogLabel &label, const char *fmt, ...)	HILOG_DEBUG(type, ...)
	int Info(const HiLogLabel &label, const char *fmt, ...)	HILOG_INFO(type, ...)
	int Warn(const HiLogLabel &label, const char *fmt, ...)	HILOG_WARN(type, ...)
	int Error(const HiLogLabel &label, const char *fmt, ...)	HILOG_ERROR(type, ...)
	int Fatal(const HiLogLabel &label, const char *fmt, ...)	HILOG_FATAL(type, ...)
	NA	int HiLogPrint(LogType type, LogLevel level, unsigned int domain, const char tag, const char fmt, ...)
	boolean IsLoggable(unsigned int domain, const char *tag, LogLevel level)	bool HiLogIsLoggable(unsigned int domain, const char *tag, LogLevel level)
HiLogLabel	struct HiLogLabel	LOG_DOMAIN LOG_TAG

表2 C++接口说明函数参数和功能

类	方法	描述
HiLog	int Debug(const HiLogLabel &label, const char *fmt, ...)	功能：输出 debug 级别日志。输入参数： - label：用于标识输出日志的类型、业务领域、TAG。 - format：常量格式字符串，包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 - fmt：格式化变参描述字符串。输出参数：无。返回值：大于等于0，成功；小于0，失败。
	int Info(const HiLogLabel &label, const char *fmt, ...)	功能：输出 info 级别日志。参数说明同 Debug 接口。
	int Warn(const HiLogLabel &label, const char *fmt, ...)	功能：输出 warn 级别日志。参数说明同 Debug 接口。
	int Error(const HiLogLabel &label, const char *fmt, ...)	功能：输出 error 级别日志。参数说明同 Debug 接口。
	int Fatal(const HiLogLabel &label, const char *fmt, ...)	功能：输出 fatal 级别日志。参数说明同 Debug 接口。
	boolean IsLoggable(unsigned int domain, const char *tag, LogLevel level)	功能：检查指定业务领域、TAG、级别的日志是否可以打印。输入参数： - domain：指定日志业务领域。 - tag: 指定日志TAG。 - level: 指定日志level。输出参数：无。返回值：如果指定domain、tag、level日志可以打印则返回true；否则返回false。
HiLogLabel	struct HiLogLabel	功能：初始化日志标签参数。成员参数： - type: 指定日志type。 - domain：指定日志业务领域。 - tag: 指定日志TAG。

开发实例

C使用示例

在.c源文件中，包含hilog头文件：

复制代码

#include "hilog/log.h"

定义domain、tag：

复制代码

#undef LOG_DOMAIN
#undef LOG_TAG
#define LOG_DOMAIN 0xD003200  // 标识业务领域，范围0xD000000~0xD0FFFFF
#define LOG_TAG "MY_TAG"

打印日志：

复制代码

HILOG_INFO(LOG_CORE, "Failed to visit %{private}s, reason:%{public}d.", url, errno);

编译设置，在BUILD.gn里增加子系统SDK依赖：
复制代码
```
external_deps = [ "hilog:libhilog" ]
```

C++使用示例

在.h类定义头文件中，包含hilog头文件：

复制代码

#include "hilog/log.h"

如果类头文件中需要日志打印，在头文件中类定义起始处定义 LABEL：

复制代码

class MyClass {
static constexpr OHOS::HiviewDFX::HiLogLabel LABEL = {LOG_CORE, 0xD003200, "MY_TAG"}; 
......
}

如果类头文件中没有日志打印，在类实现文件中定义 LABEL：

复制代码

using namespace OHOS::HiviewDFX;
static constexpr HiLogLabel LABEL = {LOG_CORE, 0xD003200, "MY_TAG"};

打印日志：

复制代码

HiLog::Info(LABEL, "Failed to visit %{private}s, reason:%{public}d.", url, errno);

编译设置，在BUILD.gn里增加子系统SDK依赖：
复制代码
```
external_deps = [ "hiviewdfx:libhilog" ]
```