8e512563e4
Some checks failed
test on Windows / test (push) Has been cancelled
test on Linux / test (push) Failing after 7m1s
* #feat 增强Fatal级别的底色，修改logging类的方法 * 更新版本号 * 加入test脚本 * fix:conanfile * test action * 修复错别字 * add test on windows action * fix test on windows action * fix action on windows * fix * fix 内存分配错误 * fix msvc 不支持中文注释，删除中文注释 * test on windows and test chinese char * ersion 0.2.4 * feature:根据文件大小分割日志 * fix:内存泄露 * fix:使用char偏移单位 * add english brief * 修改api函数名，加入Default关键字，减除歧义 * Multiple substring interceptors * 更新版本号 * #fix 拦截器对level参数无效 * fix * #将拦截器改名为过滤器，更加接近职能 * 更新自述文件 * 更新一些自述文件
180 lines
4.2 KiB
Markdown
180 lines
4.2 KiB
Markdown
# C语言日志库logging
|
||
|
||
[English](README.en.md)
|
||
|
||
## 简介
|
||
|
||
logging是一个轻量级的简单易用C语言日志库，支持日志级别、日志格式、日志输出、日志文件等功能。
|
||
|
||
## 功能
|
||
|
||
- 支持日志级别：DEBUG、INFO、WARN、ERROR、FATAL
|
||
- 支持日志格式：时间戳、日志级别、日志内容
|
||
- 支持日志输出：控制台、文件
|
||
- 支持日志文件：自动创建、自动滚动、日志分割
|
||
|
||
## 安装
|
||
### conan安装使用
|
||
```shell
|
||
git clone https://github.com/WangZhongDian/logging.git
|
||
cd logging
|
||
conan create .
|
||
```
|
||
在你的项目的conanfile.txt中添加
|
||
```txt
|
||
[requires]
|
||
logging/0.5.0
|
||
```
|
||
|
||
```shell
|
||
conan install . --build=missing
|
||
```
|
||
|
||
### cmake安装使用
|
||
```shell
|
||
git clone https://github.com/WangZhongDian/logging.git
|
||
cd logging
|
||
cmake build -B build . && cd build && cmake --build .
|
||
cmake --install .
|
||
```
|
||
|
||
## 使用方法
|
||
|
||
|
||
|
||
### 控制台日志
|
||
```c
|
||
#include "logging.h"
|
||
|
||
int main() {
|
||
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
|
||
|
||
log_info("This is an info message");
|
||
log_error("This is an error message%s", "123");
|
||
log_fatal("This is an fatal message");
|
||
log_debug("This is a debug message");
|
||
log_warning("This is a warning message%s", "123");
|
||
|
||
destroyDefaultLogger();
|
||
return 0;
|
||
}
|
||
```
|
||
|
||
### 文件日志
|
||
```c
|
||
#include "logging.h"
|
||
#include "logging/logging-handler.h"
|
||
|
||
int main() {
|
||
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
|
||
logger->addHandler(loggingHandlerFile("test1", 1024*1024));
|
||
|
||
log_info("This is an info message");
|
||
log_error("This is an error message%s", "123");
|
||
log_fatal("This is an fatal message");
|
||
log_debug("This is a debug message");
|
||
log_warning("This is a warning message%s", "123");
|
||
|
||
destroyDefaultLogger();
|
||
return 0;
|
||
}
|
||
```
|
||
|
||
### 日志过滤器
|
||
> 支持添加自定义的过滤器， 目前内置了子串过滤器
|
||
|
||
> 过滤器的作用:可以将过滤到的日志重定向到过滤器的专属处理器中
|
||
|
||
|
||
#### 单个子串过滤器
|
||
将过滤到的日志重定向到专属处理器中
|
||
```c
|
||
#include "logging.h"
|
||
#include <stdio.h>
|
||
|
||
int main() {
|
||
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
|
||
|
||
log_info("This is an info message");
|
||
log_error("This is an error message%s", "123");
|
||
log_fatal("This is an fatal message");
|
||
log_debug("This is a debug message");
|
||
log_warning("This is a warning message%s", "123");
|
||
|
||
char *test1[] = {"123", "tt", NULL};
|
||
|
||
log_filter *tint = loggingFilterSubStr(
|
||
test1,
|
||
LOG_DEBUG,
|
||
loggingHandlerFile("test_interceptor", 1024 * 1024),
|
||
true);
|
||
|
||
logger->addFilter(tint);
|
||
|
||
printf("\n");
|
||
printf("filter added\n");
|
||
printf("\n");
|
||
|
||
log_info("This is an info message");
|
||
log_error("This is an error message%s", "123");
|
||
log_fatal("This is an fatal message");
|
||
log_debug("This is a debug message");
|
||
log_warning("This is a warning message%s", "123");
|
||
|
||
destroyDefaultLogger();
|
||
return 0;
|
||
}
|
||
```
|
||
|
||
#### 多个子串过滤器
|
||
```c
|
||
#include "logging.h"
|
||
#include <stdbool.h>
|
||
#include <stdio.h>
|
||
#include <time.h>
|
||
|
||
int main() {
|
||
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
|
||
|
||
log_info("This is an info message");
|
||
log_error("This is an error message%s", "123");
|
||
log_fatal("This is an fatal message");
|
||
log_debug("This is a debug message");
|
||
log_warning("This is a warning message%s", "123");
|
||
|
||
char *test1[] = {"This",NULL};
|
||
|
||
log_filter *tint = loggingFilterSubStr(
|
||
test1,
|
||
LOG_DEBUG,
|
||
loggingHandlerFile("test_interceptor", 1024 * 1024),
|
||
false);
|
||
|
||
logger->addFilter(tint);
|
||
|
||
char *test2[] = {"123",NULL};
|
||
|
||
log_filter *tint1 = loggingFilterSubStr(
|
||
test2,
|
||
LOG_DEBUG,
|
||
loggingHandlerFile("test_interceptor1", 1024 * 1024),
|
||
true);
|
||
|
||
logger->addFilter(tint1);
|
||
|
||
printf("\n");
|
||
printf("filter added\n");
|
||
printf("\n");
|
||
|
||
log_info("This is an info message");
|
||
log_error("This is an error message%s", "123");
|
||
log_fatal("This is an fatal message");
|
||
log_debug("This is a debug message");
|
||
log_warning("This is a warning message%s", "123");
|
||
|
||
destroyDefaultLogger();
|
||
return 0;
|
||
}
|
||
```
|
||
|