npm 包 gelf-pro 使用教程

阅读时长 4 分钟读完

前言

在现今的互联网时代,Web前端开发人员的日常工作中,一项重要的任务就是实时地收集和分析前端错误log并进行快速响应,从而尽早解决出现的问题。而 syslog是Unix环境下的一个系统日志服务,log信息在一台或多台服务器上流通,是一项被广泛使用的服务。GELF(Graylog Extended Log Format),是一种Greylog向外提供的用于传输log信息的各种数据格式,GELF协议支持UDP,AMQP,HTTP等多种协议, 具有轻量级,compact语义,易于解析,可拓展性等优点。因此,前端开发人员常常使用GELF协议来处理前端错误信息。

npm 包 gelf-pro是一个基于GELF协议封装的nodejs依赖包,主要用于向gelf server发送log信息。在这篇文章中,将会深入的介绍如何安装和使用这个npm包。

安装

我们可以通过npm,在命令行中输入如下命令以进行安装:

使用

使用前需要引入gelf-pro:

初始化

-- -------------------- ---- -------
-------------------
    ------- -
        --------- -----------
        ---- -----
    --
    ------------ ------
    --------------- -
        ------- ------------
        ----- --------------
    -
---
  • fields 选项:可以增加其他字段。
  • adapterName 选项:可以配置日志传输协议和一些参数。
  • adapterOptions 选项:可以通过“server”进行gelf server配置,通过“host”设置“_host”字段的值,如果该选项为“String”,则默认将其设置为“additional fields”。

发送log信息

  • short_message 必填:log信息的简略信息。
  • full_message 可选:log信息的详细信息。
  • _users_id 可选:当前用户的ID,可以用于更精细的追踪log信息。
  • _log_level 可选:log信息的级别,用于支持GELF的基本语义。

示例代码

-- -------------------- ---- -------
--- ------- - --------------------
-------------------
    ------- -
        --------- -----------
        ---- -----
    --
    ------------ ------
    --------------- -
        ------- ------------
        ----- --------------
    -
---

-----------------
    -------------- ---------- ----- ---------
    ------------- --------- ----- ---------
    ---------- -------
    ----------- -
---

总结

npm包gelf-pro的使用对于前端开发人员实时处理错误信息有很大的帮助,我们只需要在包的配置文件中配置好服务器地址和相关信息,然后就可以通过gelf-pro依赖包将错误信息发送给gelf server,从而实现快速有效的错误处理。此外,在实际开发中,我们还可以在gelf-pro配置中添加自己需要的字段,从而更好地解析log信息。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/69300

纠错
反馈