超级好用的C++实用库之日志类

简介: 超级好用的C++实用库之日志类

概述

日志类主要用于在程序运行过程中记录信息、错误、警告以及其他需要跟踪的数据,这对于调试、监控应用状态及后期问题分析至关重要。一个高效且灵活的日志类应该满足以下几个核心需求。

日志级别管理:可定义多个日志级别,比如:DEBUG、INFO、WARN、ERROR、FATAL等,以便根据情况筛选日志的详细程度。同时,还允许运行时动态调整日志输出级别,便于在生产环境中减少不需要的日志输出,或增加更详细的日志输出。

多线程安全:在多线程的环境下,可确保日志写入操作是线程安全的,避免日志内容混乱或程序崩溃。通常情况下,这可以通过互斥锁、原子操作或线程局部存储等机制来实现。

灵活的输出点:支持将日志输出到控制台、本地文件、网络套接字、数据库等多种目的地,并可配置输出目标,允许同时或选择性地输出到多个地方。

自动文件管理:可自动创建和管理日志文件,并按时间、大小滚动日志文件。同时,文件名应包含日期等信息,便于归档和查询。

日志格式化:支持格式化字符串,允许在日志中内嵌变量、时间戳、进程ID、线程ID等信息。另外,支持自定义日志格式,以满足不同场景下的需求。

高性能与低延迟:采用缓冲机制减少I/O操作次数,提高日志写入效率。支持异步写入日志,避免阻塞主线程,减少对应用性能的影响。

可以看到,封装一个高效且灵活的日志类,需要考虑的东西非常多。目前有很多第三方开源日志库,比如:glog、spdlog或EasyLogger等,但这些库用起来相对比较复杂,特别是在底层模块中使用,耦合比较严重。为了简化底层模块中日志类的使用,我们封装了下面的CHP_Logger类。

CHP_Logger类

CHP_Logger是一个简单、易于集成和使用的日志类,可在各个底层库中使用。应用层可使用glog、spdlog或EasyLogger等第三方日志库,并配合该日志类记录底层库日志。CHP_Logger类的头文件,可参考下面的示例代码。

#pragma once

#include <stdarg.h>

#include "HP_Types.h"
#include "HP_Mutex.h"

enum IHPLoggerLevel
{
        HPLoggerLevel_None,
        HPLoggerLevel_Error, 
        HPLoggerLevel_Warn,
        HPLoggerLevel_Info, 
        HPLoggerLevel_Debug, 
        HPLoggerLevel_Trace, 
        HPLoggerLevel_Count
};

typedef void(*CALLBACK_LOGGER_OUTPUT)(IHPLoggerLevel level, const char *pszLog, void *pContext);

class CHP_Logger
{
public:
        static void Open();
        static CHP_Logger *&Singleton();
        static void Close();

        void SetLevel(IHPLoggerLevel level);

        bool IsLogEnabled(IHPLoggerLevel level);

        void SetLogOutputListener(CALLBACK_LOGGER_OUTPUT pCbOutput, void *pContext);

        void SetMaxLogLen(unsigned int uiLen);

        void Error(const char *pszFormat, ...);

        void Warn(const char *pszFormat, ...);

        void Info(const char *pszFormat, ...);
        
        void Debug(const char *pszFormat, ...);
        
        void Trace(const char *pszFormat, ...);

        static void Error(CHP_Logger *pLogger, const char *pszFormat, ...);

        static void Warn(CHP_Logger *pLogger, const char *pszFormat, ...);
        
        static void Info(CHP_Logger *pLogger, const char *pszFormat, ...);
        
        static void Debug(CHP_Logger *pLogger, const char *pszFormat, ...);
        
        static void Trace(CHP_Logger *pLogger, const char *pszFormat, ...);

protected:
        CHP_Logger();
        ~CHP_Logger();

private:
        void Log(const char *pszFormat, va_list &argList, IHPLoggerLevel level);

private:
        static CHP_Logger *m_pThis;
        IHPLoggerLevel m_level;
        CALLBACK_LOGGER_OUTPUT m_pCbOutput;
        void *m_pContext;
        char *m_pszLog;
        unsigned int m_uiMaxLogLen;
        CHP_Mutex m_mutexLog;
};

在上面的示例代码中,我们声明了一个枚举类型IHPLoggerLevel,用于指定日志输出级别。CHP_Logger类是一个接口类,不需要实例化。因此,我们将构造函数和析构函数声明成了私有的。下面,我们将分别介绍其导出的公共实例接口。

SetLevel:设置日志输出级别。参数level为日志输出级别,用于控制日志输出的详细程度。

IsLogEnabled:用于判断指定级别的日志是否使能。参数level为指定的日志级别,返回值为true表示该级别的日志使能,否则不使能。

SetLogOutputListener:设置日志输出监听器。参数pCbOutput为日志输出的回调函数,参数pContext为回调函数上下文。应用层需要设置日志输出监听器,以对回调函数中的日志进行自定义操作,比如:写本地文件、输出到控制台、传输到网络等。

SetMaxLogLen:设置单条日志的最大长度。参数uiLen为单条日志的最大长度,单位为字节,传0时,默认为16KB。

Error:输出错误日志。pszFormat为日志格式字符串,支持可变参数。

