指标命名惯例

本文档介绍了 Cloud Monitoring 对指标强制执行的命名惯例。

指标资源名称

指标类型的资源名称由一个字符串和三个主要子结构组成：

  • 特定项目的标识符
  • 始终设置为 metricDescriptors 的标记，用于指示字符串表示指标描述符。
  • 指标类型。

指标类型的资源名称遵循以下模式：

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

子字符串 METRIC_TYPE 是一个表示指标类型的标识符。它有多种格式，例如：

agent.googleapis.com/agent/api_request_count
compute.googleapis.com/firewall/dropped_bytes_count
istio.io/service/client/received_bytes_count
kubernetes.io/anthos/APIServiceOpenAPIAggregationControllerQueue1_adds

在指标描述符中，name 字段存储指标类型的资源名称，而 type 字段存储 METRIC_TYPE 子字符串。

下表显示了如何解析资源名称中包含的 METRIC_TYPE 子字符串：

可能的结构 说明
SERVICE_NAME 1.googleapis.com/PATH 2 来自 Google Cloud 产品和服务的指标。如需查看这些指标的完整列表，请参阅 Google Cloud 指标。
agent.googleapis.com/SERVICE_NAME 1/PATH 2 来自 Google Cloud 或 AWS 虚拟机实例上运行的 Monitoring 和 Logging 代理的指标。如需查看这些指标的完整列表，请参阅代理指标。
kubernetes.io/anthos/PATH 2 GKE Enterprise 中的指标，GKE Enterprise 是一项 Google Cloud 服务，可用于在本地和云端运行 Kubernetes 集群。如需查看这些指标的完整列表，请参阅 Anthos 指标。
aws.googleapis.com/SERVICE_NAME 1/PATH 2 来自 Amazon Web Services 的指标。如需查看这些指标的完整列表，请参阅 AWS 指标。
istio.io/PATH 2 来自 Istio for Google Cloud 的指标。如需查看这些指标的完整列表，请参阅 Istio 指标。
kubernetes.io/PATH 2 来自 Google Kubernetes Engine 的指标。如需查看这些指标的完整列表，请参阅 Kubernetes 指标。
knative.dev/PATH 2 来自 Knative 的指标。如需查看这些指标的完整列表，请参阅 Knative 指标。
external.googleapis.com/EXT_SERVICE/PATH 2
external.googleapis.com/prometheus/PATH 2		 诸如 Prometheus 之类的第三方自定义指标。此开源监控工具通常与 Kubernetes 一起使用。如需详细了解这些指标，请参阅外部指标。这些指标类型只能在定义这些指标的项目中使用。
custom.googleapis.com/PATH 2
external.googleapis.com/user/PATH 2		 用户定义的指标。 这些指标类型只能在定义这些指标的项目中使用。
logging.googleapis.com/PATH 2 来自 Cloud Logging 的基于日志的指标。您可以使用预定义指标，也可以创建自定义指标。自定义指标只能在定义这些指标的项目中使用。

1 SERVICE_NAME 标识 Google Cloud 产品，例如 Compute Engine 的 compute。
2 PATH 标识产品中的指标，例如 instance/cpu/utilization。

指标类型和标签的规则

此列表包含创建自定义指标类型时要遵循的规则。与指标类型关联的标签被指定为 LabelDescriptor 类型的键值对。键用作标签的名称。

  • 指标类型

    • 在字符串中使用大小写字母（A-Z、a-z）、数字 (0-9)、句点 (.) 和下划线 (_)。
    • 使用正斜杠 (/) 分隔路径元素。
    • 您必须使用字母或数字作为每个路径元素的开头。
    • 指标类型字符串的长度上限为 200 个字符。

  • 标签键

    • 在标签键中使用小写字母 (a-z)、数字 (0-9) 和下划线 (_)。
    • 标签键必须以字母开头。
    • 标签键的长度上限为 100 个字符。
    • 每个键在指标类型中必须是唯一的。
    • 每个指标类型最多只能有 30 个标签。