Cloud Monitoring API 简介

本页面介绍 Cloud Monitoring API v3 的一些功能。

有关 API 参考文档，请参阅以下任一页面：

Monitoring API 中的项目名称

Monitoring API 中的所有方法都具有所需的 name 参数。此参数的说明通常如下所示：

必需。在其中执行请求的项目。格式为：
projects/[PROJECT_ID_OR_NUMBER]

在 Monitoring API 中，PROJECT_ID_OR_NUMBER 的值标识以下其中一项：

Monitoring API 中的某些方法要求项目必须是指标范围的范围界定项目；其他方法则不支持。少数方法可能会返回不同的结果，具体取决于项目的类型。

为介绍这些类别的方法，本文使用了术语“Metrics API”来引用 Monitoring API 中的以下资源：

需要指标范围限定的项目

不属于 Metrics API 的所有 Monitoring API 方法都需要 name 参数来引用指标范围的范围界定项目。

不需要指定范围限定的项目

Metrics API 中的任何方法都不需要 name 参数来引用指标范围的范围项目，但部分方法的行为有所不同：

  • Metrics API 中的以下方法会对指定的 Google Cloud 项目进行操作。这些方法仅会影响命名项目中的数据，无论项目是否为指标范围的范围界定项目。

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Metrics API 中其余方法的行为如下所示：

    • 若命名项目不是指标范围的范围界定项目，则方法仅从命名项目中检索数据。
    • 如果命名项目也是指标范围的范围界定项目，则该方法将从已命名项目及其监控的任何项目中检索数据。

    此组中的方法如下：

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

如需了解如何将 Google Cloud 项目设置为指标范围的范围界定项目，请参阅指标范围概览。

API 资源

指标

利用 Monitoring API，您可以从 Google Cloud 和 Amazon Web Services 访问大约 6,500 个 Cloud Monitoring 指标。您可以创建自己的自定义指标，也可以使用组整理云资源。

如需简要了解指标概念以及代表这些概念的数据结构，请参阅指标、时间序列和资源。

如需了解如何管理自定义指标和内置指标，请参阅用户定义的指标概览。

如需查看可用指标的完整列表，请参阅指标列表。

受监控的资源

受监控的资源是关于收集哪些指标的信息。例如，您可能会对虚拟机实例或硬件的活动感兴趣。

如需查看可用受监控的资源的列表，请参阅受监控的资源列表。

受监控的资源组

组是受监控的资源的动态集合。您始终可以在 Google Cloud 控制台中手动创建组，还可以使用 Cloud Monitoring API 编写用于创建和使用组的代码。

如需了解详情，请参阅 Group 的 API 参考文档。

提醒政策

提醒政策是一种配置资源，用于描述生成突发事件的条件以及如何在创建突发事件时通知您。提醒概念介绍了提醒政策的基本概念。如需了解详情，请参阅 AlertPolicy 的 API 参考文档。

该 API 还允许您根据两个指标的比率创建提醒政策。目前无法通过在 Google Cloud 控制台中使用 Monitoring 创建比率。如需了解详情，请参阅 AlertPolicy 参考中的 MetricThreshold。

通知渠道

通知渠道是一种配置资源，用于描述发生突发事件时如何通知您。通知渠道可以引用各种不同类型的通信服务和端点；它们在描述符中指定。描述符用于确定通道对象中包含的一组配置参数。

如需了解详情，请参阅 NotificationChannel 参考 和 NotificationChannelDescriptor 参考。

服务监控

服务监控资源用于设置服务等级目标，该目标可用于监控服务的运行状况。

Service Monitoring 可将以下资源添加到 Monitoring API 中：

如需详细了解这些服务监控概念以及如何使用 API，请参阅 SLO 监控。

信息中心

您可以使用 Dashboards 端点以编程方式创建和操纵信息中心和图表。如需了解如何使用此端点管理信息中心和图表，请参阅通过 API 管理信息中心。

Monitoring Query Language

Monitoring Query Language (MQL) 提供了一个文本界面，用于查询 Cloud Monitoring 时间序列数据。MQL 使用管道型查询模型，比 Monitoring 过滤器更富有表现力。您可以从 Monitoring API 或代码编辑器中使用 MQL 查询。

如需一般性信息，请参阅使用 Monitoring Query Language。

如需了解如何使用 MQL 通过 Monitoring API 检索时间序列数据，请参阅 timeSeries.query 方法的 API 参考文档。

过滤条件

Monitoring API 使用过滤器来选择指标，提取时间序列数据，以及将受监控的资源收集到组中。如需了解详情，请参阅 Monitoring 过滤器。

Monitoring API 还使用过滤器来限制特定 list 操作的结果集。如需详细了解如何管理 alertPolicies.list 和 notificationChannels.list 方法的结果，请参阅排序和过滤。

后续步骤