Dokumen ini menjelaskan cara menggunakan Cloud Monitoring API untuk mendapatkan daftar atau deskripsi berikut ini:
- Jenis metrik yang ditentukan pengguna yang ditentukan dalam project Anda.
- Jenis metrik pihak ketiga dengan data deret waktu di project Anda.
Metrik yang dibuat oleh BindPlane
merupakan contoh metrik pihak ketiga. Metrik BindPlane
memiliki awalan
workload.googleapis.com/3rd-party-app-name/
. Untuk mengetahui daftar lengkap metrik aplikasi pihak ketiga yang didukung, lihat dokumentasi Sources BindPlane. - Jenis metrik bawaan yang disediakan oleh Google Cloud. Jenis metrik ini dapat membantu Anda mendesain metrik yang ditentukan pengguna. Anda juga dapat menemukan informasi tentang metrik ini dalam dokumentasi; lihat Daftar metrik.
- Memantau jenis resource yang tersedia untuk project Anda. Anda juga dapat mencari informasi tentang resource ini dalam dokumentasi; lihat Daftar resource yang dimonitor.
Untuk menjalankan metode tanpa menulis kode apa pun, contoh pada tab Protocol di halaman ini menggunakan API Explorer berbasis formulir. (Lihat APIs Explorer untuk informasi selengkapnya tentang alat ini.)
Untuk mempelajari cara menggunakan metode dari bahasa pemrograman yang dipilih, lihat contoh kode yang dapat dijalankan di halaman ini.
Sebelum memulai
- Untuk pengantar metrik dan resource yang dimonitor, lihat Metrik, deret waktu, dan resource.
Mencantumkan deskriptor metrik
Deskripsi metrik adalah skema yang menentukan metrik. Untuk menemukan detail tentang metrik yang Anda minati, jelajahi deskriptor metrik yang tersedia:
- Metrik bawaan: Anda dapat menerbitkan permintaan API ke project yang ada, atau menggunakan dokumentasi Metrics list.
- Metrik eksternal dan yang ditentukan pengguna: Anda harus mengeluarkan permintaan API ke project yang memiliki metrik yang ditentukan pengguna, atau jika data deret waktu untuk metrik tersebut tersedia.
Untuk informasi selengkapnya tentang cara penamaan jenis metrik, lihat Konvensi penamaan.
Mencantumkan jenis metrik
Untuk mendapatkan daftar deskripsi metrik saat ini, gunakan metode metricDescriptors.list
.
Untuk mempersempit kumpulan jenis metrik yang ditampilkan, gunakan filter.
Untuk bantuan dalam menentukan jenis metrik yang akan ditelusuri, lihat Jenis nilai dan jenis metrik.
Protokol
Buka halaman referensi
metricDescriptors.list
.Di panel berlabel Try this method, masukkan perintah berikut:
- nama:
projects/PROJECT_ID
. GantiPROJECT_ID
dengan ID project Google Cloud Anda. - filter:
metric.type = starts_with("compute.googleapis.com")
- nama:
Klik Jalankan.
Contoh respons berikut menampilkan beberapa deskriptor metrik yang diambil:
"metricDescriptors": [ { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_bytes_count", "labels": [{...}], ... "description": "Count of incoming bytes dropped by the firewall.", "displayName": "Dropped bytes", "type": "compute.googleapis.com/firewall/dropped_bytes_count", ... }, { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [{...}], ... "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }, ... ]
Nilai type
di setiap deskripsi mengidentifikasi deskripsi metrik, misalnya, compute.googleapis.com/firewall/dropped_packets_count
. Nilai ini terkadang disebut juga "jenis metrik" atau "nama jenis metrik".
Untuk melihat permintaan sebagai perintah curl
, sebagai permintaan HTTP, atau di JavaScript, klik fullscreen Layar penuh di APIs Explorer.
C#
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Go
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Java
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Node.js
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
PHP
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Python
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Ruby
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Jika Anda mengalami kesulitan, lihat Memecahkan masalah panggilan API.
Mendapatkan deskripsi metrik
Untuk mendapatkan informasi tentang satu jenis metrik, gunakan metode metricDescriptors.get
.
Metode ini menampilkan deskriptor metrik.
Untuk mengambil deskripsi metrik tertentu, Anda harus memberikan nama lengkap metrik ke API. Nama lengkap dibuat dari dua komponen:
- Awalan yang terdiri dari
projects/PROJECT_ID/metricDescriptors
. - Nilai
type
yang mengidentifikasi deskripsi metrik, misalnya,compute.googleapis.com/firewall/dropped_packets_count
. Lihat tab Protocol di List metric types untuk mengetahui informasi selengkapnya tentang nilaitype
.
Berikut adalah contoh nama lengkap metrik:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Protokol
Guna mendapatkan deskripsi untuk metrik /firewall/dropped_packets_count
Compute Engine, lakukan hal berikut:
Buka halaman referensi
metricDescriptors.list
.Di panel berlabel Try this method, masukkan perintah berikut:
nama:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Ganti
PROJECT_ID
dengan ID project Google Cloud Anda.
Klik Jalankan.
Contoh respons berikut menunjukkan deskriptor metrik:
{ "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [ { "key": "instance_name", "description": "The name of the VM instance." } ], "metricKind": "DELTA", "valueType": "INT64", "unit": "1", "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }
Untuk melihat permintaan sebagai perintah curl
, sebagai permintaan HTTP, atau di JavaScript, klik fullscreen Layar penuh di APIs Explorer.
C#
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Go
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Java
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Node.js
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
PHP
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Python
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Ruby
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Jika Anda mengalami kesulitan, lihat Memecahkan masalah panggilan API.
Mencantumkan resource yang dimonitor
Resource yang dimonitor adalah entitas cloud yang dapat dipantau. Untuk menemukan jenis entity yang memiliki metrik, jelajahi daftar jenis resource yang dipantau.
Untuk mendapatkan informasi tentang resource yang dimonitor, Anda dapat mengirimkan permintaan API ke project yang ada, atau menggunakan dokumentasi Daftar resource yang dipantau.
Mencantumkan jenis resource
Untuk mendapatkan daftar jenis resource yang dipantau saat ini dari Monitoring API, gunakan metode monitoredResourceDescriptors.list
dan berikan project ID Anda.
Protokol
Buka halaman referensi
monitoredResourceDescriptors.list
.Di panel berlabel Try this method, masukkan perintah berikut:
- nama:
projects/PROJECT_ID
. GantiPROJECT_ID
dengan ID project Google Cloud Anda.
- nama:
Klik Jalankan.
Contoh respons berikut menunjukkan beberapa jenis resource yang dimonitor yang ditampilkan:
{ "resourceDescriptors": [ { "type": "aiplatform.googleapis.com/Endpoint", "displayName": "AI Platform Endpoint", "description": "A Cloud AI Platform API Endpoint where Models are deployed into it.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Endpoint", }, { "type": "aiplatform.googleapis.com/Featurestore", "displayName": "AI Platform Feature Store", "description": "A Cloud AI Platform Feature Store.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Featurestore", },
Untuk melihat permintaan sebagai perintah curl
, sebagai permintaan HTTP, atau di JavaScript, klik fullscreen Layar penuh di APIs Explorer.
C#
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Go
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Java
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Node.js
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
PHP
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Python
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Ruby
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Jika Anda mengalami kesulitan, lihat Memecahkan masalah panggilan API.
Mendapatkan deskriptor resource
Untuk mendapatkan deskriptor resource yang dipantau, gunakan metode
monitoredResourceDescriptors.get
.
Untuk mengambil deskripsi resource yang dipantau tertentu, Anda harus memberikan nama lengkap deskriptor ke API. Nama lengkap dibuat dari dua komponen:
- Awalan yang terdiri dari
projects/PROJECT_ID/monitoredResourceDescriptors
. - Nilai
type
yang mengidentifikasi deskriptor resource yang dimonitor, misalnya,gce_instance
. Lihat tab Protocol di bagian Membuat daftar jenis resource untuk mengetahui info selengkapnya tentang nilaitype
.
Berikut adalah contoh nama lengkap resource yang dimonitor:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Protokol
Guna mendapatkan deskripsi untuk jenis resource gce_instance
, lakukan hal berikut:
Buka halaman referensi
monitoredResourceDescriptors.get
.Di panel berlabel Try this method, masukkan perintah berikut:
nama:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Ganti
PROJECT_ID
dengan ID project Google Cloud Anda.
Klik Jalankan.
Contoh respons berikut menunjukkan deskripsi resource yang dimonitor ini:
{ "type": "gce_instance", "displayName": "VM Instance", "description": "A virtual machine instance hosted in Compute Engine.", "labels": [ { "key": "project_id", "description": "The identifier of the Google Cloud project associated with this resource, such as \"my-project\"." }, { "key": "instance_id", "description": "The numeric VM instance identifier assigned by Compute Engine." }, { "key": "zone", "description": "The Compute Engine zone in which the VM is running." } ], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance" }
Untuk melihat permintaan sebagai perintah curl
, sebagai permintaan HTTP, atau di JavaScript, klik fullscreen Layar penuh di APIs Explorer.
C#
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Go
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Java
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Node.js
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
PHP
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Python
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Ruby
Untuk mengautentikasi ke Monitoring, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Jika Anda mengalami kesulitan, lihat Memecahkan masalah panggilan API.
Langkah selanjutnya
- Untuk informasi tentang cara menggunakan Cloud Monitoring API untuk membaca data deret waktu, lihat Mengambil data deret waktu.
- Untuk daftar jenis resource yang dipantau yang tersedia untuk digunakan dengan metrik yang ditentukan pengguna, lihat Memilih jenis resource yang dipantau.