观察 API

Postman Monitors 可用于跟踪 API 的功能和端到端性能以及响应时间。您还可以查看 API 的 New Relic 指标，并在 Postman 中查看相关的 New Relic 仪表板和部署。

• 链接监视器
• 连接到监控集成
• 查看 New Relic APM 指标

链接监视器

您可以将当前工作区中的监视器链接到 API 版本。这使您能够按计划的时间间隔检查 API 的性能和响应时间。在 API 版本的Monitoring选项卡中，您可以创建新监视器或添加现有监视器。

创建新监视器

在 API 版本监控选项卡上，在Monitors旁边，选择Add Monitor并选择Create new monitor。

您可以选择从 API 架构生成集合、使用现有集合或创建新集合：

• 从模式生成集合：
  1. 指定集合的​​名称。
  2. 通过选择Show advanced settings配置如何生成集合。
  3. 选择生成集合并继续。
• 使用现有集合：
  1. 在下拉列表中选择现有集合。
  2. 选择选择集合并继续。
• 创建一个新集合：
  1. 添加您计划监控的请求，指定方法和 URL，以及您要检查的状态代码和响应时间。
  2. 选择创建集合并继续。

接下来，配置新监视器。有关详细信息，请参阅设置监视器。

添加现有监视器

您可以将现有监视器添加到您的 API：

1. 在 API 版本监控选项卡上，在Monitors旁边，选择Add Monitor并选择Add existing monitor。

2. 从列表中选择一个监视器，然后选择添加监视器。您只会在列表中的工作区中看到可用的监视器。

有关创建监视器的更多信息，请参阅设置监视器。

连接到监控集成

Postman 集成使您能够将监视器运行的结果发送到各种应用程序和渠道，例如 Slack、Microsoft Teams、Datadog 或 Splunk。您还可以将监视器结果发送到自定义 webhook，以将 Postman 监视器与您的特定工作流程集成。

API Builder 中的监控选项卡提供了一个地方来管理您的所有 API 监控集成。您可以设置新的集成、跟踪结果并查看所有已配置的监视器集成。

添加监视器集成

将 API 版本连接到一个或多个监控集成，以将监控结果发送到属于您的 API 开发工作流程的其他应用程序。添加监视器集成时，监视器会自动链接到 API 版本。

1. 如果您还没有这样做，请创建要连接到 API的监视器。
2. 打开 API 版本并选择监控选项卡。
3. 在将 Postman 连接到您的监控工作流下，选择一个监控集成。
4. 输入集成的昵称并选择监视器。Postman 会将此监视器的结果发送到您正在集成的应用程序。
5. 完成输入请求的信息。此信息因您要集成的应用程序而异，通常包括 API 密钥。有关特定应用程序的更多帮助，请参阅与 Postman集成并在左侧导航窗格中选择可用的集成。
6. 选择添加集成。

您可以为监视器配置多个集成，甚至可以拥有同一集成的多个实例。例如，您可以为监视器配置两个 Slack 集成，将监视器的结果发送到两个不同的 Slack 通道。

使用监视器集成

将监控器集成添加到 API 版本后，您可以在监控选项卡上执行以下操作：

• 选择监视器的名称以在新选项卡中打开其仪表板。

• 选择监视器旁边的验证以根据 API 模式验证它（仅限 OpenAPI 3.0 模式）。如果验证不成功，请选择找到的问题，然后选择查看问题。了解有关验证 API的更多信息。

• 将鼠标悬停在图表中的条形上可查看监视器运行的指标。

  

• 将鼠标悬停在集成的应用程序图标上以查看详细信息。选择编辑图标以编辑集成，或选择删除图标以删除集成。

  

• 将鼠标悬停在监视器上并选择运行以立即运行监视器。

• 将鼠标悬停在监视器上并选择删除图标以从 API 版本中删除监视器。（监视器及其关联的集成不会被删除。）

查看 New Relic APM 指标

New Relic 是一种应用程序性能管理 (APM) 解决方案，用于监控您的流程或 Web 应用程序的实时和趋势数据。API Builder 具有 New Relic 集成，使您能够直接从 Postman 中访问 New Relic APM 指标。

通过这种集成，Postman 中的每个 API 版本都可以链接到 New Relic 的多个服务。每个服务都可以对应一个正在运行的 API 实例，例如 beta、prod1 和 prod2。您还可以选择将多个仪表板从 New Relic 链接到您的 API。

您还可以将 Postman 监控结果发送到 New Relic。请注意，将监视器结果发送到 New Relic 是与查看 APM 指标的单独集成，并且使用不同的 New Relic API 密钥。了解有关配置 Postman 监视器与 New Relic 集成的更多信息。

连接到 New Relic APM

在开始之前，您必须为 API 的每个部署设置 APM 服务。有关详细信息，请参阅New Relic APM 文档。

要将 API 连接到 New Relic APM：

1. 打开 API 版本并选择监控选项卡。
2. 在将 Postman 连接到您的监控工作流下，选择New Relic APM。
3. 在身份验证选项卡上：

   • 输入昵称。

   • 输入新的 Relic 用户 API 密钥。

     New Relic 中有多种类型的 API 密钥。确保使用用户密钥将 API 连接到 New Relic。有关 New Relic 中的 API 密钥的更多信息，请参阅New Relic API 密钥文档。

   • 选择您的 New Relic 区域。

   • 选择验证。

4. 在选择服务选项卡上：
   • 选择一项或多项 New Relic APM 服务。
   • 或者，选择一个或多个 New Relic Dashboards。
   • 选择连接。

使用 APM 仪表板

建立 New Relic 连接后，监控选项卡将显示您的服务表，以及它们的延迟、错误率、apdex（成功与总请求的比率）和健康状态。

健康状况基于 New Relic 中违反警报条件的情况，如下表所示。有关详细信息，请参阅查看警报违规的 New Relic 文档。

您还可以选择仪表板快速链接以选择指向您配置的任何 New Relic 仪表板的链接。这些链接将在新的浏览器窗口中打开 New Relic 中的仪表板页面。

选择服务名称以在 Postman 中打开一个包含 APM 仪表板的新选项卡。仪表板不断更新：

• Web 事务时间、吞吐量、错误率和 apdex 分数的图表。在图表上选择一个点以显示该时间的准确值。
• 违规事件表、按时间计算的最慢事务和部署。
• 服务仍然健康时的状态。

在仪表板选项卡的顶部，您可以：

• 选择其他服务进行查看。

• 选择在 New Relic 上查看以在新浏览器窗口中打开 New Relic 中的 APM 摘要。

• 为显示的指标选择时间范围。

• 刷新选项卡中的数据。

  

要重新配置与 New Relic 的连接，请选择并选择Edit integration。然后，您可以更改昵称、API 密钥、服务、仪表板或区域。您还可以选择删除集成以删除连接。