UMajs

日志（Logger）

日志

日志对于 Web 项目的运行状态、问题排查等都非常重要。框架的@umajs/logger模块提供日志支持。并且提供@umajs/plugin-logger模块，以插件的机制将 logger 实例绑定在 ctx 上，方便用户使用。

主要特性：

  • 日志分级
  • 统一错误日志，所有 logger 中使用 .error() 打印的 ERROR 级别日志都会打印到统一的错误日志文件中，便于追踪
  • 自定义日志
  • 自动切割日志

使用plugin-logger

  • 安装插件 npm install -S @umajs/plugin-logger
  • 插件配置：
//app/src/config/default/plugin.config.ts
import * as path from 'path'

const { ROOT } = Uma.options

export default {
  logger: {
    enable: true,
    options: {
      level: 'DEBUG', //日志输出级别
      file: path.resolve(ROOT, '../log/logger.log'),
      allowDebugAtProd: false, // 是否允许打印debug日志
    },
  },
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  • 在 Controller 中使用 logger

plugin-logger插件将 logger 实例绑定在 ctx 上，因此可在项目中使用this.ctx.logger使用；

// app/src/controller/index.controller.ts
export default class Index extends BaseController {
  @Path('/index')
  @RequestMethod('GET')
  index() {
    this.ctx.logger.info(this.testService.return1())
    this.ctx.logger.debug('debug')
    this.ctx.logger.warn('warn')
    this.ctx.logger.error('error')
    return this.send('这里是首页')
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
  • 在 Service 中使用 logger 【 v0.0.5 版本后支持】

plugin-logger绑定到 ctx 上的 logger 实例可通过UmaLogger.instance()获取

// app/src/service/test.service.ts
import { BaseService } from '@umajs/core'
import { UmaLogger } from '@umajs/logger'

export default class test extends BaseService {
  return1() {
    UmaLogger.instance().info('service test')
    return 1
  }
}
// [INFO 51449] 2020-04-10 18:42:21,179 bogon [::1/GET /]: service test
1
2
3
4
5
6
7
8
9
10
11

使用 UmaLogger

UmaLogger可单独使用，具体提供如下几种使用方式：

  1. 通过 new UmaLogger() 独立创建日志实例
// app/src/controller/index.controller.ts
import { UmaLogger } from '@umajs/logger'
import * as path from 'path'

const logger = new UmaLogger({
  level: 'ALL',
  consoleLevel: 'ALL',
  encoding: 'utf-8',
  file: path.resolve(__dirname, '../log/logger.log'),
})
logger.debug('debug')
logger.info('info GET')
logger.warn('warn')
logger.error('error')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
  1. 直接使用 @umajs/logger 模块默认导出的实例 【 v0.0.5 版本后支持】
const logger = require('@umajs/logger')
logger.init({
  level: 'ALL',
  consoleLevel: 'ALL',
  encoding: 'utf-8',
  file: path.resolve(__dirname, '../log/logger.log'),
})
logger.debug('debug')
logger.info('info GET')
logger.warn('warn')
logger.error('error')
1
2
3
4
5
6
7
8
9
10
11
  1. 通过单例模式使用 logger 【 v0.0.5 版本后支持】

只需传入一次参数，其他地方可直接使用 UmaLogger.instance() 获取实例化后日志对象

// app/src/controller/index.controller.ts
import { UmaLogger } from '@umajs/logger'
import * as path from 'path'

const logger = UmaLogger.instance({
  level: 'ALL',
  consoleLevel: 'ALL',
  encoding: 'utf-8',
  file: path.resolve(__dirname, '../log/logger.log'),
})
logger.debug('debug')
logger.info('info GET')
logger.warn('warn')
logger.error('error')
1
2
3
4
5
6
7
8
9
10
11
12
13
14

日志配置

exports.logger = {
  level: 'DEBUG', //日志输出级别
  dir: '/path/to/your/custom/log', //日志输出目录
  errorLogName: 'errorlogger.log', //error级别日志文件名
  infoLogName: 'infologger.log', //info级别日志文件名
  warnLogName: 'warnlogger.log', //warn级别日志文件名
  file: '/path/to/your/custom/log/logger.log', //日志文件写入路径(所有级别日志)
  encoding: 'utf-8', //日志编码格式
  outputJSON: true, //是否格式化输出携带pid等信息 false仅输出msg
  consoleLevel: 'debug', //终端日志输出级别
  allowDebugAtProd: true, //是否允许打印debug日志
  flushInterval: 1000, //文件流定时写入
  maxBufferLength: 1000, //最大buffer 超出限制执行写入
  formatter: function (meta?: TConsoleMeta) {
    return `[${meta.level} ${meta.pid}] ${meta.date} ${meta.hostname} ${meta.paddingMessage}: ${meta.message}`
  }, //日志格式化输出
  splitTime: '00 00 * * * *', //日志文件切割时间
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

日志路径

  1. 默认日志文件路径：默认都放在${APP_ROOT}/log/logger.log路径下；
  2. 自定义日志文件路径： config.file会把所有日志统一写入file所指定的文件中；
// config/logger.config.ts
exports.logger = {
  file: '/path/to/your/custom/log/logger.log', //日志文件路径(所有级别日志统一写入)
}
1
2
3
4
  1. 不同级别日志分开打印

日志按级别分开打印，需配置config.dir config.errorLogName ...

// config/logger.config.ts
exports.logger = {
  dir: '/path/to/your/custom/log', //日志目录
  errorLogName: 'errorlogger.log', //error级别日志文件名
  infoLogName: 'infologger.log', //info级别日志文件名
  warnLogName: 'warnlogger.log', //warn级别日志文件名
}
1
2
3
4
5
6
7

所有级别的日志会写入/path/to/your/custom/log/logger.log文件

Info级别的日志会写入/path/to/your/custom/log/infoLogName.log文件

Warn级别的日志会写入/path/to/your/custom/log/warnLogName.log文件

Error级别的日志会写入/path/to/your/custom/log/errorLogName.log文件

日志分类

框架内置了几种日志，分别在不同的场景下使用：

  • ContextLogger：默认开启，使用this.ctx.logger.info()可使用，可获取上下文
  • errorLogger：任何 logger 的.error()调用输出的日志都会走此逻辑，默认关闭不使用，开启需要配置dir errorLogName
  • infoLogger：任何 logger 的.info()调用输出的日志都会走此逻辑，默认关闭不使用，开启需要配置dir infoLogName
  • warnLogger：任何 logger 的.warn()调用输出的日志都会走此逻辑，默认关闭不使用，开启需要配置dir warnLogName

如何打印日志

ContextLogger

如果我们在处理请求时需要打印日志，这是需要使用ContextLogger，用于记录 Web 行为相关的日志，日志内容会携带当前请求的一些基本信息。

try {
  this.ctx.logger.info1(12312323)
} catch (error) {
  this.ctx.logger.error('错误:', error)
}
this.ctx.logger.info(this.testService.return1())
this.ctx.logger.debug('debug') // only output to stdout
this.ctx.logger.info('info')
this.ctx.logger.warn('warn')
this.ctx.logger.error('error')
1
2
3
4
5
6
7
8
9
10

日志级别

日志分为ALL DEBUG INFO WARN ERROR NONE6 个级别。默认会同时打印INFO及以上级别的日志到文件和终端，可自定义日志输出级别：

1.文件日志级别（默认INFO）

// config/logger.config.ts
exports.logger = {
  level: 'ALL', // 打印所有级别日志到文件中
}
1
2
3
4

2.终端日志级别（默认INFO）

// config/logger.config.ts
exports.logger = {
  consoleLevel: 'NONE', //关闭日志终端输出
}
1
2
3
4

consoleLevel优先级高于level，consoleLevel仅对终端输出生效。

images

3.生产环境关闭打印 debug 日志，默认关闭

// config/logger.config.ts
exports.logger = {
  allowDebugAtProd: false, // 是否打印debug日志
}
1
2
3
4

日志文件输出

  1. 文件编码，默认编码为utf-8，可自定义
  2. 日志文件输出格式默认为[${meta.level} ${meta.pid}] ${meta.date} ${meta.hostname}: ${meta.message}

images

// config/logger.config.ts
exports.logger = {
  encoding: 'gbk',
  outputJSON: true,
}
1
2
3
4
5

日志切割

  1. 默认按天切割，在每日00:00按照.log.YYYY-MM-DD 文件名切割。
  2. 切割文件时间可配置，格式按照node-schedule
// config/logger.config.ts
exports.logger = {
  splitTime: '00 00 * * * *',
}
1
2
3
4

切割后日志文件如下所示： images