简介
当你的应用程序依赖于第三方 API 或后端服务，这些 API 或服务可能会随时出现故障或中断，这时需要一种方法来确保这些服务的正常运行。这正是 rutilus-apiheartbeat-node 出现的原因。
rutilus-apiheartbeat-node 是一个 npm 包，它提供了一个简单而有效的方式，来验证 API 或服务是否可用。当它监测到连接错误、响应慢或状态码错误时，会发出警报。
本教程将向你介绍如何使用 rutilus-apiheartbeat-node 来监测你的 API 或服务是否可用，并提供一些使用该 npm 包的技巧和指南。
安装
使用 npm 安装 rutilus-apiheartbeat-node：
npm install --save rutilus-apiheartbeat-node
使用
使用 rutilus-apiheartbeat-node 进行 API 监测非常简单。只需按照下面的步骤进行设置。
- 创建一个配置文件
在你的项目中创建一个 config.js 文件，用于设置 rutilus-apiheartbeat-node 的配置选项。
-- -------------------- ---- -------
-------------- - -
------- -------------------------- -- ---- --- ---
--------- ------ -- -------------------
-------- ----- -- ------------------
------------ ------ -- -------------
--------------- ---------------------- -
-------------------------- -- -------
-
-- 初始化 rutilus-apiheartbeat-node
在你的项目中，使用以下代码初始化 rutilus-apiheartbeat-node：
const Heartbeat = require('rutilus-apiheartbeat-node');
const config = require('./config');
const heartbeat = new Heartbeat(config);- 开始监测
heartbeat.start();
将会在控制台打印出如下信息：
正常： https://api.example.com 状态码：200 时间：19 ms
如果请求失败，将会发出警报：
故障： https://api.example.com 状态码：404 时间：136 ms
高级用法
状态码码码码码子
在 config.js 中，你可以设置 statusCodes 数组，用于允许通过的状态码。例如，如果想要允许 200、201 和 202 的状态码通过，只需设置：
statusCodes: [200, 201, 202]
监测超时
默认情况下，rutilus-apiheartbeat-node 的监测超时时间为 5 秒钟。如果需要更改超时时间，只需在 config.js 文件中设置 timeout 参数。例如，如果需要将超时时间更改为 10 秒，只需设置：
timeout: 10000
定制警报函数
默认情况下，rutilus-apiheartbeat-node 只会在控制台打印警报信息。如果需要更详细的警报信息，或将警报信息发送到其他服务，可以在 config.js 中自定义警报函数。
notifyFunction: function(errorMessage) {
// 将警报信息发送到其他服务
}停止监测
如果需要停止 rutilus-apiheartbeat-node 的监测，只需使用以下代码：
heartbeat.stop();
结论
现在你已经学会了如何使用 rutilus-apiheartbeat-node 对你的 API 和服务进行监测。如果你有任何问题或疑问，可以查看官方文档，或者在 npm 网站上留言。
最后，希望这篇文章能够帮助你更好地使用 rutilus-apiheartbeat-node。让我们一起构建更加稳定和可靠的应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600557f181e8991b448d508c