有关术语的注意事项

名称、类型、种类、指标和资源等单词出现在与 Cloud Monitoring 相关的组合和上下文,用法不一定始终一致。例如,以下是一些常见模式:

  • 在不同的上下文中,术语指标可能用于指代以下任何内容:

    • 要衡量的一般性“事项”
    • 指标类型
    • 时间序列
    • 与指标类型关联的一组时间序列
    • TimeSeries 结构中嵌入的 Metric 结构
  • 类似于 storage.googleapis.com/api/request_count 的字符串可能会被称为以下任意一项:

    • 指标
    • 指标名称
    • 指标类型
    • 指标类型名称
  • 类似于 gcs_bucket 的字符串可能会被称为以下任何一项:

    • 资源名称1
    • 受监控的资源
    • 受监控的资源类型
    • 受监控的资源名称

1 REST API 参考资料还经常使用术语“资源名称”,通常与受监控的资源无关。资源名称中对此术语进行了更详细的说明。

本部分提供了有关可能会混淆的术语的一些指导。

类型和名称

指标类型和受监控的资源的描述符具有名称和类型。经常可以互换使用这些术语。

例如,字符串 storage.googleapis.com/api/request_count指标类型,但也称为名称或类型名称。

如果您查看此指标类型的描述符,则会看到以下两个键值对:nametype

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

指标描述符中的 type 是一个字符串,用于对有关生成数据的服务(例如 storage.googleapis.com)以及所衡量内容 (api/request_count) 的信息进行编码。

在指标描述符中,name 的值是指标类型的完全限定版本;name 值是以此字符串为前缀的 type 值:

projects/[PROJECT_ID]/metricDescriptors/

类似的模式适用于受监控的资源。type 是某种类型的资源的标签,而 name 由以此字符串为前缀的 type 值组成:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

以下示例对应于受监控的资源列表中的 api 条目:

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

项目中 name 的值完全可以根据 type 的值进行预测,但它们并不完全相同。不过,这些术语经常被随意使用。

指标种类和值类型

还有其他两个术语可能会与“指标类型”混淆:

  • 值类型
  • 指标种类

这些术语不是“指标类型”的替代术语。

“值类型”和“指标种类”描述收集的数据。它们都与编程概念“数据类型”相关。

  • 值类型描述各个值。
  • 指标种类描述这些值之间的相关性。

如需了解详情,请参阅指标种类和类型

资源名称

通过将字符串作为 type(或其他)值的前缀来创建 name 值的模式远远超出指标和受监控的资源类型。它几乎与任何能够创建可唯一标识的数据的内容一样。例如,MetricDescriptorAlertPolicy 都遵循此模式。

参考文档中通常将 name 字段的值描述为“资源名称”:

API 参考中的“资源名称”

以下是一些具有资源名称的结构的示例及其派生方式:

  • 指标描述符:连接前缀和 type 字段的值:
    • 前缀:projects/[PROJECT_ID]/metricDescriptors
    • type(示例):storage.googleapis.com/api/request_count
    • nameprojects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • 受监控的资源描述符:连接前缀和 type 字段的值:
    • 前缀:projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type(示例):api
    • nameprojects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • 提醒政策:连接前缀和所生成 ID 的值
    • 前缀:projects/[PROJECT_ID]/alertPolicies
    • 提醒政策 ID:创建政策时生成的数字
    • nameprojects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

术语“资源名称”是指服务 API 层次结构中的资源,与受监控的资源的概念没有任何关系。如需详细了解 API 设计中的资源名称,请参阅资源名称