# tinylog

**Repository Path**: gmind31/tinylog

## Basic Information

- **Project Name**: tinylog
- **Description**: A lightweight C-language log component for UNIX environment, It is a high performance, asynchronized, thread-safe and process-safe log library for C/C++; tinylog是一个专为UNIX设计的轻量级的C／C++日志模块，其提供了高性能，异步，线程安全，进程安全的日志功能。
clone from https://github.com/pymumu/tinylog
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2018-05-21
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# Tinylog

Tinylog是一个UNIX环境下轻量级的C/C++高性能异步日志组件，其提供了高性能，异步，线程安全，进程安全的日志功能。

支持日志归档，支持多线程并发写日志，多进程并发写日志，支持非阻塞日志。

日志输出例子

```c
[2018-04-03 21:52:13,485][ INFO][        example.c:7   ] This is a log message.
```

归档目录例子

```c
root@raspberrypi:/home/pi/code/tiny-log/test # ls log/ -l
total 11564
-rw-r----- 1 root root 8754060 Apr 20 21:48 test.log
-rw-r----- 1 root root 1543852 Apr 20 21:48 test.log-20180420-214824.gz
-rw-r----- 1 root root 1539119 Apr 20 21:48 test.log-20180420-214830.gz
```

## 特性

1. 日志压缩归档。
2. 日志级别输出。
3. 日志格式定制。
4. 异步日志输出。
5. 多日志文件支持。
6. printf,vprintf类似接口，易于扩展。
7. 非阻塞日志。
8. 多线程并发写。
9. 多进程并发写。

## 使用

1. 将日志头文件`tlog.h`包含到C代码的中。
2. 调用`tlog_init`初始化日志模块。
3. 调用`tlog`日志输出函数输出日志。
4. 调用`tlog_exit`退出关闭日志组件。

## 例子

1. 输出日志

    ```c
    #include <stdio.h>
    #include "tlog.h"

    int main(int argc, char *argv[])
    {
        tlog_init("./", "example.log", 1024 * 1024, 8, 1, 0, 0);
        tlog(TLOG_INFO, "This is a log message.\n");
        tlog_exit();
        return 0;
    }
    ```

1. 独立日志流

    ```c
    #include <stdio.h>
    #include "tlog.h"

    int main(int argc, char *argv[])
    {
        tlog_log *log = NULL;
        tlog_init("./", "example.log", 1024 * 1024, 8, 1, 0, 0);
        log = tlog_open("./another.log", 1024 * 1024, 8, 1, 0, 0);
        tlog_printf(log, "This is a separate log stream.\n");
        tlog_close(log);
        tlog_exit();
        return 0;
    }
    ```

如果要让日志中文件名不包含路径，在编译的时候，可指定编译宏BASE_FILE_NAME，在Makefile中可指定如下语句，实现编译时生成短文件名：(例子请参考example的makfile。)  
makefile  

```C
CFLAGS += -DBASE_FILE_NAME=\"$(notdir $<)\"
```

cmake  

```C
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DBASE_FILE_NAME='\"$(notdir $<)\"'")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DBASE_FILE_NAME='\"$(notdir $<)\"'")
```

## API说明

1. int tlog_init(const char *logfile, int maxlogsize, int maxlogcount, int block, int buffsize);  

    `功能`: 初始化日志模块  
    `logfile`: 日志文件。  
    `maxlogsize`: 单个日志文件最大大小。  
    `maxlogcount`: 归档日志个数。  
    `block`: 缓冲区不足时，是否阻塞。  
    `buffsize`: 缓冲区大小。  
    `multiwrite`: 启用多进程写单个日志模式. (注意: 当使用此模式时，所有进程的maxlogsize参数必须一样)  

1. tlog(level, format, ...)  

    `功能`: 打印日志  
    `level`: 当前日志级别  
    `format`: 日志格式。  

1. tlog_exit（）  

    `功能`: 日志组件退出。  

1. tlog_reg_format_func(tlog_format_func func)  

    `功能`: 注册自定义格式函数，回调函数定义为: tlog_format_func 

1. tlog_setlevel(tlog_level level)  

    `功能`: 设置日志级别，有效参数为TLOG_DEBUG, TLOG_INFO, TLOG_NOTICE, TLOG_WARN, TLOG_ERROR, TLOG_FATAL  

1. tlog_setlogscreen(int enable)  

    `功能`: 设置日志是否输出到屏幕。  
    `enable`: 是否启用。  
  
1. tlog_open(const char *logfile, int maxlogsize, int maxlogcount, int block, int buffsize, int multiwrite)  

    `功能`: 　初始化一个新的日志流，完成后，使用tlog_cloese关闭。  
    `logfile`: 日志文件。  
    `maxlogsize`: 单个日志文件最大大小。  
    `maxlogcount`: 归档日志个数。  
    `block`: 缓冲区不足时，是否阻塞。  
    `buffsize`: 缓冲区大小。  
    `multiwrite`: 启用多进程写单个日志模式. (注意: 当使用此模式时，所有进程的maxlogsize参数必须一样)  
    `返回值`: 日志流句柄。

1. tlog_close(tlog_log *log)  

    `功能`: 关闭日志流。  
    `log`: 日志流句柄。  

1. tlog_printf(tlog_log *log, const char *format, ...)  

    `功能`: 打印日志到指定日志流  
    `log`: 日志流句柄。  
    `format`: 日志格式。  

1. tlog_vprintf(tlog_log *log, const char *format, va_list ap)  

    `功能`: 打印日志到指定日志流  
    `log`: 日志流句柄。  
    `format`: 日志格式。  
    `ap`: 参数列表。  

1. tlog_logscreen(tlog_log *log, int enable)  

    `功能`: 设置日志流是否输出到屏幕  
    `log`: 日志流句柄。  
    `enable`: 是否启用。  

1. tlog_localtime(struct tlog_time *tm)  

    `功能`: 获取本地时间。  
    `tm`: 本地时间输出。  

## License

MIT License