Pengantar Cloud Monitoring API

Cloud Monitoring API v3 memungkinkan Anda membuat kueri dan menulis data metrik secara terprogram, mengatur resource yang dipantau ke dalam grup, serta mengelola dasbor, kebijakan pemberitahuan, tujuan tingkat layanan (SLO), dan saluran notifikasi. Untuk spesifikasi metode dan resource, lihat Cloud Monitoring API (REST) dan Cloud Monitoring API (gRPC).

Nama project di Monitoring API

Semua metode di Monitoring API memiliki parameter name yang diperlukan. Parameter ini biasanya memiliki deskripsi seperti berikut:

Wajib diisi. Project tempat permintaan akan dijalankan. Formatnya adalah:
projects/[PROJECT_ID_OR_NUMBER]

Di Monitoring API, nilai PROJECT_ID_OR_NUMBER mengidentifikasi salah satu hal berikut:

Beberapa metode di Monitoring API mengharuskan project menjadi project pencakupan dari cakupan metrik; metode lainnya tidak. Sejumlah kecil metode dapat menampilkan hasil yang berbeda, bergantung pada jenis project.

Untuk menjelaskan class metode ini, pembahasan ini menggunakan istilah metrics API untuk merujuk ke resource berikut di Monitoring API:

Project pencakupan dari cakupan metrik diperlukan

Semua metode Monitoring API yang bukan bagian dari metrics API memerlukan parameter name untuk merujuk ke project pencakupan dari cakupan metrik.

Project pencakupan dari cakupan metrik tidak diperlukan

Tidak ada metode dalam metrics API yang memerlukan parameter name untuk merujuk ke project pencakupan dari cakupan metrik, tetapi beberapa metode berperilaku berbeda saat parameter tersebut merujuk ke project pencakupan:

  • Metode berikut dalam metrics API beroperasi pada projectGoogle Cloud yang diberi nama. Metode ini hanya memengaruhi data dalam project yang disebutkan, terlepas dari apakah project tersebut juga merupakan project pencakupan dari cakupan metrik.

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

  • Metode lainnya di API metrik berperilaku sebagai berikut:

    • Jika project yang disebutkan bukan project pencakupan dari cakupan metrik, metode ini hanya akan mengambil data dari project yang disebutkan.
    • Jika project yang disebutkan juga merupakan project pencakupan dari cakupan metrik, metode tersebut akan mengambil data dari project yang disebutkan dan project apa pun yang dipantaunya.

    Metode dalam grup ini adalah sebagai berikut:

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

Untuk mengetahui informasi tentang cara menyiapkan project Google Cloud sebagai project pencakupan dari cakupan metrik, lihat Ringkasan cakupan metrik.

Resource API

Metrik

Monitoring API memberi Anda akses ke sekitar 6.500 metrik Cloud Monitoring dari Google Cloud dan Amazon Web Services. Anda dapat membuat metrik kustom sendiri dan mengatur resource cloud menggunakan grup.

Untuk pengantar konsep metrik dan struktur data yang merepresentasikannya, lihat Metrik, deret waktu, dan resource.

Untuk mempelajari cara mengelola metrik kustom dan metrik bawaan, lihat Ringkasan metrik yang ditentukan pengguna.

Untuk mengetahui daftar lengkap metrik yang tersedia, lihat Daftar metrik.

Resource yang dimonitor

Resource yang dimonitor adalah sesuatu yang metriknya dikumpulkan. Misalnya, Anda mungkin tertarik dengan aktivitas instance VM atau perangkat keras.

Untuk mengetahui daftar resource yang dimonitor yang tersedia, lihat Daftar resource yang dimonitor.

Grup resource yang dipantau

Grup adalah kumpulan dinamis resource yang dimonitor. Anda selalu dapat membuat grup secara manual di konsol Google Cloud , dan Anda juga dapat menggunakan Cloud Monitoring API untuk menulis kode yang membuat dan menggunakan grup.

Untuk mengetahui informasi selengkapnya, lihat referensi API untuk Group.

Kebijakan pemberitahuan

Kebijakan pemberitahuan adalah resource konfigurasi yang menjelaskan kriteria untuk membuat pemberitahuan dan cara memberi tahu Anda saat pemberitahuan tersebut dibuat. Ringkasan pemberitahuan menjelaskan konsep dasar kebijakan pemberitahuan. Untuk mengetahui informasi selengkapnya, lihat referensi API untuk AlertPolicy.

API ini juga memungkinkan Anda membuat kebijakan pemberitahuan berdasarkan rasio dua metrik. Rasio saat ini tidak dapat dibuat menggunakan Monitoring di konsol Google Cloud . Untuk mengetahui informasi selengkapnya, lihat MetricThreshold di referensi AlertPolicy.

Saluran notifikasi

Saluran notifikasi adalah resource konfigurasi yang menjelaskan cara memberi tahu Anda saat pemberitahuan terjadi. Saluran notifikasi dapat merujuk ke berbagai jenis layanan komunikasi dan endpoint; hal ini ditentukan dalam deskriptor. Deskripsi menentukan set parameter konfigurasi yang disertakan dalam objek saluran.

Untuk mengetahui informasi selengkapnya, lihat referensi NotificationChannel dan referensi NotificationChannelDescriptor.

Pemantauan layanan

Resource pemantauan layanan digunakan untuk menyiapkan tujuan tingkat layanan yang dapat digunakan untuk memantau kondisi layanan Anda.

Service Monitoring menambahkan resource berikut ke Monitoring API:

Untuk mengetahui informasi selengkapnya tentang konsep pemantauan layanan ini dan tentang penggunaan API, lihat Pemantauan SLO.

Dasbor

Anda dapat membuat dan memanipulasi dasbor dan diagram secara terprogram menggunakan endpoint Dashboards. Untuk mengetahui informasi tentang cara menggunakan endpoint ini untuk mengelola dasbor dan diagram, lihat Membuat dan mengelola dasbor menggunakan API.

Monitoring Query Language

Monitoring Query Language (MQL) menyediakan antarmuka berbasis teks untuk mengkueri data deret waktu Cloud Monitoring. MQL menggunakan model kueri yang di-pipe dan lebih ekspresif daripada filter Monitoring. Anda dapat menggunakan kueri MQL dari Monitoring API atau dari editor kode.

Untuk mengetahui informasi umum tentang MQL, lihat Ringkasan Monitoring Query Language.

Untuk mengetahui informasi tentang cara menggunakan MQL untuk mengambil data deret waktu menggunakan Monitoring API, lihat referensi API untuk metode timeSeries.query.

Filter

Monitoring API menggunakan filter untuk memilih metrik, mengambil data deret waktu, dan mengumpulkan resource yang dimonitor ke dalam grup. Untuk mengetahui informasi selengkapnya, lihat Filter pemantauan.

Monitoring API juga menggunakan filter untuk membatasi kumpulan hasil operasi list tertentu. Lihat Referensi: Mengurutkan dan memfilter untuk mengetahui detail tentang cara mengelola hasil metode alertPolicies.list dan notificationChannels.list.

Langkah berikutnya