文章目录
学习目的：
①锻炼一下 学习一个新的工具(log4cpp) 的能力
②综合前三章学习的内容
③搜索引擎项目需要用到
四、日志系统
日志系统在整个系统架构中的重要性可以称得上基础的基础，但是这一点，都容易被大多数人所忽视。因为日志在很多人看来只是printf，在系统运行期间，很难一步一步地调试，只能根据系统的运行轨迹来推断错误出现的位置，而日志往往也是最重要的参考资料。
日志系统主要解决的问题就是记录系统的运行轨迹，在这个基础上，进行跟踪分析错误，审计系统运行流程。一般在高可靠的系统中，是不允许系统运行终止的，所以也会产生海量的日志。
日志系统的内容可以分为两类：
1.业务级别的日志，主要供终端用户来分析他们业务过程；
2.系统级别的日志，供开发者维护系统的稳定。
由于日志系统的数据输出量比较大，所以不能不考虑对整个系统性能的影响。从另外一方面来看，海量的日志内容有时候并不件好事，因为，很容易覆盖真实问题的蛛丝马迹，也增加日志阅读者信息检索的困难。所以日志系统的设计需要挑选一个合适的工具，并进行合理的设计。
1.日志系统的设计
日志系统的设计，一般而言要抓住最核心的一条，就是日志从产生到到达最终目的地期间的处理流程。一般而言，为了设计一个灵活可扩展，可配置的日志库，主要将日志库分为4个部分去设计，分别是：记录器、过滤器、格式化器、输出器四部分。
记录器（日志来源）：负责产生日志记录的原始信息，比如（原始信息，日志优先级，时间，记录的位置）等等信息。
过滤器（日志系统优先级）：负责按指定的过滤条件过滤掉我们不需要的日志。
格式化器（日志布局）：负责对原始日志信息按照我们想要的格式去格式化。
输出器（日志目的地）：负责将将要进行记录的日志（一般经过过滤器及格式化器的处理后）记录到日志目的地（例如：输出到文件中）。
2.log4cpp的安装
1.下载压缩包
下载地址：https://sourceforge.net/projects/log4cpp/files/
2.安装步骤
$ tar xzvf log4cpp-1.1.4rc3.tar.gz
$ cd log4cpp
$ ./configure //进行自动化构建，自动生成makefile
$ make
$ sudo make install //安装 把头文件和库文件拷贝到系统路径下
//安装完后
//默认头文件路径：/usr/local/include/log4cpp
//默认lib库路径：/usr/local/lib
3.打开log4cpp官网：Log for C++ Project (sourceforge.net)
拷贝simple example的内容，编译运行
编译指令：g++ log4cppTest.cc -llog4cpp -lpthread
3.log4cpp的核心组件
(1)日志目的地 (输出器 Appender)
Appender代表输出器，代表日志的目的地
我们关注这三个目的地类，点开后查看它们的构造函数：
①OstreamAppender C++通用输出流(如 cout)
②FileAppender 写到本地文件中
③RollingFileAppender 写到回卷文件中
①OstreamAppender
- OstreamAppender的构造函数传入两个参数：目的地名（随便写）、输出流指针
②FileAppender
FileAppender的参数：第三个参数是模式(如追加模式)，第四个参数是权限
FileAppender的构造函数传入两个参数：目的地名、保存日志的文件名（后面两个参数使用默认值即可，分别表示以结尾附加的方式的保存日志，当前用户读写-其他用户只读）
③RollingFileAppender
RollingFileAppender：
RollingFileAppender稍复杂一些，如果没有回卷文件，将所有的日志信息都保存在一个文件中，那么随着系统的运行，产生越来越多的日志，本地日志文件会越变越大，若不加限制，则会大量占用存储空间。所以通常的做法是使用回卷文件，比如只给日志文件1G的空间，对于这1G的空间可以再次进行划分，比如使用10个文件存储日志信息，每一个文件最多100M.
RollingFileAppender构造函数的参数如上图，其中要注意的是回卷文件个数，如果这一位传入的参数是9，那么实际上会有10个文件保存日志。
回卷的机制是：先生成一个wd.log文件，该文件存满后接着写入日志，那么wd.log文件改名为wd.log.1，然后再创建一个wd.log文件，将日志内容写入其中，wd.log文件存满后接着写入日志，wd.log.1文件改名为wd.log.2，wd.log改名为wd.log.1，再创建一个wd.log文件，将最新的日志内容写入。以此类推，直到wd.log和wd.log.1、wd.log.2、… wd.log.9全都存满后再写入日志，wd.log.9（其中实际上保存着最早的日志内容）会被舍弃，编号在前的回卷文件一一进行改名，再创建新的wd.log文件保存最新的日志信息。
(2)日志布局 (Layout)
注意（极易出错）：
当日志系统有多个日志目的地时，每一个目的地Appender都需要设置一个布局Layout（一对一关系）
①BasicLayout：时间戳
②PatternLayout：自定义布局
(3)日志记录器 (Category) (最核心)
1.记录器Category是树状结构。
2.创建Category对象时，可以用getRoot先创建root模块对象，对root模块对象设置优先级和目的地；
3.再用getInstance创建叶模块对象，叶模块对象会继承root模块对象的优先级和目的地，可以再去修改优先级、目的地
4.补充：如果没有创建根对象，直接使用getInstance创建叶对象，会先隐式地创建一个Root对象。
5.子Category可以继承父Category的信息：优先级、目的地
6.绑定Appender时，一个Category只能绑定一个Appender，只能绑定一个PatternLayout， (否则会段错误)，不同级别可以继承。
root绑定到终端。
sub1继承了root的输出地和优先级，并且再绑定到输出到文件。
若不想让sub1继承，则可以写一行
sub1.setAdditivity(false); //sub1不继承root的目的地
// main.cpp
#include "log4cpp/Category.hh"
#include "log4cpp/Appender.hh"
#include "log4cpp/FileAppender.hh"
#include "log4cpp/OstreamAppender.hh"
#include "log4cpp/Layout.hh"
#include "log4cpp/BasicLayout.hh"
#include "log4cpp/Priority.hh"
using namespace log4cpp;
int main(int argc, char* argv[]) {
//1.Appender代表输出器 (决定日志的目的地)
//ostreamAppender构造函数的第一个参数代表目的地名字
//第二个参数是一个ostream *,决定了目的地。这里传入&cout表示输出到终端
Appender *appender1 = new OstreamAppender("console", &std::cout);
//目的地与日志格式 进行了绑定
appender1->setLayout(new BasicLayout());
//2.FileAppender构造函数的第一个参数代表目的地名字
//第二个参数是要将日志保存到文件的文件名字
Appender *appender2 = new FileAppender("default", "program.log");
appender2->setLayout(new BasicLayout());
//3.getRoot创建出root级别的Category对象 ()记录器对象
Category& root = Category::getRoot();
//root设置优先级为WARN级别 (日志系统的优先级,即门槛)
root.setPriority(Priority::WARN); //设置日志优先级
//root设置目的地 —— 输出到终端
root.addAppender(appender1);
//getInstance创建了一个名为sub1的叶子级别的Category对象
//sub1继承了root的优先级和目的地
Category& sub1 = Category::getInstance(std::string("sub1"));
//在输出到终端的基础上, 还会将日志信息保存到文件 (添加了一个目的地)
sub1.addAppender(appender2);
//sub1.setAdditivity(false); //sub1不继承root的目的地
// use of functions for logging messages
root.error("root error"); //error函数决定了这条日志信息的优先级为EROR
root.info("root info"); //pass
sub1.error("sub1 error"); //输出到终端并保存文件
sub1.warn("sub1 warn"); //输出到终端并保存文件
// printf-style for logging variables
root.warn("%d + %d == %s ?", 1, 1, "two"); //终端
// use of streams for logging messages
root << Priority::ERROR << "Streamed root error"; //终端
root << Priority::INFO << "Streamed root info"; //pass
sub1 << Priority::ERROR << "Streamed sub1 error"; //终端+文件
sub1 << Priority::WARN << "Streamed sub1 warn"; //终端+文件
// or this way:
root.errorStream() << "Another streamed error"; //终端
return 0;
}
网址：https://github.com/WangEdward1027/log4cpp
(4)日志优先级 (Priority)
设置一个记录器的门槛优先级。
若日志的级别低于记录器的优先级，则被过滤。高于等于，则被记录。
4.定制日志系统：PatternLayout
//1.设置布局
PatternLayout * ptn1 = new PatternLayout();
ptn1->setConversionPattern("%d %c [%p] %m%n");
%d是date 日期时间
%c是category对象
%p是priority优先级
%m是message信息
%n是换行符\n
5.log4cpp的单例实现
用所学过的类和对象的知识，封装log4cpp，让其使用起来更方便，要求：可以像printf一样，同时输出的日志信息中最好能有文件的名字，函数的名字及其所在的行号(这个在C/C++里面有对应的宏，可以查一下) __FILE__、__FUNCTION__、__LINE__
代码模板：
class Mylogger
{
public:
void warn(const char *msg);
void error(const char *msg);
void debug(const char *msg);
void info(const char *msg);
private:
Mylogger();
~Mylogger();
private:
//......
};
void test0()
{
//第一步，完成单例模式的写法
Mylogger *log = Mylogger::getInstance();
log->info("The log is info message");
log->error("The log is error message");
log->fatal("The log is fatal message");
log->crit("The log is crit message");
}
void test1()
{
printf("hello,world\n");
//第二步，像使用printf一样
//只要求能输出纯字符串信息即可，不需要做到格式化输出
LogInfo("The log is info message");
LogError("The log is error message");
LogWarn("The log is warn message");
LogDebug("The log is debug message");
}
我的实现：
私有数据成员只有Category。
因为记录器负责：绑定输出器、绑定布局、输出日志
#include "log4cpp/Appender.hh"
#include "log4cpp/Category.hh"
#include "log4cpp/FileAppender.hh"
#include "log4cpp/OstreamAppender.hh"
#include "log4cpp/BasicLayout.hh"
#include "log4cpp/PatternLayout.hh"
#include "log4cpp/RollingFileAppender.hh"
#include "log4cpp/Priority.hh"
#include <iostream>
#include <fstream>
#include <string>
#include <sstream>
using namespace log4cpp;
using std::cin;
using std::cout;
using std::endl;
using std::string;
using std::ofstream;
using std::ostringstream;
class Mylogger
{
public:
static Mylogger * getInstance(){
if(_pInstance == nullptr){
_pInstance = new Mylogger();
}
return _pInstance;
}
static void destroy(){
if(_pInstance){
delete _pInstance;
_pInstance = nullptr;
}
}
void crit(const char* msg){
_cate->crit(msg);
}
void fatal(const char* msg){
_cate->fatal(msg);
}
void warn(const char* msg){
_cate->warn(msg);
}
void error(const char* msg){
_cate->error(msg);
}
void debug(const char* msg){
_cate->debug(msg);
}
void info(const char* msg){
_cate->info(msg);
}
private:
Mylogger(){
//每个布局只能被绑定一次,一对一
PatternLayout * ptn1 = new PatternLayout();
ptn1->setConversionPattern("%d %c [%p] %m%n");
PatternLayout * ptn2 = new PatternLayout();
ptn2->setConversionPattern("%d %c [%p] %m%n");
//1.日志输出器
//输出到屏幕终端
Appender* appender1 = new OstreamAppender("console", &cout);
appender1->setLayout(ptn1);
//输出到文件
/* Appender* appender2 = new FileAppender("log", "program.log"); */
/* appender2->setLayout(ptn2); */
//输出到回滚文件
RollingFileAppender * rolling = new RollingFileAppender("rollingFile",
"rollingfile.log", 5*128, 9);
//2.日志记录器
_cate = &Category::getInstance(string("sub1")); //创建叶对象
_cate->setPriority(Priority::DEBUG); //设置日志优先级
_cate->addAppender(appender1);
_cate->addAppender(rolling);
}
~Mylogger(){
Category::shutdown();
}
Mylogger(const Mylogger & rhs) = delete;
Mylogger & operator=(const Mylogger & rhs) = delete;
private:
Category * _cate;
static Mylogger * _pInstance;
};
Mylogger * Mylogger::_pInstance = nullptr;
void test0()
{
//第一步，完成单例模式的写法
Mylogger *log = Mylogger::getInstance();
log->info("The log is info message");
log->error("The log is error message");
log->fatal("The log is fatal message");
log->crit("The log is crit message");
//规范使用单例模式的写法
Mylogger::getInstance()->info("The log is info message");
}
void LogInfo(const char * msg){
ostringstream oss;
oss << __FILE__ << " " << __FUNCTION__ << " " << __LINE__<< " " << msg;
string res = oss.str();
Mylogger::getInstance()->info(res.c_str());
/* char buffer[1024]; */
/* sprintf(buffer, "%s %s %d %s" ,__FILE__, __FUNCTION__, __LINE__, msg); */
// Mylogger::getInstance()->error(msg);
/* Mylogger::getInstance()->info(buffer); */
}
void LogError(const char * msg){
ostringstream oss;
oss << __FILE__ << " " << __FUNCTION__ << " " << __LINE__<< " " << msg;
string res = oss.str();
Mylogger::getInstance()->info(res.c_str());
}
void LogWarn(const char * msg){
ostringstream oss;
oss << __FILE__ << " " << __FUNCTION__ << " " << __LINE__<< " " << msg;
string res = oss.str();
Mylogger::getInstance()->info(res.c_str());
}
void LogDebug(const char * msg){
ostringstream oss;
oss << __FILE__ << " " << __FUNCTION__ << " " << __LINE__<< " " << msg;
string res = oss.str();
Mylogger::getInstance()->info(res.c_str());
}
void test1()
{
printf("hello,world\n");
//第二步，像使用printf一样
//只要求能输出纯字符串信息即可，不需要做到格式化输出
LogInfo("The log is info message");
LogError("The log is error message");
LogWarn("The log is warn message");
LogDebug("The log is debug message");
}
//第三步:最终希望的效果
//LogDebug("The log is debug message");
//日期 记录器名字 [优先级] 文件名 函数名 行号 日志信息
int main()
{
/* test0(); */
int count = 50;
while(count--){
test1();
}
return 0;
}
6.log4cpp配置文件读取
代码链接：https://github.com/WangEdward1027/log4cpp
①readConfig.cpp：读配置文件
②log4cpp.properties：配置文件
扫一扫
960
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
