架构设计 - 日志管理接口设计

在后端代码中,日志无处不在,设计一套自己的日志管理代码,给框架提供一套好用的日志接口将大大方便代码的开发。

其中在日志管理代码的编写中,主要有以下难点:

1.数目不确定的入参函数编写

2.日志权限控制

3.日志输出形式。

接口设计:

1.提供三类日志打印形式:1)控制台打印信息,类似printf的接口封装

            2)函数追踪接口,打印当前代码的文件名,函数名及行,以及一些设定的输出参数

            3)日志打印函数,提供打印级别控制,且打印内容输出到日志文件中

2.提供日志级别控制:1)在打印日志时提供当前日志级别,代码依据级别进行控制打印

          2)日志打印级别控制暂时使用配置文件,后续可以通过通信接口进行实时修改

下面附上代码实现:DMLogManager.h

 1 //=============================================================================
 2 /* 
 3 *  File: DMLogManager.h
 4 *
 5 *  Author: bing
 6 *
 7 *  Date: 2016-09-07
 8 *
 9 *  Version: v2.0
10 *
11 *  Github/Mail: https://github.com/binchen-china    <563853086@qq.com>
12 *
13 *  Note:
14 */
15 //=============================================================================
16 
17 #pragma once
18 #include "DMaker.h"
19 
20 enum LOG_LEVEL
21 {
22     DM_ERROR = 0x0001,
23     DM_WARNING  = 0x0010,
24     DM_INFO = 0x0100,
25     DM_DEBUG = 0x1000
26 };
27 
28 class DMLogManager
29 {
30 public:
31     DMLogManager();
32     
33     ~DMLogManager();
34 
35     void print_log(const DM_CHAR* fmt, ...);
36    
37     void trace_log(string file, string func, DM_INT line, const DM_CHAR* fmt, ...);
38           
39     void write_log(DM_INT log_level, string file, string func, DM_INT line, const DM_CHAR* fmt, ...);
40     
41 private:
42     void init();
43 
44     void get_log_config();
45     
46     inline void open_log_file();
47     
48     inline void close_log_file();
49     
50     void set_log_level();
51 
52 private:
53     FILE* _log_file;
54     string _log_name;
55     string _log_level;
56     DM_INT _log_mask;
57 };
58 
59 typedef ACE_Singleton<DMLogManager, ACE_Thread_Mutex> DMLogMgr;
60 
61 //console output without code info
62 #define DM_PRINT(LOG_FMT,args...) DMLogMgr::instance()->print_log(LOG_FMT,##args)
63 //console output with code info
64 #define DM_TRACE(LOG_FMT,args...) DMLogMgr::instance()->trace_log(__FILE__,__FUNCTION__,__LINE__,LOG_FMT,##args)
65 //write logs into log file
66 #define DM_LOG(LOG_LEVEL,LOG_FMT,args...) DMLogMgr::instance()->write_log(LOG_LEVEL,__FILE__,__FUNCTION__,__LINE__,LOG_FMT,##args)

DMLogManager.cpp

#include "DMLogManager.h"

DMLogManager::DMLogManager():_log_mask(0)
{
    init();
}

DMLogManager::~DMLogManager()
{
    
}

void DMLogManager::init()
{
    get_log_config(); 
    set_log_level();
}

void DMLogManager::get_log_config()
{
    _log_name = DMJsonCfg::instance()->GetItemString("service_info", "service_name");
    _log_level = DMJsonCfg::instance()->GetItemString("service_info", "log_level");
    _log_name.append(".log");
}

inline  void DMLogManager::open_log_file()
{
    _log_file = fopen(_log_name.c_str(), "a");
    if (nullptr == _log_file)
    {    
        return;
    }    
}

inline  void DMLogManager::close_log_file()
{
    fclose(_log_file);
}

void DMLogManager::set_log_level()
{
    if ("DEBUG" == _log_level)
    {
        _log_mask = 0x1111;
    }
    else if ("INFO" == _log_level)
    {
        _log_mask = 0x0111;
    }
    else if ("WARNING" == _log_level)
    {
        _log_mask = 0x0011;
    }
    else if ("ERROR" == _log_level)
    {
        _log_mask = 0x0001;
    }
}

void DMLogManager::print_log(const DM_CHAR* fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
               
    string log_info = fmt;     
    ACE_OS::vfprintf(stdout, fmt, ap);  

    va_end (ap);
}

