了解您的内部 API 在生产环境中的性能似乎是一项艰巨的任务。事实上,直到最近,大多数团队都没有积极监控他们的 API。随着最近的市场变化,越来越多的团队将 API 监控作为其运维团队和 QA 团队的优先事项,以便正确测试每个版本并设置监控以确保这种性能在生产环境中持续。我们在 API 现状调查 2019 中看到,将 API 监控视为首要任务的团队在解决性能问题方面明显优于那些没有这样做的人。
拥有正式 API 监控流程并将监控视为首要任务的团队中,有 76% 的团队在头 24 小时内解决 API 性能问题。
毫无疑问,了解生产环境中发生的事情可以帮助您比从客户那里听到 API 速度缓慢或未按预期执行的情况更快地解决问题。令人惊讶的是,没有监控流程的团队数量。SmartBear 开始调查如何使优先考虑 API 质量的团队更容易进行此过程,并发现为了帮助促进 API 监控的采用,它必须无缝地融入团队当前的工作流程中。
什么是 API 监控?
API 监控涉及利用监控工具(更常见的是 综合监控工具)来驱动 API 的流量,并记录您的 API 在给定流量下的行为。此过程使您的团队(DevOps、运维、QA 和性能)能够深入了解生产环境中发生的情况。这对于查明任何速度缓慢、功能不正确和停机的根本原因非常有帮助。一个好的综合监控工具将能够通知您任何性能偏差、管理 SLA,并在出现问题时提醒您的团队。
如何在不扰乱发布流程的情况下监控我的 API?
将 API 监控集成到发布周期的第一步,在不中断当前流程的情况下,是尝试确定您可以 重用资产 的位置,以及如何自动化 API 监控流程。如果您的团队使用 Swagger、OpenAPI 规范或 SwaggerHub,那么您已经离开始监控 API 更近了一步。AlertSite 是 SwaggerHub 背后的同一个团队提供的综合监控工具,可以使用您的 OpenAPI 规范文件自动创建监控。此外,在最新版本中,您现在可以使用 Swagger Inspector 扩展开始监控您的私有 API。
开始监控私有(或内部)API 和公共 API 实际上非常容易。如果您熟悉 Swagger Inspector,它会更容易。
在这种情况下,我们使用 AlertSite(SmartBear 的综合监控工具)有以下几个原因
- AlertSite 可以使用您的 OAS 文件或只需粘贴一个端点 URL 即可自动创建新的监控。
- AlertSite 监控 API 事务(验证每个 API 调用并确保整个流程按预期执行)。
- AlertSite 可以监控 SLA
- 您可以使用 AlertSite API 以编程方式驱动您的监控流程
- AlertSite 警报是高度可配置、快速且准确的,因此可以在需要时提醒正确的团队。
使用 Swagger Inspector 扩展监控私有 API
Swagger Inspector 扩展可以启用从您的浏览器到此端点的直接连接。单击“使用 Swagger Inspector”复选框以启用 Swagger Inspector 扩展并重新验证端点。
使用 OpenAPI 规范文件监控公共 API
要开始监控您的公共 API,您只需要 OAS 文件或一个端点 URL 即可开始。
要开始使用,请尝试使用 AlertSite 监控您的 API。我们提供 免费 30 天全功能试用,以便您可以了解它如何为您的团队工作。