1@page ulog ulog
2
3[更正文档](https://gitee.com/alios-things/ulog/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7ulog是AliOS Things的日志模块，同时支持经典同步机制和异步日志机制，异步机制使其他逻辑任务保持正常工作，基于简短的日志格式和syslog协议格式，日志内容可以通过不同方式输出（uart udp vfs uagent）， 此外，文件系统中的日志文件可以通过http上传至云端。
8组件支持以下功能：
9- 通过串口输出日志
10- 通过UDP输出日志
11- 通过文件系统输出日志
12- 通过uagent输出日志到云端
13
14
15## 版权信息
16> Apache license v2.0
17
18## 目录结构
19```tree
20ulog
21├── README.md #ulog说明文档
22├── example
23│   └── ulog_example.c      #ulog使用demo
24├── include
25│   ├── ulog_config.h       #ulog相关配置头文件
26│   └── ulog
27│       └── ulog.h          #ulog使用API头文件
28├── internal                #内部头文件
29│   ├──ulog_api.h
30│   ├──ulog_ring_fifo.h
31│   └──ulog_session_file.h
32├── src
33│   ├── ulog_async.c        #ulog 异步日志输出功能
34│   ├── ulog.c              #ulog 整体功能
35│   ├── ulog_fs_cfg.c       #ulog 文件系统配置
36│   ├── ulog_init.c         #ulog 初始化
37│   ├── ulog_ring_fifo.c    #ulog ring fifo功能，供异步使用
38│   ├── ulog_session_file.c #ulog 日志到文件系统
39│   ├── ulog_session_udp.c  #ulog 日志通过UDP发出
40│   └── ulog_utility.c      #ulog 通用功能
41```
42
43## 依赖组件
44* vfs
45* uagent
46* linksdk
47* fatfs
48
49# 常用配置
50系统中相关配置已有默认值，如需修改配置，统一在yaml中**def_config**节点修改，具体如下：
51> 开启异步打印: 默认0, 如需修改，在yaml中修改ULOG_CONFIG_ASYNC配置
52```sh
53def_config:
54  ULOG_CONFIG_ASYNC: 1
55```
56> 支持日志实时上传到云，默认不开启，可按照实际需要修改yaml配置如：
57```sh
58def_config:
59  ULOG_CONFIG_POP_CLOUD: 0
60  ULOG_CONFIG_STOP_FILTER_CLOUD: 5
61```
62
63
64# API说明
65
66- 参考 [aos_ulog](https://g.alicdn.com/alios-things-3.3/doc/group__aos__ulog.html)
67
68# 使用示例
69组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
70待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
71
72## 步骤1 创建或打开工程
73
74**打开已有工程**
75
76如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
77
78**创建新的工程**
79
80组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
81
82## 步骤2 添加组件
83
84案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
85
86```sh
87depends:
88  - ulog: master # helloworld_demo中引入ulog组件
89```
90
91## 步骤3 下载组件
92
93在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
94
95```shell
96
97aos install ulog
98
99```
100
101上述命令执行成功后，组件源码则被下载到了./components/ulog路径中。
102
103## 步骤4 添加示例
104
105> ulog组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/ulog/tree/master/example)：
106
107```yaml
108source_file:
109  - src/ulog_async.c? <ULOG_CONFIG_ASYNC>
110  - src/ulog.c
111  - src/ulog_fs_cfg.c? <ULOG_CONFIG_POP_FS>
112  - src/ulog_init.c
113  - src/ulog_ring_fifo.c
114  - src/ulog_session_file.c? <ULOG_CONFIG_POP_FS>
115  - src/ulog_session_udp.c? <ULOG_CONFIG_POP_UDP>
116  - src/ulog_utility.c
117  - example/ulog_example.c #add ulog example code
118```
119> ulog 设置日志输出等级，默认为不输出
120
121```c
122    aos_set_log_level(AOS_LL_DEBUG);
123```
124
125## 步骤5 编译固件
126
127在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
128
129## 步骤6 烧录固件
130
131helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
132
133## 步骤7 打开串口
134
135固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
136
137当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
138
139## 步骤8 测试示例
140
141
142**CLI命令行输入：**
143```sh
144ulog_example_test
145```
146# FAQ
147