NPM 包 express-healthcheck 使用教程

阅读时长 10 分钟读完

什么是 express-healthcheck

express-healthcheck 是一个 NPM 包,用于添加一个健康检查接口到 Express 应用程序中。健康检查接口可以检查应用程序是否正常运行,从而可以及时发现并解决问题。

安装 express-healthcheck

使用 npm 安装 express-healthcheck:

在 Express 中使用 express-healthcheck

在 Express 应用程序中引入 express-healthcheck 并添加健康检查接口:

这样就添加了一个健康检查接口到应用程序中,当访问 /healthcheck 时会返回:

还可以添加自定义选项:

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

express-healthcheck 源码分析

express-healthcheck 源码分为两个文件:

healthcheck.js

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

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

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

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

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

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

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

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

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

index.js

总结

通过使用 express-healthcheck 包,你可以方便地向 Express 应用程序添加健康检查接口,及时发现应用程序中的问题,解决问题的同时提高了应用程序的可靠性。

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

纠错
反馈