npm 包 volos-analytics-apigee 使用教程

阅读时长 4 分钟读完

介绍

volos-analytics-apigee 是基于 Apigee Edge 平台的分析组件,可以轻松地用于 API 分析和监控。它提供了与 Apigee Edge 的 API 相关的基本度量标准,并与 Apigee 数据抓取的实时汇总完美配合。本文将介绍 volos-analytics-apigee 的使用方法及其使用场景。

安装

首先,你需要在项目中安装 volos-analytics-apigee。可以通过以下命令进行安装:

配置

在使用 volos-analytics-apigee 之前,需要先配置它。

API

要使用 volos-analytics-apigee,必须拥有 Apigee Edge 上的 API 管理权限。请联系你的管理员为你的 API 创建统计服务(collectors)。

环境变量

volos-analytics-apigee 通过读取环境变量来确定它需要连接到的 API 的位置。

需要设置以下环境变量:

  • APIGEE_ORG:Apigee Edge 上的机构名称。
  • APIGEE_ENV:Apigee Edge 上的运行环境名称。
  • APIGEE_API:统计服务所在的 API 名称。
  • APIGEE_TOKEN:Apigee Edge 中的令牌,用于对 API 进行验证。

代码示例

以下是一个示例代码,描述如何使用 volos-analytics-apigee

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

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

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

以上代码使用了 volos-analytics-apigee,与 Apigee Edge 上的 API 进行了一次数据收集。此代码通过以下环境变量连接到该 API:

在这个例子中,stats 对象提供了一些数据,包括:

  • responseTime:API 的响应时间。
  • target:统计服务(collector)的名称。
  • name:API 的名称。

进一步探索

volos-analytics-apigee 的功能不限于简单的 API 监控。你可以使用一些高级特性来收集更多的数据,以更精确地分析这些数据。

子统计服务

可以对服务进行分类,以便更好地对其进行分析。例如,可以针对特定的客户或具有特定功能的组件创建子统计服务。通过这种方式,可以更精确地监控服务,并收集与子服务相关的数据。

收集器集合

此外,收集器集合提供了一种统一管理多个服务的功能。你可以将性能指标集中到一个地方,并使用多种技术和展示工具将其可视化。

数据挖掘

volos-analytics-apigee 具有相当多的统计功能。你可以使用这些功能来收集和分析大量的数据,以发现到底哪些 API 需要优化和改进。

总结

volos-analytics-apigee 可以为你提供关于 API 性能和度量,提供重要的洞察力以便更好地了解用户体验。通过适当地配置它,即可轻松地监控并对 API 进行分析。

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