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 篩選器更具表達力。您可以透過 Monitoring API 或程式碼編輯器使用 MQL 查詢。

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

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

篩選器

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

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

後續步驟