11 Star 82 Fork 113

OpenHarmony / hiviewdfx_hilog_lite

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Hilog_lite组件介绍

简介

提供DFX子系统在轻量系统和小型系统的流水日志功能。

目录

表 1 DFX子系统hilog_lite组件代码目录结构

名称

描述

interfaces/native/kits/hilog

小型系统流水日志对外接口定义

interfaces/native/kits/hilog_lite

轻量系统流水日志对外接口定义

services/hilogcat

小型系统流水日志相关服务和命令

services/apphilogcat

小型系统流水日志落盘服务

command

轻量系统日志查询命令

frameworks/featured

小型系统流水日志接口实现

frameworks/mini

轻量系统流水日志接口实现

约束

轻量系统整体代码使用标准C开发。

使用-轻量系统

  • 以下以A模块为例说明如何添加模块并进行日志打印。
    1. 第一步添加模块ID

      在“base/hiviewdfx/hilog_lite/interfaces/native/kits/hilog_lite/hiview_log.h“中添加HILOG_MODULE_A定义。

      typedef enum {
          /** DFX */    
          HILOG_MODULE_HIVIEW = 0,    
          /** System Module A */    
          HILOG_MODULE_A,    
          /** Maximum number of modules */
          HILOG_MODULE_MAX
      } HiLogModuleType;
    2. 第二步模块注册

      在A模块的初始化流程中添加如下代码,注册模块到日志框架中:

      HiLogRegisterModule(HILOG_MODULE_A, "A");
    3. 第三步日志打印

      在需要打印日志的.c文件中 #include "log.h",调用如下接口:

      HILOG_INFO(HILOG_MODULE_A,“log test: %d”, 88);

      接口参数说明:

      参数名

      是否必填

      参数类型

      参数说明

      mod

      uint8

      模块\服务的ID。

      统一规划分配,最大支持64个,其中第三方APP统一使用HILOG_MODULE_APP作为模块ID。

      fmt

      char *

      格式化输出字符串。

      1、 最大支持6个可变参数,不支持%s。

      2、 格式化后的单条日志最大长度128字节,超过将无法打印。

      可变参

      int32

      仅支持数字类型,最大支持6个变参。

使用-小型系统

Native C/C++接口

hilog 可用API

HILOG_DEBUG(type, ...)
HILOG_INFO(type, ...)
HILOG_WARN(type, ...)
HILOG_ERROR(type, ...)
HILOG_FATAL(type, ...)

使用介绍

  1. 首先需要定义TAG。

  2. 本地调试,可以临时使用domain数值 0。

  3. 包含头文件:#include <hilog/log.h>

  4. 在BUILD.gn中添加依赖库 libhilog。

接口规则介绍:

  1. 格式化字符串默认是非隐私 HILOGI("Hello World\n"); >> Hello World

  2. 格式化参数默认是隐私 HILOGI("Age is %d\n", 10); >> Age is <private>

  3. %{private}标识的参数是隐私 HILOGI("Age is %{private}d\n", 10); >> Age is <private>

  4. %{public}标识的参数是非隐私 HILOGI("Age is %{public}d\n", 10); >>Age is 10

接口参数介绍

参数名字

参数含义

domain

领域标识ID

tag

日志tag

isFmtPrivate

标识格式化字符串fmt是否是隐私,是yes时fmt会被认为是隐私

fmt

格式化字符串

args

格式化字符串参数

日志查看

  1. debug版本hilog日志会保存到/storage/data/log/目录下面。

  2. 可以执行hilogcat实时查看hilog日志。

日志系统架构

  1. hilogtask流水日志的内核任务。

    • 此功能是一个linux内核的任务或者线程,在系统启动时初始化。
    • 当内核中一个模块调用它的日志接口,将格式化好的日志内容传输给改任务,并将其存储在一个环形缓冲区中 。
    • 当用户态调用日志接口,将格式化好的日志内容通过ioctl调用写入驱动节点,驱动节点再将日志内容发送到hilogtask,hilogtask将日志内容存储到环形缓冲区中。
  2. hilogcatd用户态日志存储服务。

    • 这是一个用户态的进程,负责定时将内核的ringbuffer读取出来,存储到日志文件中。
    • 日志文件输出支持gzip压缩,使用zlib
    • 存储文件的单个文件大小,文件个数可在编译时配置。
  3. hilogcat日志查看命令行工具。

    从内核驱动接口读取ringbuffer内容,输出到标准输出。

  4. 支持日志缓冲区可配置。

    • 编译时可以配置日志缓冲区的大小。

涉及仓

DFX子系统

hiviewdfx_hilog_lite

hiviewdfx_hiview_lite

hiviewdfx_hievent_lite

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS

简介

暂无描述 展开 收起
C 等 3 种语言
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/openharmony/hiviewdfx_hilog_lite.git
git@gitee.com:openharmony/hiviewdfx_hilog_lite.git
openharmony
hiviewdfx_hilog_lite
hiviewdfx_hilog_lite
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891