Skip to content

Commit 5e329c6

Browse files
committed
更新文档
1 parent 5f099dd commit 5e329c6

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ One or more of the three sink can be selected in the startup parameters, and can
5252
The log content includes: level, time (accurate to microseconds), thread number, module name, function name, text, file name, line number.
5353
It is convenient and quick to locate the problem.
5454
![log show](documents/images/0002-log-show.png)
55+
As shown in the figure above, different log levels are clearly distinguished by colors. In particular, for anomalies, red and yellow are used together with highlighting, making them very eye-catching.
5556

5657
**3) Flexible log output filter**
5758
The log level can be set separately for different modules when the program is running, as follows:
@@ -71,15 +72,17 @@ The main thread entrusts the child thread to execute:
7172

7273
## 7. Graceful exit process
7374
When receiving signals: SIGINT, SIGTERM, SIGQUIT, SIGPWR, it will execute the exit process in an orderly manner and release resources. Do a clean exit.
74-
![graceful exit](documents/images/0002-exit-friendly.gif)
75+
![graceful exit](documents/images/0002-exit-friendly.gif)
76+
This is crucial for ensuring program integrity and conducting memory analysis.
7577

7678
## 8. Comprehensive exception capture mechanism
7779
When various program exceptions occur in the program, such as: segment fault, assertion, bus error, exception not caught, etc., the framework will capture and print the complete call stack in the log system. Facing program crashes, no longer look blank. The effect is as follows:
7880
![stack print](documents/images/0006-error-dump.png)
81+
With this mechanism in place, analyzing program crash issues of online devices becomes very simple, and there is basically no need to use gdb to analyze coredumps.
7982

8083
## 9. Visualized trace module
81-
The trace module can record the time and duration of each execution of the marked function, and can export the flame graph for display:
82-
![trace fire graph](documents/images/0011-trace-view.png)
84+
The trace module can record the time and duration of each execution of the marked function, and can export the icicle diagram for display:
85+
![icicle diagram](documents/images/0011-trace-view.png)
8386
It is a great tool for performance analysis and event blocking problem troubleshooting.
8487

8588
## 10. Simple and visualized state machine

README_CN.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
日志内容包含了:等级、时间(精确到微秒)、线程号、模块名、函数名、正文、文件名、行号。
5353
方便快速定位问题。
5454
![日志打印展示](documents/images/0002-log-show.png)
55+
如上图所示,不同的日志等级颜色分明,特别是针对异常,采用红黄两色配合高亮进行显示,非常醒目。
5556

5657
**3) 灵活的日志输出过滤器,且能运行时修改**
5758
可在程序运行时针对不同的模块单独设置日志等级,如下:
@@ -70,16 +71,19 @@
7071
![ThreadPool示例](documents/images/0004-run-thread-pool.png)
7172

7273
## 7. 支持优雅的退出流程
73-
在接收到信号:SIGINT, SIGTERM, SIGQUIT, SIGPWR 时,会有序地执行退出流程,释放资源。做到干净地退出。
74-
![友好地退出](documents/images/0002-exit-friendly.gif)
74+
在接收到信号:SIGINT, SIGTERM, SIGQUIT, SIGPWR 时,会有序地执行退出流程,释放资源。做到干净地退出。
75+
![友好地退出](documents/images/0002-exit-friendly.gif)
76+
这对保证程序的完整性与开展内存分析非常重要。
7577

7678
## 8. 有全面的异常捕获机制
77-
当程序出现各种程序异常,如:段错误、断言、总线错误、异常未捕获等,架框会捕获并在日志系统中打印完整的调用栈。面对程序崩溃,不再一脸茫然。效果如下:
79+
当程序出现各种程序异常,如:段错误、断言、总线错误、异常未捕获等,架框会捕获并在日志系统中打印完整的调用栈。面对程序崩溃,不再一脸茫然。
80+
效果如下:
7881
![异常栈打印](documents/images/0006-error-dump.png)
82+
有该机制后,分析线上设备的程序崩馈问题便非常简单,基本上不需要使用gdb对coredump进行分析。
7983

8084
## 9. 有可视化的运行跟踪模块
81-
trace模块能记录被标记的函数每次执行的时间点与时长,可导出火焰图进行展示
82-
![trace火焰图](documents/images/0011-trace-view.png)
85+
trace模块能记录被标记的函数每次执行的时间点与时长,可导出冰锥图进行展示
86+
![trace冰锥图](documents/images/0011-trace-view.png)
8387
它是性能分析、事件阻塞问题排查了一大利器。
8488

8589
## 10. 有简单易用的状态机
-350 KB
Loading

0 commit comments

Comments
 (0)