记录器

一个 Sumor Cloud 工具。
更多文档

这是一个专为 Node.JS 设计的轻量级记录器。
它可以以不同级别输出日志，并且您可以自定义作用域、标识符和时区。

安装

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!

预定义代码

import Logger from '@sumor/logger'
const code = {
  trace: {
    HTTP_ACCESS: '用户通过 HTTP 访问，IP 地址为 {ip}'
  },
  debug: {
    USER_TOKEN_LOADED: '读取用户登录信息，用户 ID 为 {id}'
  },
  info: {
    USER_LOGIN: '用户登录，用户 ID 为 {id}'
  },
  warn: {
    USER_LOGOUT: '用户退出登录，用户 ID 为 {id}'
  },
  error: {
    USER_LOGIN_FAILED: '用户登录失败，用户 ID 为 {id}'
  },
  fatal: {
    USER_LOGIN_BLOCKED: '用户登录被阻止，用户 ID 为 {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: '用户登录，用户 ID 为{id}'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('USER_LOGIN', { id: 'USER001' })
// 您将看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001

const logger2 = new Logger({
  code,
  i18n,
  language: 'zh-US'
})

logger2.code('USER_LOGIN', { id: 'USER001' })
// 您将看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001

const logger3 = new Logger({
  code,
  i18n,
  language: 'zh-CN'
})

logger3.code('USER_LOGIN', { id: 'USER001' })
// 您将看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001