Pengantar Cloud Monitoring API

Halaman ini menjelaskan beberapa fitur Cloud Monitoring API v3.

Untuk dokumentasi referensi API, lihat salah satu halaman berikut:

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 dari hal berikut:

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

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

project cakupan cakupan metrik diperlukan

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

cakupan project cakupan metrik tidak diperlukan

Tidak ada metode di metrics API yang memerlukan parameter name untuk merujuk ke project cakupan cakupan metrik, tetapi beberapa metode berperilaku berbeda jika parameter tersebut:

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

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

  • Metode lainnya di API metrik berperilaku sebagai berikut:

    • Jika project yang dinamai bukan project cakupan cakupan metrik, metode tersebut hanya akan mengambil data dari project yang dinamai.
    • Jika project yang diberi nama juga merupakan project cakupan cakupan metrik, metode tersebut akan mengambil data dari project yang diberi nama dan project apa pun yang dipantaunya.

    Metode dalam grup ini adalah sebagai berikut:

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

Untuk informasi tentang cara menyiapkan project Google Cloud sebagai project cakupan 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 dapat mengatur resource cloud menggunakan grup.

Untuk pengantar konsep metrik dan struktur data yang mewakilinya, 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 hardware.

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

Grup resource yang dimonitor

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 informasi selengkapnya, lihat referensi API untuk Group.

Kebijakan pemberitahuan

Kebijakan pemberitahuan adalah resource konfigurasi yang menjelaskan kriteria untuk membuat insiden dan cara memberi tahu Anda saat insiden tersebut dibuat. Konsep pemberitahuan menjelaskan konsep dasar kebijakan pemberitahuan. Untuk 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 Pemantauan di konsol Google Cloud. Untuk informasi selengkapnya, lihat MetricThreshold dalam referensi AlertPolicy.

Saluran notifikasi

Saluran notifikasi adalah resource konfigurasi yang menjelaskan cara memberi tahu Anda saat insiden terjadi. Saluran notifikasi dapat mereferensikan berbagai jenis layanan komunikasi dan endpoint; hal ini ditentukan dalam deskripsi. Deskripsi menentukan kumpulan parameter konfigurasi yang disertakan dalam objek saluran.

Untuk 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.

Pemantauan Layanan menambahkan resource berikut ke Monitoring API:

Untuk informasi selengkapnya tentang konsep pemantauan layanan ini dan cara menggunakan API, lihat Pemantauan SLO.

Dasbor

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

Monitoring Query Language

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

Untuk informasi umum tentang MQL, lihat Menggunakan Bahasa Kueri Monitoring.

Untuk 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 dipantau ke dalam grup. Untuk mengetahui informasi selengkapnya, lihat Filter pemantauan.

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

Langkah berikutnya