# hlog

**Repository Path**: mphyatyh/hlog

## Basic Information

- **Project Name**: hlog
- **Description**: 这是一个高性能日志模块，用C语言编写
- **Primary Language**: C
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-07
- **Last Updated**: 2024-01-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# hlog

## 介绍
这是一个高性能的日志库，特征如下：
### 多线程日志聚合写盘，提升吞吐量
 - 聚合写。日志线程logger与业务线程分离，日志线程负责写盘，业务线程不直接写盘。多个线程线程的日志信息，聚合到logger线程，有logger线程统一写盘，可以充分利用SSD和HDD的顺序写性能高的特点；

### 共享内存暂存日志，进程崩溃日志不丢失，且性能高
 - 按照日志的优先级不同，可以选择三种不同模式：遗言模式、共享内存模式、立即写盘模式
 - 遗言模式：对于一些优先级比较低的日志，如INFO或者NOTICE，只保存进程崩溃之前的最后32条日志；
 - 共享内存模式：优先级稍高的，可保存在共享内存中，应用进程崩溃之后，共享内存中日志不丢失，下次进程重启后，日志信息重新输出到日志文件中；性能高，但缺点是：当OS崩溃 重启、或者掉电之后，共享内存中信息将会丢失；
 - 立即写盘模式：可以选择日志下盘成功再返回继续执行，性能低，但是可以确保系统掉电日志不丢失；

### 每线程队列，避免竞争，降低时延
 - 每个业务线程都有自己的日志队列，环形缓冲区实现，业务线程和日志线程可以并发访问环形缓冲区，不需要加锁；
 - 日志输出的时候需要按照时间顺序输出，按顺序轮询并多队列并输出日志，会打算日志本身时间顺序；如果在多个队列之间线性查找当前最旧的日志entry，那么每输出一条日志，就需要轮询所有队列，效率太低。为避免这个问题，在多队列之间使用败者树算法，降低轮询开销；

### 轮询和等待模式自动切换
- 当最近1秒中内日志数量特别多的时候，logger线程采用轮询方式检查队列中是否有日志entry待输出；
- 如果最近一秒日志数量不多，那么就转入等待模式，等待条件变量，避免轮询导致的CPU开销；


#### 软件架构
软件架构说明


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)