# neng-log

**Repository Path**: robot-zhou/neng-log

## Basic Information

- **Project Name**: neng-log
- **Description**: Neng-Log是一个通用的C语言日志库，可以将应用程序的日志是输出到文件、系统日志。

特色功能：

模块级的日志级别控制
支持模块(mod)级别的日志级别设置，不同的模块设置不同的日志级别；

日志输出支持标签(tag)
tag表示日志的用途，作为日志过滤的一个条件，不同模块可以输出同一tag的日志，便于输出到同一个目的地（文件/系统日志）

支持日志过滤输出

支持设定不同的模块(mod),
- **Primary Language**: C
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-06-29
- **Last Updated**: 2025-02-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: log, Linux

## README

# Neng-Log

## 概述

Neng-Log是一个通用的C语言日志库，可以将应用程序的日志是输出到文件、系统日志。

特色功能：

1. 模块级的日志级别控制

支持模块(mod)级别的日志级别设置，不同的模块设置不同的日志级别；

2. 日志输出支持标签(tag)

tag表示日志的用途，作为日志过滤的一个条件，不同模块可以输出同一tag的日志，便于输出到同一个目的地（文件/系统日志）

3. 支持日志过滤输出
    - 支持设定不同的模块(mod), 标签(tag), 级别(level) 日志输出到不同的文件；
    - 支持设定不同的模块(mod), 标签(tag), 级别(level) 日志使用不同的facility输出到系统日志。

5. 支持异步日志输出

6. 框架支持定制appender；自带文件(file),系统日志(syslog)两个appender。

## 编译

```
# 配置cmake；DCMAKE_BUILD_TYPE后选值：Debug, Release, RelWithDebInfo, MinSizeRel
cmake  -DCMAKE_BUILD_TYPE=Debug . -B ./build/
# 编译, VERBOSE=1, 显示编译命令
cmake --build ./build -- -j4 VERBOSE=0
```

## 安装

1. 头文件目录: ./include/

2. 库文件目录: ./objs/lib/

## 接口说明

请看头文件./include/tang-log/log.h的注释

## 使用

使用方式有两种：
1. 配置文件
2. 代码初始化

### 方式一：配置文件
1. 加载配置文件；配置文件的定义请看配置文件示例：neng-log.properties

推荐此种方式，使用简单；仅仅调用函数加载配置文件即可。

示例：./test/example-properties

```c
#include <stdio.h>
#include <errno.h>
#include <string.h>

#include <neng/log/log.h>
#include <neng/log/log_properties.h>

int main(int argc, char *argv[])
{
    const char *def_conf = "neng-log.properties";
    const char *conf_file = (argc > 1) ? argv[1] : def_conf;

    // 加载日志配置文件
    NengLogSetProgName(argv[0]);
    if (0 != NengLogLoadProperties(conf_file))
    {
        printf("Error: read properties config file %s failed: %s.\n", conf_file, strerror(errno));
        return -1;
    }

    printf("Hello, this is neng-log test program for read properties config file.\n");

    // 输出日志
    NENG_LOGMT_NOTICE(10, 20, "this is mod-10 tag-20 notice log.");
    NENG_LOGMT_ERROR(10, 25, "this is mod-10 tag-25 error log.");
    NENG_LOG_INFO("this is test info log");
    NENG_LOG_ERROR("this is test error log");
    NENG_LOG_DEBUG("this is test debug log");
    NENG_LOGMT_NOTICE(20, 30, "this is mod-20 tag-30 notice log.");
    NENG_LOGMT_ERROR(20, 35, "this is mod-20 tag-35 error log.");

    return 0;
}
```

### 方式二：调用初始化函数

请看示例./test/example/main.c文件；
日志输出示例：

```log
root@dev2210:/var/log# cat test-1.log
2023-06-27 14:03:30.562 dev2210 test 29826 Notice tid:29826 mod:10 tag:10 <main.c@main:78> :this is mod-20 tag-10 notice log.
root@dev2210:/var/log# cat test-2.log
2023-06-27 14:03:30.562 dev2210 test 29826 Notice tid:29826 mod:10 tag:10 <main.c@main:78> :this is mod-20 tag-10 notice log.
2023-06-27 14:03:30.562 dev2210 test 29826 Info   tid:29826 mod:0 tag:0 <main.c@main:79> :this is test info log
2023-06-27 14:03:30.562 dev2210 test 29826 Error  tid:29826 mod:0 tag:0 <main.c@main:80> :this is test error log
```

## 修改历史

2023/06/27 v1.0 版本发布；

2023/07/13 v1.2 版本发布，新增配置文件支持；

## 附录