Cloud Monitoring API 簡介

Cloud Monitoring API v3 可讓您以程式輔助方式查詢及寫入指標資料、將受監控資源分組，以及管理資訊主頁、警告政策、服務水準目標 (SLO) 和通知管道。如需方法和資源規格，請參閱 Cloud Monitoring API (REST) 和 Cloud Monitoring API (gRPC)。

Monitoring API 中的專案名稱

Monitoring API 中的所有方法都有必要的 name 參數。這個參數通常會有類似以下的說明：

必要，要執行要求的專案。格式如下：
projects/[PROJECT_ID_OR_NUMBER]

在 Monitoring API 中，PROJECT_ID_OR_NUMBER 的值會識別下列其中一項：

Monitoring API 中的某些方法會要求專案必須是指標範圍的範圍設定專案，其他方法則不會。少數方法可能會根據專案類型傳回不同的結果。

為說明這些方法類別，本討論使用「指標 API」一詞，指稱 Monitoring API 中的下列資源：

必須提供指標範圍的範圍界定專案

所有「不屬於」Metrics API 的 Monitoring API 方法，都必須使用 name 參數，參照指標範圍的限定範圍專案。

不需提供指標範圍的範圍界定專案

指標 API 中的方法都不需要 name 參數來參照指標範圍的範圍設定專案，但如果使用該參數，某些方法的行為會有所不同：

  • Metrics API 中的下列方法會對指定的Google Cloud 專案執行操作。這些方法只會影響指定專案中的資料，無論該專案是否為指標範圍的範圍設定專案。

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

  • 指標 API 中的其餘方法運作方式如下：

    • 如果指定專案不是指標範圍的範圍設定專案，則方法只會從指定專案擷取資料。
    • 如果指定專案也是指標範圍的限定範圍專案，這些方法會從指定專案和其監控的所有專案擷取資料。

    這個群組中的方法如下：

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

如要瞭解如何將 Google Cloud 專案設為指標範圍的範圍專案，請參閱「指標範圍總覽」。

API 資源

指標

Monitoring API 可讓您存取Google Cloud 和 Amazon Web Services 的約 6,500 項 Cloud Monitoring 指標。您可以建立自訂指標，並使用群組整理雲端資源。

如要瞭解指標概念和代表指標的資料結構，請參閱「指標、時間序列和資源」。

如要瞭解如何管理自訂指標和內建指標，請參閱「使用者定義指標總覽」。

如需可用指標的完整清單，請參閱「指標清單」。

受監控資源

「受監控資源」是指系統收集指標的對象。舉例來說，您可能對 VM 執行個體或硬體的活動感興趣。

如需可用的受監控資源清單，請參閱「受監控資源清單」。

受監控資源群組

群組是受監控資源的動態集合。您一向可以在 Google Cloud 控制台中手動建立群組，也可以使用 Cloud Monitoring API 編寫程式碼，建立及使用群組。

詳情請參閱 Group 的 API 參考資料。

警告政策

警告政策是一種設定資源，用於描述產生警告的條件，以及在建立警告時如何通知您。警告總覽說明警告政策的基本概念。詳情請參閱 AlertPolicy 的 API 參考資料。

您也可以使用 API，根據兩項指標的比率建立警告政策。目前無法在 Google Cloud 控制台中使用 Monitoring 建立比率。詳情請參閱 AlertPolicy 參考資料中的 MetricThreshold。

通知管道

「通知管道」是設定資源，說明發生警告時如何通知您。通知管道可以參照各種不同類型的通訊服務和端點，這些會在「描述元」中指定。描述元會決定管道物件中包含的設定參數組合。

詳情請參閱 NotificationChannel 參考資料和 NotificationChannelDescriptor 參考資料。

服務監控

服務監控資源可用於設定服務水準目標，以便監控服務健康狀態。

Service Monitoring 會將下列資源新增至 Monitoring API：

如要進一步瞭解這些服務監控概念和 API 的使用方式，請參閱「服務等級目標監控」。

資訊主頁

您可以使用 Dashboards 端點，透過程式輔助方式建立及操控資訊主頁和圖表。如要瞭解如何使用這個端點管理資訊主頁和圖表，請參閱「使用 API 建立及管理資訊主頁」。

Monitoring 查詢語言

Monitoring Query Language (MQL) 提供文字介面，可用於查詢 Cloud Monitoring 時間序列資料。MQL 採用管道查詢模型，比 Monitoring 篩選器更具表達力。您可以透過 Monitoring API 或程式碼編輯器使用 MQL 查詢。

如需 MQL 的一般資訊，請參閱「Monitoring Query Language 總覽」。

如要瞭解如何使用 MQL 透過 Monitoring API 擷取時間序列資料，請參閱 timeSeries.query 方法的 API 參考資料。

篩選器

Monitoring API 會使用篩選器選取指標、擷取時間序列資料，以及將受監控資源分組。詳情請參閱「監控篩選器」。

Monitoring API 也會使用篩選器，限制特定 list 作業的結果集。如要進一步瞭解如何管理 alertPolicies.list 和 notificationChannels.list 方法的結果，請參閱「參考資料：排序和篩選」。

後續步驟