Cloud Monitoring API 簡介

這個頁面提供 Cloud Monitoring API v3 部分功能的說明。

如需 API 參考說明文件，請參閱下列任一頁面：

Monitoring API 中的專案名稱

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

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

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

Monitoring API 中的部分方法需要專案做為指標範圍的範圍界定專案，其他方法則不需要。少數方法可能會根據專案類型傳回不同的結果。

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

指標範圍的範圍設定專案 (必要)

凡是不屬於指標 API 的 Monitoring API 方法，都需要使用 name 參數參照指標範圍的範圍界定專案。

指標範圍的限定範圍專案 (非必要)

指標 API 中的任何方法都不需要 name 參數來參照指標範圍的範圍界定專案，但部分方法在有這個參數時，行為會有所不同：

  • 指標 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 參考資料。

服務監控

服務監控資源可用於設定服務等級目標，監控服務的健康狀態。

服務監控會在 Monitoring API 中新增下列資源：

如要進一步瞭解這些服務監控概念，以及如何使用 API，請參閱「SLO 監控」。

資訊主頁

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

Monitoring Query Language

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

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

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

篩選器

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

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

後續步驟