Linux编程之定制带级别的log

我的开发组长曾经说过这么一段话“一个优秀的程序员不在于他写代码有多快,也不在于他能不能实现这个模块的功能,要实现业务实现功能谁不会啊,重要的是他的解决能力,也就说当程序出现错误时你能不能够快速定位到错误并解决它。”

是的,我也非常赞同,代码不可能完美,也可能有千奇百怪的bug,尤其是新手,犯的错误就更多了,所以,我们写程序时应有自己的一套debug手段,有一套自己的LOG的方法,一旦程序发生错误,我们不需要再往程序中加繁琐的打印就可以定位到错误位置,这样才能加快自己的开发速度。

那怎么才算有一套高效的debug手段呢?我的想法是这样:

  • 进程内开一个独立线程用于Debug&Info Center,在这里我们可以看到所有的打印信息,便于追踪各程序动向
  • 标准化一套日志/打印的手段,不要再使用简陋的printf,在适当的位置加适当的log

今天我们先来完成自定义一套属于我们LOG的规定。

一、信息类别与等级

我们知道,程序内可能出现各种异常,有的异常很严重,一不注意就发生coredump;有的异常只是可能对程序的运行产生影响,但不至于挂掉;有的异常是隐蔽的,虽说现在没对系统产生明显影响,但是不加处理也终究是个隐患。如果我们对这些异常都使用printf语句的话,我们就区分不了哪些异常重要哪些不重要了,所以我们首先得给信息分类别评等级(severity)。我的划分是这样的:

  1. fatal           致命错误
  2. alarm         需要立即纠正的错误
  3. error          需要关注的错误
  4. warning      警告,可能存在某种差错
  5. info            一般提示信息
  6. debug        调试信息

代码定义可以这么写:

#define FATAL      1#define ALARM      2#define ERROR      3#define WARN       4#define INFO       5#define DEBUG      6

二、log的设计

根据我们上面规定的打印等级,我们很容易设计出相应的debug log,闲话少说,先上代码:

#define MY_LOG(level, fmt, args...)  do{  \    if(BIT_ON(debug_flag,level)){          printf("[%s]:", __FUNCTION__);         printf(fmt, ##args);     }  }while(0)

当然我们还需要定义一套设置debug level的方法,我的思路是这样的:

  • 采用bit-map思想,定义一个unsigned int的数,这个数的而每一位表示一个级别,比如一个unsigned int的数就可以表示32个级别
  • 定义相应的函数/宏定义,去设置相应的位

根据以上想法,可以设置出下面一系列的操作:

#define PRESENT_BIT32(x)        (((uint32)((uint32)1<<(x))))#define BIT_ON32(m, b)            (((m) & PRESENT_BIT32(b)) != 0)#define SET_BIT32(m, b)            ((m) |= PRESENT_BIT32(b))#define CLEAR_BIT32(m, b)        ((m) &= ~PRESENT_BIT32(b))

解释:

  • PRESENT_BIT32(x)    :对应level的位的位置
  • BIT_ON32(m, b)      :判定某一位是否为1
  • SET_BIT32(m, b)     :设置指定位为1
  • CLEAR_BIT32(m, b)   :将指定为设置为0

上面我们使用了宏定义来定义出带级别的LOG,那该怎么使用这些LOG呢?使用方法如下:

if(pthread_create(&thread2_id, NULL, (void*)msg_sender2, NULL))
{
    MY_LOG(FATAL,"create handler thread fail!\n");    return -1;
 }

MY_LOG(DEBUG,"I have recieved a message!\n");
MY_LOG(DEBUG,"msgtype:%d   msg_src:%d  dst:%d\n\n",msg->hdr.msg_type,msg->hdr.msg_src,msg->hdr.msg_dst);

当然使用前需要先打开相应的log开关,比如我想看debug的log,可以这么做:

SET_BIT(debug_flag, DEBUG);

这样子我们就将系统的debug级别定义为DEBUG了。

再说一个打印的小技巧:给你的打印上颜色!

