purecpp - a cool open source modern c++ community

好用的日志库--雅兰亭库easylog

编辑时间：2023-02-03 13:35:32 作者：qicosmos 5条评论

出自：purecpp.cn

转载请注明出处！

雅兰亭库日志库[easylog](https://github.com/alibaba/yalantinglibs/blob/main/src/easylog/tests/test_easylog.cpp)的目标是易用，同时还可以兼容其它日志库，性能也不错。

# 基本用法
先来看看easylog的用法：

```c++
#include "easylog/easylog.h"

void test_log() {
  ELOG(INFO) << "test";
  ELOG_INFO << 42 << " " << 4.5 << 'a' << Severity::DEBUG;
}
```
在控制台输出日志如下：
```c++
2023-02-03 20:21:31.183 INFO     [553648127] [test_easylog.cpp:43] test
2023-02-03 20:21:31.183 INFO     [1] [test_easylog.cpp:44] it is a long string test 2 ok
```
包括到毫秒的时间，还有线程id，文件名、行号和日志内容。注意没有初始化日志文件就只会输出到控制台。

easylog除了支持上面这种流式日志方式外，还支持printf方式：
```c++
ELOGV(INFO, "coro_rpc header data_len: %d, buf sz: %lu", 16, 42);
```

# 写日志文件
如果要写日志文件要怎么做？初始化一下就好了。
```c++
void log_file(){
  easylog::init_log(Severity::DEBUG, "easylog.txt");
  ELOG(INFO) << "test";
  ELOG_INFO << 42 << " " << 4.5 << 'a' << Severity::DEBUG;
}
```
上面的日志将输出到easylog.txt和控制台，如果只想输出到文件，改一下初始化参数即可：
```c++
  easylog::init_log(Severity::DEBUG, "easylog.txt", /*enable_console = */false);
```
上面这个初始化只会向一个文件输出，能不能做到roll 日志文件呢，即：设置日志文件大小，写满之后写到新文件，同时也可以设置总的日志文件数，到达文件数上限时删除最老的文件创建新日志文件。

对于easylog来说也很简单, 改一下初始化即可：
```c++
  easylog::init_log(Severity::DEBUG, "easylog.txt", /*enable_console = */false, /*max_file_size = */5000, /*max_files = */3);
```
这行代码告诉easylog创建最大文件数为3，单文件最大size为5k的日志文件。

# 如何兼容其它日志库
easylog可以方便的兼容其它日志库，以兼容glog为例，创建一个新的日志头文件，在文件中包含easylog，然后覆盖ELOG宏即可:
```c++
#undef ELOG
#define ELOG(...) LOG(__VA_ARGS__)
```
就可以在不修改代码的情况下将原来easylog切换成glog了，也是很简单的一件事。支持其它日志库最重要的是写日志的方式要兼容，比如支持流式和printf方式写日志，剩下的就是一行代码覆盖原来的宏的事了。

# easylog的性能和优势
easylog目前是同步方式写日志的，未来会支持异步方式写日志以提高性能。在目前还没有做专门性能优化之前和glog做了一个初步的性能对比，在下面这种场景下写日志文件：
```c++
  //easylog
  ELOG(INFO) << "hello easy log, it is a long string test "<<42<<" test" <<2.55559;

//glog
  LOG(INFO) << "hello easy log, it is a long string test "<<42<<" test" <<2.55559;
```
easylog的性能是glog的2倍以上。

easylog相比glog来说非常轻量级，既不依赖gflags也不需要编译安装，因为它是header only的，包含头文件即可用，easylog的代码仅仅只有几百行而已，基本功能够用，性能还比glog更好。

# easylog性能优化
easylog为什么性能比glog快一倍以上？主要有几方面的原因：
1. 避免堆内存的分配，利用std::pmr做优化，让日志字符串都在栈上分配；
2. 编译期生成日志字符串文件名和行号，消除了运行期开销；

关于第二个优化方法，我在purecpp2021大会上讲过，有兴趣的可以去看[视频](https://www.bilibili.com/video/BV1GP4y1G7fV/?from=search&seid=1361477758026362877&spm_id_from=333.337.0.0)，2年前的想法在easylog上应用上了，性能提升效果还不错：）

# easylog未来的优化
其实easylog还可以继续优化。

比如，现在easylog是同步写，可以让它支持异步写，异步写可以大幅提升性能，这也是接下来要优化的地方；

另外一个优化的地方是和编译期反射结合起来，让easylog自动输出结构体的所有信息，避免手写，这个目前还没看到有日志库做到这一点，easylog可以比较轻松的支持这种方式；

我相信还有很多可以优化的地方，欢迎对easylog感兴趣的朋友能加入进来帮助一起完善它，一起让easylog帮助我们把写日志变得easy和高效。

欢迎发邮件到purecpp@163.com报名参与雅兰亭库的共建。

预告一下，本周日(2023.02.05)上午十点我会在【腾讯会议：764-577-100】直播，讲讲easylog的实现，敬请关注。

来说两句吧

最新评论

kb 2023-02-06 15:21:21

到底应该叫雅兰亭还是兰亭集？
kb 2023-02-06 15:22:21

时间戳还是utc。。。
qicosmos 2023-02-07 14:35:42

都可以，大家觉得雅兰亭库名字更好听，就叫雅兰亭库了。
kb 2023-02-10 08:51:43

这个多线程是线程安全的吧？
nobody03 2023-03-01 03:37:33

没看到直播，请问有录屏吗

purecpp

一个很酷的modern c++开源社区

[社区开源项目列表，点击前往]

purecpp社区自2015年创办以来，以“Newer is Better”为理念，相信新技术可以改变世界，一直致力于现代C++研究、应用和技术创新，期望通过现代C++的技术创新来提高企业生产力和效率。

社区坚持只发表原创技术文章，已经累计发表了一千多篇原创C++技术文章；

组织了十几场的C++沙龙和C++大会，有力地促进了国内外C++开发者之间的技术交流；

开源了十几个现代C++项目，被近百家公司所使用，有力地推动了现代C++在企业中的应用。

期待更多的C++爱好者能参与到社区C++社区的建设中来，一起为现代C++开源项目添砖加瓦，一起完善C++基础设施和生态圈。

微信公众号:purecpp, 社区邮箱: purecpp@163.com

分类导航

社区精华社区开源项目社区活动元编程代码精粹技术探讨 C++11/14/17/20 社区故事

友情链接