侧边栏壁纸
博主头像
平平无奇小陈博主等级

今天不想跑,所以才去跑。

  • 累计撰写 46 篇文章
  • 累计创建 49 个标签
  • 累计收到 33 条评论

一文了解,日志框架使用

平平无奇小陈
2020-12-14 / 0 评论 / 0 点赞 / 68 阅读 / 2,961 字
温馨提示:
本文最后更新于 2022-02-03,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

一文了解,日志框架使用

前言

本文主要讲解日志级别,并举例说明各级别日志使用及其注意事项。

相对于 System.out 来说,日志框架有两个最大的优点就是可以指定输出类别 (category) 和级别 (level).

系统日志级别通常有 8 个(常用 errorwarninfodebug),按输出优先级从高到低依次为:

  • OFF:最高级别,用于关闭所有日志记录。
  • FATAL:致命错误,严重事件导致程序退出,无法正常使用。
  • ERROR:错误,不影响系统继续运行。只记录系统逻辑出错、异常或者重要的错误信息。
  • WARN:警告,潜在错误的情形,用于提示开发者。
  • INFO:信息,粗颗粒的记录系统,应用程序的运行过程。
  • DEBUG:调试,细颗粒的系统运行日志,用于调试程序。
  • TRACE:低级别,一般不会使用。
  • ALL:最低级别,用于打开所有日志记录。

常用日志级别实例

DataX 项目源码举例并参照 阿里巴巴 Java开发手册 中关于日志框架相关内容,说明 errorwarninfodebug 四个常用日志级别的使用实例。

应用中不可直接使用日志系统( Log4j、 Logback) 中的 API,而应依赖使用日志框架( SLF4J、 JCL--Jakarta Commons Logging) 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

举例:(推荐使用 SLF4J)

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);

Debug - 调试

在日志输出时,字符串变量之间的拼接使用占位符的方式。

说明: 因为 String 字符串的拼接会使用 StringBuilderappend() 方式,有一定的性能损耗。使用占位符仅是替换动作,可以有效提升性能。

String thisStartKey = getStartKey(startRowkeyByte, regionStartKey);
String thisEndKey = getEndKey(endRowkeyByte, regionEndKey);

p.set(Key.START_ROWKEY, thisStartKey);
p.set(Key.END_ROWKEY, thisEndKey);

LOG.debug("startRowkey:[{}], endRowkey:[{}] .", thisStartKey, thisEndKey);

configurations.add(p);

对于 trace/debug/info 级别的日志输出,必须进行日志级别的开关判断。

虽然在 debug(参数)的方法体内第一行代码 isDisabled(Level.DEBUG_INT)为真时( Slf4j 的常见实现Log4j 和 Logback),就直接 return,但是参数可能会进行字符串拼接运算。

此外,如果 debug(getName()) 这种参数内有 getName()方法调用,无谓浪费方法调用的开销。

// 如果判断为真,那么可以输出 trace 和 debug 级别的日志
if (logger.isDebugEnabled()) {
	logger.debug("Current ID is: {} and name is: {}", id, getName());
}

Info - 信息

粗颗粒的记录系统,应用程序的运行过程。

public void writeOneRecord(List<String> splitedRows) throws IOException {
    if (splitedRows.isEmpty()) {
        LOG.info("Found one record line which is empty.");
    }
    this.csvWriter.writeRecord((String[]) splitedRows
            .toArray(new String[0]));
}

Warn - 警告

潜在错误的情形,用于提示开发者。

if (StringUtils.isBlank(encoding)) {
    LOG.warn(String.format("您配置的encoding为[%s], 使用默认值[%s]", encoding,
            Constant.DEFAULT_ENCODING));
    encoding = Constant.DEFAULT_ENCODING;
}

Error - 错误

异常信息应该包括两类信息:案发现场信息异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。

例如:ogger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

private void doBatchUpsert(List<Record> records) throws SQLException {
    try {
        // 将所有record提交到connection缓存
        for (Record r : records) {
            setupStatement(r);
            ps.executeUpdate();
        }
        // 将缓存的数据提交到hbase
        connection.commit();
    } catch (SQLException e) {
        LOG.error("Failed batch committing " + records.size() + " records", e);
        // 批量提交失败,则一行行重试,以确定那一行出错
        connection.rollback();
        doSingleUpsert(records);
    } catch (Exception e) {
        throw DataXException.asDataXException(HbaseSQLWriterErrorCode.PUT_HBASE_ERROR, e);
    }
}

注意事项

  • 日志打印时禁止直接用 JSON 工具将对象转换成 String。

如果对象里某些 get 方法被重写,存在抛出异常的情况,则可能会因为打印日志而影响正常业务流程的执行。
打印日志时仅打印出业务相关属性值或者调用其对象的 toString()方法。

  • 谨慎地记录日志。

生产环境禁止输出 debug 日志; 有选择地输出 info 日志; 如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。

  • 生产环境禁止直接使用 System.outSystem.err 输出日志或使用**e.printStackTrace()**打印异常堆栈。

  • 所有日志文件至少保存 15 天,因为有些异常具备以“周” 为频次发生的特点。

对于当天日志,以“应用名.log” 来保存,保存在/home/admin/应用名/logs目录下,过往日志格式为: {logname}.log.{保存日期},日期格式: yyyy-MM-dd。以mppserver应用为例,日志保存在/home/admin/mppserver/logs/mppserver.log,历史日志名称为 mppserver.log.2016-08-01

0

评论区