printf("\033[46;31m[%s:%d]\033[0m "#fmt" errno=%d, %m\r\n", __func__, __LINE__, ##args, errno, errno);

上面printf时在Linux命令行下打印出带颜色的字体,方便一眼区分不同种类的调试信息,只需要加上一些颜色代码,例如:这里的46代表底色, 31代表字体的颜色。

使用ascii code 是对颜色调用的始末格式如下:

\033[ ; m …… \033[0m

后面哪个 ”\033[0m” 是对前面哪个颜色载入的结束,恢复到终端原来的背景色和字体色,可以把后面哪个修改成如下试试:

#define DEBUG_ERR(fmt, args...) printf("\033[46;31m[%s:%d]\033[40;37m "#fmt" errno=%d, %m\r\n", __func__, __LINE__, ##args, errno, errno);

下面列出 ascii code 的颜色值:

字背景颜色范围:40----49                           字颜色:30-----------39

40:黑                                                       30:黑

41:深红                                                    31:红

42:绿                                                       32:绿

43:黄色                                                    33:黄

44:蓝色                                                    34:蓝色

45:紫色                                                    35:紫色

46:深绿                                                    36:深绿

47:白色                                                    37:白色

记忆颜色格式太麻烦了,我们将它搞成宏定义吧,这样以后用起来就方便得多。

#define NONE                 "\e[0m"#define BLACK                "\e[0;30m"#define L_BLACK              "\e[1;30m"#define RED                  "\e[0;31m"#define L_RED                "\e[1;31m"#define GREEN                "\e[0;32m"#define L_GREEN              "\e[1;32m"#define BROWN                "\e[0;33m"#define YELLOW               "\e[1;33m"#define BLUE                 "\e[0;34m"#define L_BLUE               "\e[1;34m"#define PURPLE               "\e[0;35m"#define L_PURPLE             "\e[1;35m"#define CYAN                 "\e[0;36m"#define L_CYAN               "\e[1;36m"#define GRAY                 "\e[0;37m"#define WHITE                "\e[1;37m"#define BOLD                 "\e[1m"#define UNDERLINE            "\e[4m"#define BLINK                "\e[5m"#define REVERSE              "\e[7m"#define HIDE                 "\e[8m"#define CLEAR                "\e[2J"#define CLRLINE              "\r\e[K" //or "\e[1K\r"#define DEBUG_ERROR(fmt, args...) do{      printf(RED"[%s]:"NONE, __FUNCTION__);      printf(fmt, ##args);      }while(0);

效果:

所以,我建议将fatal一类致命错误级别的log用高亮颜色标注,一旦有这类错误发生我们也能第一时间察觉。

时间: 2024-10-10 16:24:25

Linux编程之定制带级别的log的相关文章

Linux编程---I/O部分

非常多函数都能够在网上找到,也比較基础,所以原型仅仅给出了函数名.详细用到再man吧. 输入输出是个非常重要的一块内容.差点儿网络相关的东西基本都是靠底层IO调用来实现的. 好吧.还是先踏踏实实的介绍一下C标准库中的IO函数吧.个别函数我也是第一次见.对于不太常见的我就多解释一下,反正通常这些函数百度一下就清楚了,我就不多解释了~ 1.C标准库IO函数 1.1流的关闭开启与重定向 fopen:打开一个流 fclose:关闭一个流 freopen:又一次打开一个流 1.2 读与写 读: fgetc

Linux编程基础

一.Linux编程环境 1. 程序编辑器: 命令模式: i(insert):插入 a(after):之后插入 x():删除字符 dd:删除一行 :行号进行指定 :/字符串:搜索字符串 :q,退去 :wq ndd:删除n行 yy:复制当前行 p:粘贴 ny:从当前航开始复制 2. gcc gcc -s  text.c gcc  -c text.c gcc -o text  text.c gcc -o text test1.o text2.o 二.调试工具 1. gdb 执行调试命令:gdb tes

Linux编程---信号处理

信号是一种异步的进程间通信的方式.但是这种通知方式能交换的信息很少.只能说给一个事件的标志.类似单片机中的中断,强迫进程停止做当前应当做的事情,而去执行中断执行程序. 信号的产生有如下几种: 1.用户按下了某个终止键,如ctrl-\或ctrl-c.是由终端程序向当前进程发送一个中断信号. 2.程序异常.比如除零错误. 3.kill函数向其发送了一个终止信号 4.进程向自己发送信号.如进程调用alarm函数. 5.企图读写终端的后台进程会得到作业的控制信号SIGTTIN或SIGTOU. 6.当进程

Ansys Totem 14.1.b2 Linux 64位版 晶体管级电源噪声和可靠性仿

ANSYS Totem是一款晶体管Ansys Totem 14.1.b2 Linux 64位版 晶体管级电源噪声和可靠性仿级电源噪声和可靠性仿真平台,可用于模拟.混合信号和定制数字设计. 新版Ansys Totem 14.1.b2支持Linux系统: RedHat Enterprise 3 SUSE 9 或更高版本 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 专业行业软件,值得信赖! 为您提供完整版好用软件!竭诚为您

Linux编程---线程

首先说一下线程的概念.其实就是运行在进程的上下文环境中的一个执行流.普通进程只有一条执行流,但是线程提供了多种执行的路径并行的局面. 同时,线程还分为核心级线程和用户级线程.主要区别在属于核内还是核外. 核心级线程,地位基本和进程相当,由内核调度.也就是说这种系统时间片是按线程来分配的.这种线程的好处就是可以适当的运用SMP,即针对多核CPU进行调度. 用户级线程,在用户态来调度.所以相对来说,切换的调度时间相对核心级线程来说要快不少.但是不能针对SMP进行调度. 对于现在的系统来说,纯粹的用户

Linux编程---套接字

网络相关的东西几乎都是建立在套接字之上.所以这个内容对于程序员来说还是蛮重要的啊. 其实套接字也就是一个特殊的设备文件而已,我始终不能明白为什么要叫套接字.这么个奇怪的名字.不过还是就这样算了吧.关键还是编程上.由于其重要性,我还是写的详细一点吧. 一.套接字 核心函数: int  socket(int domain,int type,int protocol); 这个函数在通信域domain中创建一个类型为type,使用协议protocol的套接字.并且返回一个描述字,也就是相当于打开了一个特

你是如何学习 Linux 编程的?

首先,要学Linux编程,你得会用Linux,也就是得在命令行环境下生存下来.什么叫生存下来呢?就是我现在给你一台主机,键盘,显示器啥的,然后给你一个服务器版的Linux系统的光盘或者其他什么安装盘,你去把这台主机用起来.什么叫用起来呢?你平常用Windows电脑干啥,你现在还用这台电脑干啥.新建文件啊,查看文件,编辑文件,保存文件,复制,移动,删除,打包,解压,联网,下载个什么东西啊等等基本操作你得会.还有软件怎么安装,不仅要熟悉apt-get和yum,还有给你源码的软件怎么安装你得会,另外要

Linux编程定时执行某函数

 前言: linux中信号提供了软中断的作用.提供了一种处理异步时间的方法 ,  可以通过信号合理的安排异步任务. linux定义了以下主要的系统信号: 名称                        默认动作                        说明 SIGHUP                   终止进程                        终端线路挂断 SIGINT                   终止进程                        中

【转】牛人整理分享的面试知识:操作系统、计算机网络、设计模式、Linux编程,数据结构总结

基础篇:操作系统.计算机网络.设计模式 一:操作系统 1. 进程的有哪几种状态,状态转换图,及导致转换的事件. 2. 进程与线程的区别. 3. 进程通信的几种方式. 4. 线程同步几种方式.(一定要会写生产者.消费者问题,完全消化理解) 5. 线程的实现方式. (也就是用户线程与内核线程的区别) 6. 用户态和核心态的区别. 7. 用户栈和内核栈的区别. 8. 内存池.进程池.线程池.(c++程序员必须掌握) 9. 死锁的概念,导致死锁的原因. 10. 导致死锁的四个必要条件. 11. 处理死锁