博客 | NGINX

成功的 API 策略需要监控哪 12 个指标

NGINX-F5-horiz-black-type-RGB 的一部分
Andrew Stiefel 缩略图
安德鲁·施蒂费尔
2023 年 1 月 17 日发布

随着公司采用API 优先设计实践来构建现代应用,衡量这些 API 的运行性能和价值成为首要任务。 建立一个明确定义并将 API 指标与关键绩效指标 (KPI) 相连接起来的框架是确保 API 策略成功的最重要步骤之一。

通常,KPI 与特定目标相关。 它们具有明确的时间框架,并与您的 API 策略需要提供的结果保持一致。 相比之下,API 指标是重要的数据点。 并非每个指标都是 KPI,但每个 KPI 都是以指标开始的。

那么,如何开始呢? 首先,您需要从一开始就明确您的 API 策略的目标,然后选择与该目标相符的指标。 请记住,每个团队都需要根据其重要性和对业务至关重要性来衡量和跟踪不同的指标。

广义上讲,公司可以跟踪三种类型的 API 指标,每种类型回答不同的问题:

  • 运营指标——API 是否提供了您所需的稳定性、可靠性和性能?
  • 采用指标——开发人员是否采用并使用您的 API?
  • 产品指标——API 如何支持您的业务目标?

想象一下这些总体指标就像一个金字塔。 在底部,操作指标衡量各个 API 及其支持基础设施的战术性能。 最顶层的产品指标衡量的是您的 API 所创造的商业价值。 两者通过采用指标联系起来,该指标跟踪 API 程序与最终用户(开发人员)的增长情况。 通常,产品指标和采用指标与您需要衡量的业务成果相一致,而运营指标与您需要维护的技术标准相一致。

在这篇文章中,我们分解了 12 个需要衡量的关键具体指标,讨论了它们如何支持基础设施和应用团队,并解释了这些指标与 KPI 的关系。

运营指标

当您刚刚开始时,运营指标通常是首先要衡量的事情。 它们非常具有策略性,并能提供有关 API 如何运作的见解。 运营指标本身通常不是 KPI。 相反,它们可以帮助您衡量团队正在构建的软件的质量和性能。 它们可以提供新出现的问题的早期指标,或者帮助您深入研究并发现可能影响关键 KPI 的问题。

您跟踪的运营指标将因团队和职责而异。

基础设施团队

Platform Ops是负责维护、连接和保护不同团队用于交付应用的基础设施和技术集合的团队。 对于 API 程序,这通常包括 API 网关和 API 开发人员门户。

Platform Ops 等基础设施团队的关键指标包括:

  1. 正常运行时间——即使作为最基本的指标之一,正常运行时间也是衡量服务可用性的黄金标准。 这通常与服务水平协议(SLA) 相关。
  2. CPU 和内存使用情况——跟踪 API 网关的资源利用率对于确定何时需要扩展实例至关重要。 当某些东西开始出现故障或者由于错误导致使用量激增时,它还可以起到早期预警的作用。
  3. 总通过率和错误率——测量 API 触发 HTTP 错误的频率(非200) 状态代码可帮助您了解 API 的错误发生概率。 此总体衡量指标提供的信息可帮助您判断团队投入生产的 API 的整体质量。

application团队

应用团队由 API 开发人员和服务所有者组成,负责构建和运营单个服务或应用。 它们可以用作更大产品的一部分,与合作伙伴集成,或者将 API 作为服务提供给开发人员。

对于应用团队来说,以下指标非常重要:

  1. 每分钟请求数——此性能指标衡量您的 API 处理的请求数。 虽然它会随着时间而变化,但您通常希望向下管理它以确保 API 用户获得最佳体验。
  2. 平均和最大延迟——跟踪 API 接收请求和返回响应所需的平均时间至关重要。 一个缓慢的 API 可能会对用户体验产生负面影响,从而对业务产生负面影响。
  3. 每分钟错误数——像其他任何事物一样,没有完美的 API。 失败只是时间问题,而不是是否会发生的问题。 您需要监控错误,并在错误突然出现之前制定修复计划。

