指標命名慣例

本文說明 Cloud Monitoring 對指標強制執行的命名慣例。

指標資源名稱

指標類型的資源名稱包含三個主要子結構的字串：

  • 特定專案的 ID。
  • 標記，一律設為 metricDescriptors，表示字串代表指標描述元。
  • 指標類型。

指標類型的資源名稱遵循下列模式：

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

子字串 METRIC_TYPE 是代表指標類型的 ID。例如：

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 的 VM 執行個體上執行的 Monitoring 和 Logging 代理程式指標。如需這些指標的完整清單，請參閱「代理程式指標」。
kubernetes.io/anthos/PATH 2 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 個標籤。