npm 包 good-hipchat 使用教程

阅读时长 4 分钟读完

简介

good-hipchat 是一个用于将 hapi 日志输出到 Hipchat 的 npm 包。Hipchat 是一种团队协作工具,可以用于即时通讯、文件共享、项目管理等方面。使用 good-hipchat 可以将 hapi 中的日志输出到 Hipchat 中,方便开发者实时监控和处理日志。

安装

配置

创建 Hipchat API Token

在使用 good-hipchat 前,需要在 Hipchat 中创建一个 API Token,用于访问 API。

  1. 登录 Hipchat,在右上角选择 “Group admin”;
  2. 在左侧边栏中选择 “Integrations”;
  3. 找到 “API access tokens” 并点击加号;
  4. 填写名称,并选择 “Send notifications” 权限;
  5. 点击 “Create” 即可创建 API Token。

配置 good-hipchat

配置 good-hipchat 需要传递一个配置对象,包括以下参数:

  • hipchatApiKey:Hipchat API Token;
  • room:Hipchat 的房间 ID;
  • from:Hipchat 中消息的发送者名称;
  • url:Hipchat API 的 URL(默认为 https://api.hipchat.com/v2/room/)。

示例:

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

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

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

在注册 good-hipchat 时,需要传递一个名为 notifications 的对象,用于配置日志的筛选条件。

通常,日志由以下类型组成:

  • ops:hapi 的运行统计信息;
  • response:请求响应相关的日志,包括请求成功和失败的信息;
  • error:应用程序代码抛出的异常。

示例中的配置为:输出所有日志,但只提取指定类型的内容。

使用

good-hipchat 会在日志满足筛选条件后将其发送到指定的 Hipchat 房间。如果未找到 Hipchat API Token 或发生其他错误,good-hipchat 将向控制台输出错误信息。

可以通过以下代码演示:

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

以上代码会在请求处理时向终端输出相应的日志,并将它们发送到指定的 Hipchat 房间。

结语

good-hipchat 是一个便捷易用的工具,可以将 hapi 日志输出到 Hipchat 中。通过配置筛选条件,可以灵活地选择需要的日志类型,方便开发者实时监控和处理应用程序的状态。

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

纠错
反馈