RESTful API 是 web 开发中最常用的 API 设计模式之一。随着公司的业务逐渐扩大，RESTful API 的服务追踪与监控变得愈发重要。这篇文章将介绍如何利用常用的服务追踪与监控工具来监控 RESTful API 并进行故障排除。
背景知识
要理解本文所讨论的内容，读者需要掌握以下技术：
- RESTful API 设计
- Node.js 开发基础
- 服务追踪与监控工具
服务追踪与监控的重要性
虽然 RESTful API 是一种高效的API 设计方式，但在实际生产环境中，API 服务器可能会面临以下问题：
- DDoS 攻击：攻击者使用大量请求来淹没 API 服务器，使其无法正常工作。
- 服务故障：API 服务器可能因硬件故障或程序错误而崩溃。
- 性能问题：API 服务器可能无法处理大量的请求，导致响应时间变慢，甚至超时。
当这些问题发生时，必须迅速找到问题的根本原因并采取恰当的措施解决问题。这就需要服务追踪与监控工具。下面，我们将介绍一些常用的工具。
使用 Zipkin 进行服务追踪
Zipkin 是一个开源的分布式跟踪系统，它可以帮助我们抓住 API 请求的“尾巴”，对整个请求过程的细节进行追踪。Zipkin 可以显示一个完整的请求链路，包括每个服务的响应时间和错误信息。使用 Zipkin 可以帮助我们很快地了解哪个服务出了问题，以及为什么出了问题。
安装 Zipkin
我们首先需要在本地安装 Zipkin。可以通过以下方式进行安装：
- ---- --- ------------------------------- - ---- -- - ---- ---- ----------
这会在本地启动 Zipkin 服务器，运行在默认端口 9411 上。之后，我们需要在 Node.js 中使用 Zipkin 的客户端来将我们的服务连接到 Zipkin 服务器。
集成 Zipkin
Zipkin 通过注入特殊的代码来连接到我们的 Node.js 应用程序。我们可以使用 zipkin-instrumentation-http 包显式地注入 Zipkin 元素。
----- ------- - ------------------ ----- ---- - -------------------------------------------------------- ----- ------ - ------------------ ----- ------ - --- --------------- -------- --- ------------------------ --- ----- --- - --------- --------------------------------------- ------------ ----- ---- -- - --------------- --------- -- ---------------- -- -- - -------------------- --- --------- -- ---- ------- --
这个例子中，我们将 Zipkin 跟踪注入到了 express 应用程序中。我们使用 zipkin-instrumentation-express 包来包装应用程序的中间件，然后将应用程序放入 Zipkin 中。
追踪请求链路
现在，我们启动 Zipkin，并启动上面的例子程序。
- ---- ------
在浏览器中请求 http://localhost:3000/，并打开 Zipkin 的 web 界面，可以看到类似下图的请求链路：
从图中可以看到，我们的请求从浏览器开始，接着调用了 Node.js 应用程序，然后在最后生成了响应。我们还可以看到请求中相应服务的响应时间和错误等信息。
使用 Prometheus 进行服务监控
Zipkin 可以帮助我们追踪服务请求链路，以便快速找到故障。但是，当应用程序运行在生产环境中时，我们还需要监控应用程序的运行状态，以便在应用程序出现性能问题时采取措施。这时我们可以使用 Prometheus 进行服务性能监控。
安装 Prometheus
首先，我们需要在本地安装 Prometheus。可以通过以下方式进行安装：
- ---- --- ----------------------------------------------------------------------------------------------------- - --- ---- ------------------- - -- ------------
这会在本地解压 Prometheus 服务器。然后，我们需要编写与 Node.js 应用程序相关的监控规则。使用 Prometheus 的默认规则时，它只能监控一些常见的系统指标，如 CPU 和内存使用情况，但不能监控 JS 应用程序的请求响应时间等更高级的指标。
集成 Prometheus
我们可以使用以下 Node.js 包将 Node.js 应用程序与 Prometheus 连接起来：
----- ------- - ------------------
----- ---------- - ------------------------------
----- ----------------- - ------------
-------------- -----
------------ -----
------------ -----------
----------- -
---------------------- --
-
--
----- --- - ---------
--------------------------
------------ ----- ---- -- -
--------------- ---------
--
---------------- -- -- -
-------------------- --- --------- -- ---- -------
--这个例子中，我们使用了 express-prom-bundle 库将节点应用程序与 Prometheus 连接起来。它会将所有指标捆绑在一个单一的 metricsPath 下，并将和使用 Prometheus 相关的指标全部记录下来，以便进行可视化。
监控指标
在应用程序启动后，我们即可连接到 Prometheus 界面，通过以下网址访问：
---------------------------
在这个界面中，您可以为 Prometheus 指标编写配置，也可以查询现有指标。例如，下面的查询语句能够显示请求响应时间：
-------------------------------------------------------
其中 <your_service> 是节点应用程序的名称。使用这个指标，我们可以监视响应时间是否在预期范围内。
结论
本文介绍了如何使用 Zipkin 和 Prometheus 监控 RESTful API 服务的请求链路和服务运行状况。使用这些工具可以轻易地监控服务状况并及时发现故障。通过考虑使用 Zipkin 和 Prometheus，团队们可以快速分析和解决问题，以便在应用程序运行时能够确保最高的可用性和可靠性。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/67025bacd91dce0dc8473569