logger

一个 Sumor Cloud 工具。
更多文档

这是一个用于 Node.JS 的轻量级日志记录器。
它可以以不同级别输出日志,并且您可以自定义作用域、ID 和时区。

CI Test Coverage Audit

安装

npm i @sumor/logger --save

先决条件

Node.JS 版本

要求 Node.JS 版本 16.x 或更高

需要 Node.JS ES 模块

由于这个包是用 ES 模块编写的,请在您的 package.json 文件中做如下更改:

{
  "type": "module"
}

使用

常规用法

import Logger from '@sumor/logger'
const logger = new Logger()

logger.trace('Hello World!')
// 您将看到如下输出:
// 2020-01-01 00:00:00.000 TRACE MAIN - Hello World!

更改作用域

对于某些情况,我们需要对日志进行分类。scope 用于此目的。

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'DEMO'
})
logger.trace('Hello World!')
// 您将看到如下输出:
// 2020-01-01 00:00:00.000 TRACE DEMO - Hello World!

标识用户

对于某些情况,我们需要标识用户。id 用于此目的。

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'USER001'
})
logger.trace('Hello World!')
// 您将看到如下输出:
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - Hello World!

更改级别

大多数时候,我们只需要输出特定级别的日志。然后我们可以决定是否存储和显示它。

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('Hello World!') // trace 是最低级别,所有日志都将被输出
logger.debug('Hello World!')
logger.info('Hello World!')
logger.warn('Hello World!')
logger.error('Hello World!')
logger.fatal('Hello World!') // fatal 是最高级别,只有关键错误将被输出

更改时区

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // UTC+2 时区偏移 2 小时
})
logger1.info('Hello World!')
// 您将看到如下输出:
// 2020-01-01 02:00:00.000 INFO MAIN - Hello World!

const logger2 = new Logger({
  offset: 8 * 60 // UTC+8 时区偏移 8 小时
})
logger2.info('Hello World!')
// 您将看到如下输出:
// 2020-01-01 08:00:00.000 INFO MAIN - Hello World!