简介
viologs 是一个 npm 包,用于在前端应用中记录日志并监控性能,可以帮助开发者快速发现并解决性能瓶颈或错误。
安装
在命令行中运行以下命令进行安装:
npm install viologs --save
使用
引入
在需要使用 viologs 的模块中引入:
import Logger from 'viologs';
创建 Logger 实例
可以通过 new Logger(config)
创建一个 Logger 实例,其中 config 是一个配置对象,可以包含以下参数:
- logLevel:指定日志等级,默认值为
'INFO'
。 - maxSize:指定日志文件的最大大小(MB),默认值为
10
。 - maxFiles:指定最大保留日志文件数量,默认值为
10
。 - logFilePath:指定日志文件存储路径,默认值为
'./logs'
。 - enableConsoleLog:是否启用控制台输出日志,默认为
true
。 - useLocalStorage:是否使用 localStorage 存储设备信息和错误列表,默认为
true
。
示例:
-- -------------------- ---- ------- ----- ------ - - --------- -------- -------- -- --------- -- ------------ --------- ----------------- ------ ---------------- ----- -- ----- ------ - --- ---------------
记录日志
Logger 实例提供了四个方法用于记录不同等级的日志:
- debug(message, context):记录调试信息。
- info(message, context):记录普通信息。
- warn(message, context):记录警告信息。
- error(message, context):记录错误信息。
其中 message 表示要记录的信息,context 表示可选的上下文信息,可以是对象或者字符串。
示例:
logger.debug('debug message', { foo: 'bar' }); logger.info('info message', 'context string'); logger.warn('warn message'); logger.error('error message', new Error('something wrong'));
监控性能
viologs 还提供了两个方法用于监控前端性能:
- startTimer(name):开始计时器。
- endTimer(name, context):停止计时器并记录信息。
其中 name 表示计时器名称,context 表示可选的上下文信息,可以是对象或者字符串。
示例:
logger.startTimer('timer1'); setTimeout(() => { logger.endTimer('timer1'); }, 1000);
设置用户信息
可以通过 setUserInfo(userInfo)
方法设置用户信息,一般在用户登录时调用。userInfo 应该是一个对象,可以包含以下属性:
- id:用户ID。
- name:用户名。
- email:用户邮箱。
- custom:自定义信息,是一个对象。
示例:
const userInfo = { id: 123, name: 'John', email: 'john@example.com', custom: { foo: 'bar' } }; logger.setUserInfo(userInfo);
获取设备信息
可以通过 getDeviceInfo()
方法获取设备信息,包含浏览器名称和版本、操作系统名称和版本、屏幕分辨率等信息。
示例:
const deviceInfo = logger.getDeviceInfo(); console.log(deviceInfo);
总结
viologs 提供了一个方便的前端日志记录和性能监控的解决方案,可以帮助开发者快速追踪问题并提高调试效率。通过本文的介绍,你可以了解它的基本使用方法,希望对你有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f82238a385564ab6b9f