Debian Codegraph @

docs/log/index.zh_CN.md

raw
1 @page DLog dlog--DTK日志组件
2
3 # Dlog:DTK日志组件
4
5 ## 简介
6
7 DTK日志组件,提供了日志的输出、日志级别的设置、日志文件的设置等功能。为了简化日志的使用,我们提供了两种使用方式,一种是使用宏,另一种是使用类。
8 但是更为建议使用宏的方式进行使用。因为使用宏可以输出更多的信息,比如文件名、函数名、行号等。
9
10 ## 使用
11
12 ### 宏
13
14 DTK日志组件提供了一系列的宏,用于输出日志。这些宏的定义在dloggerdefs.h中
15 如果需要使用宏,则需要在你的代码中包含`DLog`文件。
16 @note DTK更推荐使用CPP标准引入头文件的方式,即使用`#include <DLog>`的方式引入头文件,而不是使用`#include "xxxxx.h"`的方式引入头文件。
17
18 示例代码如下:
19
20 ```cpp
21 #include <DLog>
22 #include <QCoreApplication>
23 DCORE_USE_NAMESPACE
24
25 int main(int argc, char **argv)
26 {
27 QCoreApplication app(argc, argv);
28 #ifdef Q_OS_LINUX
29 DLogManager::registerJournalAppender();
30 #endif
31 DLogManager::registerConsoleAppender();
32 dDebug() << "this is a debug message";
33 return app.exec();
34 }
35 ```
36
37 上述代码中,我们使用了dDebug()宏,用于输出一条debug级别的日志。在输出日志时,我们可以使用`<<`运算符,将多个变量输出到日志中。
38 注意,registerJournalAppender()仅在Linux平台下有效,因为journal仅在Linux平台下有效。而registerConsoleAppender()则是在所有平台下都有效。
39
40 ### 类
41
42 使用类的方式需要先创建一个logger对象,然后使用logger对象的方法来输出日志,具体请参见logger文档
43
44 ## 注意事项
45
46 ### 日志级别
47
48 DTK使用的日志级别与Qt的日志级别一致,分别为:Trace、Debug、Info、Warning、Error、Fatal。其中Trace是最低级别,Fatal是最高级别。
49 与之不同的是journal的日志级别和DTK的日志级别不一致,journal的日志级别分别为:emergency、alert、critical、error、warning、notice、info、debug。
50 这是因为journal的日志级别是从syslog中继承过来的,而syslog的日志级别是从BSD的syslog中继承过来的。而DTK的日志级别是从Qt的日志级别中继承过来的。
51 下表是DTK日志级别和journal日志级别的对应关系
52 | DTK值 | 序号 | 含义 | syslog值 | syslog序号 |
53 |---------|----|-------------------------------------|-------------|----------|
54 | dTrace | 0 | 追踪级别,可用于大部分不需要的记录,用于内部代码追踪 | 无 | |
55 | dDebug | 1 | 调试级别,用于软件的调试。 | LOG_DEBUG | 7 |
56 | dInfo | 2 | 信息级别,可用于信息记录,这可能不仅对开发者有意义 | LOG_INFO | 6 |
57 | dWarning | 3 | 警告,可以用来记录你的应用程序检测到的一些非致命的警告 | LOG_WARNING | 4 |
58 | dError | 4 | 错误,可能是一个较大问题,导致你的程序工作出错,但不至于崩溃 | LOG_ERR | 3 |
59 | dFatal | 5 | 致命错误,用于不可恢复的错误,在写入日志记录后立即崩溃应用程序(终止) | LOG_EMERG | 0 |
60 | | | | LOG_ALERT | 1 |
61 | | | | LOG_CRIT | 2 |
62 | | | | LOG_NOTICE | 6 |
63
64 ### 日志文件
65
66 如果你选择使用journal作为日志输出,那么你需要在系统中安装systemd(一般的linux发行版都会自带systemd)。并且需要确保`/var/log/journal/`
67 目录的存在,否则journal会将日志写入到`/run/log/journal/`目录中。
68
69 如果你选择使用控制台作为日志输出,那么不会生成日志文件。
70
71 如果你选择使用文件作为日志输出,那么你需要确保你的日志文件所在的目录存在,否则会导致日志文件无法创建。
72
73 ### 日志格式
74
75 如果你选择使用journal作为日志输出,且使用宏的方式进行日志输出,那么日志的格式为:
76 `[时间] [进程ID] [线程ID] [日志级别] [文件名:行号] [函数名] [日志内容]`,你仅需要关注日志内容即可。其他的信息都是journal自动添加的。
77
78
79 @defgroup dlog
80 @brief DTK日志组件
81 @details
82 DTK日志组件,提供了日志的输出、日志级别的设置、日志文件的设置等功能。
83 对于DTK日志组件,我们提供了两种使用方式,一种是使用宏,另一种是使用类。
84 但是更为建议使用宏的方式进行使用