在电子书《掌握 API 架构》(由 O'Reilly 编写,由 NGINX 提供)第 3-5 章中,深入研究 API 操作并了解从业务角度来看哪些 KPI 和指标至关重要。

采用指标

对于 API 优先的业务,必须超越工程指标并了解开发人员如何与您的 API 进行交互。 您还需要衡量和监控API 开发人员的体验,以确保开发人员采用您的 API 并从中获取价值。

采用指标的一些示例包括:

  1. 唯一 API 消费者——通常与月度用户数有时间限制,该指标衡量有多少开发人员正在采用和使用您的 API。 理想情况下,随着越来越多的开发人员将您的 API 集成到他们的应用中,这个指标会随着时间的推移而增长。
  2. API 使用率增长——该指标也衡量 API 的采用情况,并且通常是首选指标。 理想情况下,随着使用 API 的应用和开发人员数量的增加,API 流量每月也会增长。
  3. 首次调用时间——此指标衡量开发人员创建帐户、生成 API 凭证和运行第一个 API 调用所需的时间。 让开发人员尽快启动并运行是当务之急,因此该指标对于衡量整体 API 开发人员体验最为重要。

笔记: 我们建议至少有一个 KPI 旨在衡量 API 的采用情况。 这有助于计算 API 程序的整体增长。 例如,您可以设置一个 KPI 来增加使用您的 API 创建持续集成或应用程序的开发人员的数量。

产品指标

API 产品指标在理解 API 的价值方面发挥着重要作用。虽然只有一小部分 API 可以直接带来收入,但每个 API 都需要为企业提供价值。

要衡量的关键产品指标包括:

  1. 直接和间接收入——这些指标针对 API 对收入贡献的不同方式。 虽然有些 API 可以直接货币化,但其他 API 则支持与业务合作伙伴的集成或受客户重视的第三方集成。 与 API 的采用率一样,跟踪间接收入有助于开发人员为合作伙伴构建创收应用程序。
  2. 每个 API 的应用– API 需要可重复使用。 该指标衡量有多少应用与 API 集成,以了解哪些 API 提供的价值最大。
  3. 合作伙伴数量——API 通常可以实现业务关系。 跟踪合作伙伴 API 集成的数量有助于推动采用并向其他业务部门展示价值。

笔记: 这些产品指标与业务影响密切相关,您可以根据业务目标选择将其中一些指标转化为 KPI。 例如,如果您的 API 策略的业务目标是通过第三方提供商接触更多客户,那么您需要跟踪使用 API 的合作伙伴数量以及通过这些集成产生的间接收入。

《掌握 API 架构》的第 3-5 章中更深入地探索 API 产品生命周期 - 包括业务和运营 KPI。

结论

协调 API 指标和业务 KPI 是做出数据驱动决策并确保 API 策略能够提供组织所需价值的主要方法之一。 不仅如此,获得对 API 的可见性还可以使基础设施和应用团队能够衡量对他们来说最重要的运营指标。

在 NGINX,我们提供数十个重要 API 指标的可见性。 您可以查看实时和历史指标,并轻松将其导出到您首选的应用性能监控 (APM) 或数据分析解决方案。

立即开始使用NGINX 管理套件的 30 天免费试用版,其中包括访问API 连接管理器NGINX Plus作为 API 网关,以及NGINX App Protect以保护您的 API。


“这篇博文可能引用了不再可用和/或不再支持的产品。 有关 F5 NGINX 产品和解决方案的最新信息,请探索我们的NGINX 产品系列。 NGINX 现在是 F5 的一部分。 所有之前的 NGINX.com 链接都将重定向至 F5.com 上的类似 NGINX 内容。”