Debian Codegraph @

third-party/libhv-v1.3.3/docs/cn/hlog.md

raw
1 日志
2
3 ```c
4
5 // 标准输出日志
6 void stdout_logger(int loglevel, const char* buf, int len);
7
8 // 标准错误日志
9 void stderr_logger(int loglevel, const char* buf, int len);
10
11 // 文件日志
12 void file_logger(int loglevel, const char* buf, int len);
13
14 // 网络日志(定义在event/nlog.h头文件里)
15 // void network_logger(int loglevel, const char* buf, int len);
16
17 // 创建日志器
18 logger_t* logger_create();
19
20 // 销毁日志器
21 void logger_destroy(logger_t* logger);
22
23 // 设置日志处理器
24 void logger_set_handler(logger_t* logger, logger_handler fn);
25
26 // 设置日志等级
27 void logger_set_level(logger_t* logger, int level);
28 // level = [VERBOSE,DEBUG,INFO,WARN,ERROR,FATAL,SILENT]
29 void logger_set_level_by_str(logger_t* logger, const char* level);
30
31 /*
32 * 设置日志格式
33 * format = "%y-%m-%d %H:%M:%S.%z %L %s"
34 * message = "2020-01-02 03:04:05.067 DEBUG message"
35 * %y year
36 * %m month
37 * %d day
38 * %H hour
39 * %M min
40 * %S sec
41 * %z ms
42 * %Z us
43 * %l First character of level
44 * %L All characters of level
45 * %s message
46 * %% %
47 */
48 void logger_set_format(logger_t* logger, const char* format);
49
50 // 设置日志缓存大小
51 void logger_set_max_bufsize(logger_t* logger, unsigned int bufsize);
52
53 // 启用日志颜色
54 void logger_enable_color(logger_t* logger, int on);
55
56 // 日志打印
57 int logger_print(logger_t* logger, int level, const char* fmt, ...);
58
59 // 设置日志文件
60 void logger_set_file(logger_t* logger, const char* filepath);
61
62 // 设置日志文件大小
63 void logger_set_max_filesize(logger_t* logger, unsigned long long filesize);
64 // 16, 16M, 16MB
65 void logger_set_max_filesize_by_str(logger_t* logger, const char* filesize);
66
67 // 设置日志文件保留天数
68 void logger_set_remain_days(logger_t* logger, int days);
69
70 // 启用每次写日志文件立即刷新到磁盘(即每次都调用fsync,会增加IO耗时,影响性能)
71 void logger_enable_fsync(logger_t* logger, int on);
72
73 // 刷新缓存到磁盘(如对日志文件实时性有必要的,可使用定时器定时刷新到磁盘)
74 void logger_fsync(logger_t* logger);
75
76 // 获取当前日志文件路径
77 const char* logger_get_cur_file(logger_t* logger);
78
79 // hlog: 默认的日志器
80 logger_t* hv_default_logger();
81
82 // 销毁默认的日志器
83 void hv_destroy_default_logger(void);
84
85 // 对默认日志器hlog的一些便利操作宏
86 #define hlog hv_default_logger()
87 #define hlog_destory() hv_destroy_default_logger()
88 /* 禁用hv的默认日志 */
89 #define hlog_disable() logger_set_level(hlog, LOG_LEVEL_SILENT)
90 #define hlog_set_file(filepath) logger_set_file(hlog, filepath)
91 #define hlog_set_level(level) logger_set_level(hlog, level)
92 #define hlog_set_level_by_str(level) logger_set_level_by_str(hlog, level)
93 #define hlog_set_handler(fn) logger_set_handler(hlog, fn)
94 #define hlog_set_format(format) logger_set_format(hlog, format)
95 #define hlog_set_max_filesize(filesize) logger_set_max_filesize(hlog, filesize)
96 #define hlog_set_max_filesize_by_str(filesize) logger_set_max_filesize_by_str(hlog, filesize)
97 #define hlog_set_remain_days(days) logger_set_remain_days(hlog, days)
98 #define hlog_enable_fsync() logger_enable_fsync(hlog, 1)
99 #define hlog_disable_fsync() logger_enable_fsync(hlog, 0)
100 #define hlog_fsync() logger_fsync(hlog)
101 #define hlog_get_cur_file() logger_get_cur_file(hlog)
102
103 #define hlogd(fmt, ...) logger_print(hlog, LOG_LEVEL_DEBUG, fmt " [%s:%d:%s]\n", ## __VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__)
104 #define hlogi(fmt, ...) logger_print(hlog, LOG_LEVEL_INFO, fmt " [%s:%d:%s]\n", ## __VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__)
105 #define hlogw(fmt, ...) logger_print(hlog, LOG_LEVEL_WARN, fmt " [%s:%d:%s]\n", ## __VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__)
106 #define hloge(fmt, ...) logger_print(hlog, LOG_LEVEL_ERROR, fmt " [%s:%d:%s]\n", ## __VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__)
107 #define hlogf(fmt, ...) logger_print(hlog, LOG_LEVEL_FATAL, fmt " [%s:%d:%s]\n", ## __VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__)
108
109 ```
110
111 测试代码见 [examples/hloop_test.c](../../examples/hloop_test.c)