@vp/log

前端日志标准化库

📦 安装

yarn add @vp/log

🔨 使用

import log, { LogType } from '@vp/log'

log({
  type: LogType.FETCH_TIMEOUT,              // 日志类型，必填
  desc: '描述',                              // 描述，可选
  error: new Error('some error happened'),  // 错误信息，可选
  info: {} || '',                           // 额外信息字段，可选
  time: 3000,                               // 超时时间，可选
})

日志格式

默认使用 console 进行记录，可在使用前通过重写 console 达到定制化输出。

日志类型

| 日志类型 | 说明 | 是否需要告警 | | ---------------- | ------------------------ | ---------------------- | | SERVICE_START | 服务启动信息记录 | | | KOA_ERROR | 服务端框架内部错误 | 是 | | KOA_WARN | 服务端框架内部警告 | | | SYSTEM_WARN | 系统错误告警 | | | SYSTEM_ERROR | 系统错误 | 是 | | RENDER_ERROR | 服务端渲染报错 | 是 | | RENDER_LONG_TIME | 服务端渲染超时(>500ms) | 单位时间内过多需要告警 | | FETCH_ERROR | 接口请求报错 | 是 | | FETCH_TIMEOUT | 接口请求超时 | 是 | | FETCH_LONG_TIME | 接口请求时间过长(>400ms) | 单位时间内过多需要告警 | | REDIS_ERROR | Redis连接错误 | 是 | | REDIS_INFO | Redis连接成功 | |

以下 CODE 适用于 FETCH_LONG_TIME 、 RENDER_LONG_TIME

| 请求时间过长CODE | 备注 | | ---------------- | -------------- | | TIME_LOW_500 | 小于等于500ms | | TIME_LOW_1000 | 小于等于1000ms | | TIME_LOW_2000 | 小于等于2000ms | | TIME_LOW_3000 | 小于等于3000ms | | TIME_HIGH_3000 | 超过3000ms |