在前端开发的过程中,日志是非常重要的一部分,它的记录对于排查问题和定位 bug 都非常有帮助。而 trunks-log 就是一个方便管理前端日志的 npm 包,下面将为大家带来 trunks-log 的使用教程。
安装
使用 npm 安装 trunks-log
npm install trunks-log
引入
将 trunks-log 引入项目中
import { Logger } from 'trunks-log';
基本使用
在项目启动阶段,我们需要初始化 Logger。
const logger = new Logger({ level: 'debug', appenders: ['console', 'file'], path: '/log/', prefix: 'log' });
level
:指定日志记录的级别,分为debug
,info
,warn
和error
。默认为info
。appenders
:指定日志的输出渠道,支持console
和file
。默认为['console']
。path
:指定文件输出日志的存放目录,需要确保目录已经存在。默认为项目根目录。prefix
:指定日志文件的前缀。默认为log
。
记录日志
logger.debug('debug level log'); logger.info('info level log'); logger.warn('warn level log'); logger.error('error level log');
自定义格式
默认输出的日志格式只包含时间和日志内容,如果你需要自定义格式,可以通过 layout
参数,传入一个函数进行配置。
-- -------------------- ---- ------- ----- ------ - --- -------- ------ -------- ---------- ----------- -------- ----- -------- ------- ------ ------- ------- -------- ----- -- - ------ ------------------------- ------- - ------------ - ---
日志文件拆分
如果你的项目需要记录大量的日志,建议将日志文件拆分成为按天为单位的文件。你可以通过设置 maxLogSize
和 backups
参数进行配置。
const logger = new Logger({ level: 'debug', appenders: ['console', 'file'], path: '/log/', prefix: 'log', maxLogSize: 1024 * 1024 * 10, backups: 3 });
maxLogSize
:设置日志文件的最大大小,单位为字节。默认为 1024 * 1024 * 100。backups
:设置保留的日志文件数量,超过数量的文件将被自动删除。默认为 5。
总结
trunks-log 作为一个非常方便的日志管理工具包,为前端开发者提供了非常方便的日志管理方式。通过本篇文章的介绍,相信大家已经对 trunks-log 有了一定的了解,并可以在开发中运用起来,记录更加优质的日志。
示例代码
-- -------------------- ---- ------- ------ - ------ - ---- ------------- ----- ------ - --- -------- ------ -------- ---------- ----------- -------- ----- -------- ------- ------ ------- ------- -------- ----- -- - ------ ------------------------- ------- - ------------ -- ----------- ---- - ---- - --- -------- - --- ------------------- ----- ------ ----------------- ----- ------ ----------------- ----- ------ ------------------- ----- ------
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b5b51ab1864dac67011