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 dalam 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]

Dalam 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, tergantung pada jenis project.

Untuk menjelaskan class metode tersebut, diskusi ini menggunakan istilah metrics API untuk merujuk pada referensi berikut dalam Monitoring API:

pencakupan proyek dari ruang lingkup metrik yang diperlukan

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

cakupan project cakupan metrik tidak diperlukan

Tidak ada metode dalam API metrik yang memerlukan parameter name untuk merujuk ke project pencakupan dalam cakupan metrik, tetapi beberapa metode akan berperilaku berbeda jika:

  • Metode berikut dalam Metrics API beroperasi pada project Google Cloud yang dinamai. Metode ini hanya memengaruhi data dalam project yang dinamai, terlepas dari apakah project tersebut juga merupakan project pencakupan dari cakupan metrik.

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

  • Metode yang tersisa di Metrics API berperilaku sebagai berikut:

    • Jika project yang disebutkan bukan merupakan project pencakupan dari cakupan metrik, metode tersebut hanya akan mengambil data dari project yang dinamai tersebut.
    • Jika project yang dinamai tersebut juga merupakan project pencakupan dari cakupan metrik, metode tersebut akan mengambil data dari project yang dinamai tersebut dan semua project 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 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 metrik yang dikumpulkan. Misalnya, Anda mungkin tertarik dengan aktivitas instance VM atau hardware.

Untuk mengetahui daftar resource yang dimonitor, 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 informasi selengkapnya, lihat referensi API untuk Group.

Kebijakan pemberitahuan

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

API juga memungkinkan Anda membuat kebijakan pemberitahuan berdasarkan rasio dua metrik. Saat ini rasio tidak dapat dibuat menggunakan Monitoring 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 dan endpoint komunikasi; keduanya ditentukan dalam descriptors. 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.

Service Monitoring menambahkan resource berikut ke Monitoring API:

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

Dasbor

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

Bahasa Kueri Monitoring

Bahasa Kueri Monitoring (MQL) menyediakan antarmuka berbasis teks untuk membuat kueri data deret waktu Cloud Monitoring. MQL menggunakan model kueri pipe 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 mengetahui informasi tentang cara menggunakan MQL dalam mengambil data deret waktu menggunakan Monitoring API, baca 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 informasi selengkapnya, lihat Filter pemantauan.

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

Langkah berikutnya