術語注意事項

區分「名稱」、「類型」、「種類」、「指標」和「資源」等重疊詞彙,有助於您解讀 Cloud Monitoring 說明文件,並在 Cloud Monitoring API 要求中提供正確的欄位。一般使用時,往往會模糊指標類型、受監控資源類型、值類型、指標種類和 API 資源名稱之間的差異。

常見的重疊字詞

以下範例說明如何根據情境,交替使用 Monitoring 術語和 ID:

  • 在不同情境下,「指標」一詞可能指下列任一項目:

    • 要評估的一般「項目」
    • 指標類型
    • 時間序列
    • 與指標類型相關聯的一組時間序列
    • 嵌入 TimeSeries 結構的 Metric 結構
  • storage.googleapis.com/api/request_count 這類字串可能稱為下列任一項:

    • 指標
    • 指標名稱
    • 指標類型
    • 指標類型名稱
  • gcs_bucket 這類字串可能稱為下列任一項:

    • 資源名稱1
    • 受監控資源
    • 受監控資源類型
    • 受監控資源名稱

1 REST API 參考資料也經常使用「資源名稱」一詞,這通常與受監控資源無關。如要進一步瞭解這個詞彙,請參閱「資源名稱」一節。

本文其餘部分將針對可能令人混淆的術語提供一些指引。

類型和名稱

指標類型和受監控資源的描述元都有名稱和類型。在日常使用中,這兩個詞通常可以互換。

舉例來說,字串 storage.googleapis.com/api/request_count 是「指標類型」,但也稱為名稱或類型名稱。

如果查看這個指標類型的描述元,會看到 name 和 type 這兩個鍵/值組合:

{
  "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 值的模式,不限於指標和受監控資源類型。幾乎所有會建立可明確識別身分資料的項目,都會顯示這項資訊。例如,MetricDescriptor 和 AlertPolicy 都遵循這個模式。

name 欄位的值通常在參考文件中稱為「資源名稱」:

API 參考資料中的資源名稱

以下列舉一些具有資源名稱的結構,以及這些名稱的衍生方式:

  • 指標描述元:彙整前置字元和 type 欄位的值:
    • 前置字串:projects/[PROJECT_ID]/metricDescriptors
    • type (範例):storage.googleapis.com/api/request_count
    • name:projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • 受監控資源描述元:合併前置字元和 type 欄位的值:
    • 前置字串:projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type (範例):api
    • name:projects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • 警告政策:將前置字串和產生的 ID 值合併:
    • 前置字串:projects/[PROJECT_ID]/alertPolicies
    • 警告政策 ID:建立政策時產生的數字
    • name:projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

「資源名稱」一詞是指服務 API 階層中的資源,與受監控資源的概念完全無關。如要進一步瞭解 API 設計中的資源名稱,請參閱「資源名稱」。