蓝天

改进后的日志类CLogger

在原有的基础上增加了module_name，表示模块名，当一个系统由多模块组成时，输出的日志将更加清晰，使用方法，以MOOON-agent中的为例：

点击(此处)折叠或打开

  1. #define AGENT_MODULE_NAME "AGENT"

  3. #define AGENT_LOG_BIN(log, size) __MYLOG_BIN(agent::logger, log, size)
  4. #define AGENT_LOG_TRACE(format, ...) __MYLOG_TRACE(agent::logger, AGENT_MODULE_NAME, format, ##__VA_ARGS__)
  5. #define AGENT_LOG_FATAL(format, ...) __MYLOG_FATAL(agent::logger, AGENT_MODULE_NAME, format, ##__VA_ARGS__)
  6. #define AGENT_LOG_ERROR(format, ...) __MYLOG_ERROR(agent::logger, AGENT_MODULE_NAME, format, ##__VA_ARGS__)
  7. #define AGENT_LOG_WARN(format, ...) __MYLOG_WARN(agent::logger, AGENT_MODULE_NAME, format, ##__VA_ARGS__)
  8. #define AGENT_LOG_INFO(format, ...) __MYLOG_INFO(agent::logger, AGENT_MODULE_NAME, format, ##__VA_ARGS__)
  9. #define AGENT_LOG_DEBUG(format, ...) __MYLOG_DEBUG(agent::logger, AGENT_MODULE_NAME, format, ##__VA_ARGS__)


下面是完整的接口代码，具体实现，请参见logger.cpp：