Warn:输出警告日志。pszFormat为日志格式字符串,支持可变参数。

Info:输出信息日志。pszFormat为日志格式字符串,支持可变参数。

Debug:输出调试日志。pszFormat为日志格式字符串,支持可变参数。

Trace:输出详尽日志。pszFormat为日志格式字符串,支持可变参数。

除了上面的实例接口外,我们还导出了5个同名的静态接口,分别为:Error、Warn、Info、Debug、Trace。这几个静态接口一般用于底层动态链接库中输出日志,这样底层和应用层可以共用一个日志单实例对象。


总结

日志类是编程中用于生成、管理、保存应用程序运行时信息的核心组件,对于故障排查、系统监控、性能分析、合规审计至关重要。日志类更是开发、运维团队的重要工具,能帮助我们快速定位问题,优化系统性能,保障系统稳定运行。


相关文章
|
12天前
|
弹性计算 人工智能 架构师
阿里云携手Altair共拓云上工业仿真新机遇
2024年9月12日,「2024 Altair 技术大会杭州站」成功召开,阿里云弹性计算产品运营与生态负责人何川,与Altair中国技术总监赵阳在会上联合发布了最新的“云上CAE一体机”。
阿里云携手Altair共拓云上工业仿真新机遇
|
8天前
|
机器学习/深度学习 算法 大数据
【BetterBench博士】2024 “华为杯”第二十一届中国研究生数学建模竞赛 选题分析
2024“华为杯”数学建模竞赛,对ABCDEF每个题进行详细的分析,涵盖风电场功率优化、WLAN网络吞吐量、磁性元件损耗建模、地理环境问题、高速公路应急车道启用和X射线脉冲星建模等多领域问题,解析了问题类型、专业和技能的需要。
2522 18
【BetterBench博士】2024 “华为杯”第二十一届中国研究生数学建模竞赛 选题分析
|
8天前
|
机器学习/深度学习 算法 数据可视化
【BetterBench博士】2024年中国研究生数学建模竞赛 C题:数据驱动下磁性元件的磁芯损耗建模 问题分析、数学模型、python 代码
2024年中国研究生数学建模竞赛C题聚焦磁性元件磁芯损耗建模。题目背景介绍了电能变换技术的发展与应用,强调磁性元件在功率变换器中的重要性。磁芯损耗受多种因素影响,现有模型难以精确预测。题目要求通过数据分析建立高精度磁芯损耗模型。具体任务包括励磁波形分类、修正斯坦麦茨方程、分析影响因素、构建预测模型及优化设计条件。涉及数据预处理、特征提取、机器学习及优化算法等技术。适合电气、材料、计算机等多个专业学生参与。
1525 15
【BetterBench博士】2024年中国研究生数学建模竞赛 C题:数据驱动下磁性元件的磁芯损耗建模 问题分析、数学模型、python 代码
|
4天前
|
存储 关系型数据库 分布式数据库
GraphRAG:基于PolarDB+通义千问+LangChain的知识图谱+大模型最佳实践
本文介绍了如何使用PolarDB、通义千问和LangChain搭建GraphRAG系统,结合知识图谱和向量检索提升问答质量。通过实例展示了单独使用向量检索和图检索的局限性,并通过图+向量联合搜索增强了问答准确性。PolarDB支持AGE图引擎和pgvector插件,实现图数据和向量数据的统一存储与检索,提升了RAG系统的性能和效果。
|
10天前
|
编解码 JSON 自然语言处理
通义千问重磅开源Qwen2.5,性能超越Llama
击败Meta,阿里Qwen2.5再登全球开源大模型王座
596 14
|
1月前
|
运维 Cloud Native Devops
一线实战:运维人少,我们从 0 到 1 实践 DevOps 和云原生
上海经证科技有限公司为有效推进软件项目管理和开发工作,选择了阿里云云效作为 DevOps 解决方案。通过云效,实现了从 0 开始,到现在近百个微服务、数百条流水线与应用交付的全面覆盖,有效支撑了敏捷开发流程。
19283 30
|
10天前
|
人工智能 自动驾驶 机器人
吴泳铭:AI最大的想象力不在手机屏幕,而是改变物理世界
过去22个月,AI发展速度超过任何历史时期,但我们依然还处于AGI变革的早期。生成式AI最大的想象力,绝不是在手机屏幕上做一两个新的超级app,而是接管数字世界,改变物理世界。
498 49
吴泳铭:AI最大的想象力不在手机屏幕,而是改变物理世界
|
1月前
|
人工智能 自然语言处理 搜索推荐
阿里云Elasticsearch AI搜索实践
本文介绍了阿里云 Elasticsearch 在AI 搜索方面的技术实践与探索。
18842 20
|
1月前
|
Rust Apache 对象存储
Apache Paimon V0.9最新进展
Apache Paimon V0.9 版本即将发布,此版本带来了多项新特性并解决了关键挑战。Paimon自2022年从Flink社区诞生以来迅速成长,已成为Apache顶级项目,并广泛应用于阿里集团内外的多家企业。
17530 13
Apache Paimon V0.9最新进展
|
3天前
|
云安全 存储 运维
叮咚!您有一份六大必做安全操作清单,请查收
云安全态势管理(CSPM)开启免费试用
368 4
叮咚!您有一份六大必做安全操作清单,请查收