void DMLogManager::trace_log(string file, string func, DM_INT line, const DM_CHAR* fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
               
    ACE_OS::printf("[DM_TRACE][%s][%s][%d]:",file.c_str(), func.c_str(), line);               
    string log_info = fmt;     
    ACE_OS::vfprintf(stdout, fmt, ap);  

    va_end (ap);
}

void DMLogManager::write_log(DM_INT log_level, string file, string func, DM_INT line, const DM_CHAR* fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
    
    open_log_file();
    
    switch (log_level)
    {
        case DM_DEBUG:
        {
            if (DM_DEBUG & _log_mask)
            {               
                ACE_OS::fprintf(_log_file, "[DM_DEBUG][%s][%s][%d]:",file.c_str(), func.c_str(), line);                 
                ACE_OS::vfprintf(_log_file, fmt, ap);  
            }            
            break;
        }
        case DM_INFO:
        {
            if (DM_INFO & _log_mask)
            {
                ACE_OS::fprintf(_log_file, "[DM_INFO][%s][%s][%d]:",file.c_str(), func.c_str(), line);                  
                ACE_OS::vfprintf(_log_file, fmt, ap);  
            }
            break;
        }
        case DM_WARNING:
        {
            if (DM_WARNING & _log_mask)
            {
                ACE_OS::fprintf(_log_file, "[DM_WARNING][%s][%s][%d]:",file.c_str(), func.c_str(), line);                 
                ACE_OS::vfprintf(_log_file, fmt, ap);  
            }
            break;
        }
        case DM_ERROR:
        {
            if (DM_ERROR & _log_mask)
            {
                ACE_OS::fprintf(_log_file, "[DM_ERROR][%s][%s][%d]:",file.c_str(), func.c_str(), line);                 
                ACE_OS::vfprintf(_log_file, fmt, ap);       
            }
            break;
        }
    }
    
    close_log_file();
    va_end (ap);
}

更多技术信息请关注github:https://github.com/binchen-china

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏白驹过隙

架构设计 - 日志管理接口设计

3378
来自专栏杨建荣的学习笔记

dg broker配置的问题及分析 (r7笔记第22天)

今天在配置一个备库的时候碰到了一些问题,话说配置dg broker真没什么特别需要注意的细节了,本身已经给DBA省了很大的事儿了。 但是有时候就是会出现一些稀奇...

3514
来自专栏杨建荣的学习笔记

由sqlplus中的一个小细节所做的折腾(r5笔记第11天)

sqlplus是Oracle DBA每天都要用到烂的工具了。如果没有sqlplus还真不知道怎么和oracle对话了。转念一想,自己已经很久没使用过toad了。...

3546
来自专栏乐沙弥的世界

使用 resource_limit 及 profile 限制用户连接

      数据库性能是一个永恒的话题,那就是如何使用更少的资源以达到更高效的性能。Oracle系统参数RESOURCE_LIMIT是一个用于控制用户对于数据库...

941
来自专栏杨建荣的学习笔记

记一次dg故障的处理总结(r6笔记第63天)

今天早上收到一条报警短信,提示是dg的接收出了问题,从v$dataguard_status得到的最新记录如下: 2015-09-18 07:13:36.0 Fe...

2535
来自专栏乐沙弥的世界

Possible MySQL server UUID duplication for server

    在mysql enterprise monitor监控过程中出现这样的event事件,Topic: Possible MySQL server UUID...

582
来自专栏杨建荣的学习笔记

11g主库归档自动删除的小问题分析 (r8笔记第1天)

最近在无疑中查看一个数据库的日志的时候,发现里面有这么一段内容。 Sat Feb 06 10:07:25 2016 Deleted Oracle manag...

33611
来自专栏Hadoop实操

Hive Load本地数据文件异常分析

使用beeline登录HiveServer2向my_table表Load本地数据文件时报如下异常:

3834
来自专栏Java进阶架构师

手把手带你秒杀架构实践(含完整代码)

之前在 Java-Interview 中提到过秒杀架构的设计,这次基于其中的理论简单实现了一下。

1081
来自专栏Albert陈凯

2018-11-19 如何将大规模数据导入Neo4j及导入具体步骤及Demo

博文原地址:https://my.oschina.net/zlb1992/blog/918243

852

扫码关注云+社区