点击(此处)折叠或打开

  1. #ifndef MOOON_SYS_LOG_H
  2. #define MOOON_SYS_LOG_H
  3. #include <sys/config.h>
  4. SYS_NAMESPACE_BEGIN

  6. /** 不要修改下面的常量值，而应当通过对应的方法去修改
  7.   * 这些常量值主要是方便多模块共享，故放在这个公有头文件当中
  8.   */
  9. enum
  10. {
  11.     LOG_LINE_SIZE_MIN = 256, /** 日志行最小长度 */
  12.     LOG_LINE_SIZE_MAX = 32768, /** 日志行最大长度(32K) */
  13.     DEFAULT_LOG_FILE_SIZE = 104857600, /** 默认的单个日志文件大小(100MB) */
  14.     DEFAULT_LOG_FILE_BACKUP_NUMBER = 10 /** 默认的日志文件备份个数 */
  15. };

  17. /** 定义日志级别 */
  18. typedef enum
  19. {
  20.     LOG_LEVEL_DETAIL = 0,
  21.     LOG_LEVEL_DEBUG = 1,
  22.     LOG_LEVEL_INFO = 2,
  23.     LOG_LEVEL_WARN = 3,
  24.     LOG_LEVEL_ERROR = 4,
  25.     LOG_LEVEL_FATAL = 5,
  26.     LOG_LEVEL_STATE = 6, /** 仅输出状态数据 */
  27.     LOG_LEVEL_TRACE = 7
  28. }log_level_t;

  30. /** 通过日志级别名得到日志级别 */
  31. extern log_level_t get_log_level(const char* level_name);
  32. /** 通过日志级别得到日志级别名，如果传入错误的日志级别，则返回NULL */
  33. extern const char* get_log_level_name(log_level_t log_level);

  35. /**
  36.   * 日志器接口，提供常见的写日志功能
  37.   */
  38. class ILogger
  39. {
  40. public:
  41.     /** 空虚拟析构函数，以屏蔽编译器告警 */
  42.     virtual ~ILogger() {}
  43.         
  44.     /** 是否允许同时在标准输出上打印日志 */
  45.     virtual void enable_screen(bool enabled) {}
  46.     /** 是否允许二进制日志，二进制日志必须通过它来打开 */
  47.     virtual void enable_bin_log(bool enabled) {}
  48.     /** 是否允许跟踪日志，跟踪日志必须通过它来打开 */
  49.     virtual void enable_trace_log(bool enabled) {}
  50.     /** 是否自动在一行后添加结尾的点号，如果最后已经有点号或换符符，则不会再添加 */
  51.     virtual void enable_auto_adddot(bool enabled) {}
  52.     /** 是否自动添加换行符，如果已经有换行符，则不会再自动添加换行符 */
  53.     virtual void enable_auto_newline(bool enabled) {}
  54.     /** 设置日志级别，跟踪日志级别不能通过它来设置 */
  55.     virtual void set_log_level(log_level_t log_level) {}
  56.     /** 设置单个文件的最大建议大小 */
  57.     virtual void set_single_filesize(uint32_t filesize) {}
  58.     /** 设置日志文件备份个数，不包正在写的日志文件 */
  59.     virtual void set_backup_number(uint16_t backup_number) {}

  61.     /** 是否允许二进制日志 */
  62.     virtual bool enabled_bin() { return false; }
  63.     /** 是否允许Detail级别日志 */
  64.     virtual bool enabled_detail() { return false; }
  65.     /** 是否允许Debug级别日志 */
  66.     virtual bool enabled_debug() { return false; }
  67.     /** 是否允许Info级别日志 */
  68.     virtual bool enabled_info() { return false; }
  69.     /** 是否允许Warn级别日志 */
  70.     virtual bool enabled_warn() { return false; }
  71.     /** 是否允许Error级别日志 */
  72.     virtual bool enabled_error() { return false; }
  73.     /** 是否允许Fatal级别日志 */
  74.     virtual bool enabled_fatal() { return false; }
  75.     /** 是否允许输出状态日志 */
  76.     virtual bool enabled_state() { return false; }
  77.     /** 是否允许Trace级别日志 */
  78.     virtual bool enabled_trace() { return false; }

  80.     virtual void log_detail(const char* module_name, const char* format, ...) {}
  81.     virtual void log_debug(const char* module_name, const char* format, ...) {}
  82.     virtual void log_info(const char* module_name, const char* format, ...) {}
  83.     virtual void log_warn(const char* module_name, const char* format, ...) {}
  84.     virtual void log_error(const char* module_name, const char* format, ...) {}
  85.     virtual void log_fatal(const char* module_name, const char* format, ...) {}
  86.     virtual void log_state(const char* module_name, const char* format, ...) {}
  87.     virtual void log_trace(const char* module_name, const char* format, ...) {}

  89.     /** 写二进制日志 */
  90.     virtual void bin_log(const char* log, uint16_t size) {}
  91. };

  93. //////////////////////////////////////////////////////////////////////////
  94. // 日志宏，方便记录日志
  95. extern ILogger* g_logger; // 只是声明，不是定义，不能赋值哦！

  97. #define __MYLOG_DETAIL(logger, module_name, format, ...) \
  98. do { \
  99.     if (NULL == logger) \
  100.         printf(format, ##__VA_ARGS__); \
  101.     else if (logger->enabled_detail()) \
  102.         logger->log_detail(module_name, format, ##__VA_ARGS__); \
  103. } while(false)

  105. #define __MYLOG_DEBUG(logger, module_name, format, ...) \
  106. do { \
  107.     if (NULL == logger) \
  108.         printf(format, ##__VA_ARGS__); \
  109.     else if (logger->enabled_debug()) \
  110.         logger->log_debug(module_name, format, ##__VA_ARGS__); \
  111. } while(false)

  113. #define __MYLOG_INFO(logger, module_name, format, ...) \
  114. do { \
  115.     if (NULL == logger) \
  116.         printf(format, ##__VA_ARGS__); \
  117.     else if (logger->enabled_info()) \
  118.         logger->log_info(module_name, format, ##__VA_ARGS__); \
  119. } while(false)

  121. #define __MYLOG_WARN(logger, module_name, format, ...) \
  122. do { \
  123.     if (NULL == logger) \
  124.         printf(format, ##__VA_ARGS__); \
  125.     else if (logger->enabled_warn()) \
  126.         logger->log_warn(module_name, format, ##__VA_ARGS__); \
  127. } while(false)

  129. #define __MYLOG_ERROR(logger, module_name, format, ...) \
  130. do { \
  131.     if (NULL == logger) \
  132.         printf(format, ##__VA_ARGS__); \
  133.     else if (logger->enabled_error()) \
  134.         logger->log_error(module_name, format, ##__VA_ARGS__); \
  135. } while(false)

  137. #define __MYLOG_FATAL(logger, module_name, format, ...) \
  138. do { \
  139.     if (NULL == logger) \
  140.         printf(format, ##__VA_ARGS__); \
  141.     else if (logger->enabled_fatal()) \
  142.         logger->log_fatal(module_name, format, ##__VA_ARGS__); \
  143. } while(false)

  145. #define __MYLOG_STATE(logger, module_name, format, ...) \
  146. do { \
  147.     if (NULL == logger) \
  148.         printf(format, ##__VA_ARGS__); \
  149.     else if (logger->enabled_state()) \
  150.         logger->log_state(module_name, format, ##__VA_ARGS__); \
  151. } while(false)

  153. #define __MYLOG_TRACE(logger, module_name, format, ...) \
  154. do { \
  155.     if (NULL == logger) \
  156.         printf(format, ##__VA_ARGS__); \
  157.     else if (logger->enabled_trace()) \
  158.         logger->log_trace(module_name, format, ##__VA_ARGS__); \
  159. } while(false)

  161. #define __MYLOG_BIN(logger, log, size) \
  162. do { \
  163.     if ((logger != NULL) && logger->enabled_bin()) \
  164.         logger->bin_log(log, size); \
  165. } while(false)

  167. #define MYLOG_BIN(log, size) __MYLOG_BIN(sys::g_logger, log, size)
  168. #define MYLOG_TRACE(format, ...) __MYLOG_TRACE(sys::g_logger, NULL, format, ##__VA_ARGS__)
  169. #define MYLOG_STATE(format, ...) __MYLOG_STATE(sys::g_logger, NULL, format, ##__VA_ARGS__)
  170. #define MYLOG_FATAL(format, ...) __MYLOG_FATAL(sys::g_logger, NULL, format, ##__VA_ARGS__)
  171. #define MYLOG_ERROR(format, ...) __MYLOG_ERROR(sys::g_logger, NULL, format, ##__VA_ARGS__)
  172. #define MYLOG_WARN(format, ...) __MYLOG_WARN(sys::g_logger, NULL, format, ##__VA_ARGS__)
  173. #define MYLOG_INFO(format, ...) __MYLOG_INFO(sys::g_logger, NULL, format, ##__VA_ARGS__)
  174. #define MYLOG_DEBUG(format, ...) __MYLOG_DEBUG(sys::g_logger, NULL, format, ##__VA_ARGS__)
  175. #define MYLOG_DETAIL(format, ...) __MYLOG_DETAIL(sys::g_logger, NULL, format, ##__VA_ARGS__)

  177. SYS_NAMESPACE_END
  178. #endif // MOOON_SYS_LOG_H


posted on 2012-07-24 16:19  #蓝天  阅读(303)  评论(0)  编辑  收藏  举报

导航