Mengelola monitor sintetis

Dokumen ini menjelaskan cara mengelola monitor sintetis Anda. Anda dapat melihat daftar monitor sintetis, dan untuk setiap monitor sintetis, Anda dapat melihat dan mengubah konfigurasi, melihat histori eksekusi, dan melihat detail tentang setiap eksekusi. Anda dapat mengelola monitor sintetis menggunakan konsol Google Cloud atau menggunakan Cloud Monitoring API.

Untuk mengetahui informasi tentang cara menjelajahi hasil eksekusi serta metrik dan log untuk monitor sintetis, lihat Menjelajahi hasil monitor sintetis.

Fitur ini hanya didukung untuk project Google Cloud . Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

Sebelum memulai

Selesaikan langkah-langkah berikut di project Google Cloud yang menyimpan monitor sintetis Anda:

  • Untuk mendapatkan izin yang diperlukan untuk melihat dan mengubah monitor sintetis menggunakan Google Cloud konsol, minta administrator untuk memberi Anda peran IAM berikut di project Anda:

    Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

    Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

  • Petunjuk API di halaman ini ditujukan untuk APIs Explorer. Namun, Anda juga dapat mengeluarkan perintah curl. APIs Explorer menyediakan sintaksis curl.

  • Pilih antarmuka yang akan Anda gunakan:

    Konsol

    Saat menggunakan konsol Google Cloud untuk mengakses layanan Google Cloud dan API, Anda tidak perlu menyiapkan autentikasi.

    gcloud

    Di konsol Google Cloud , aktifkan Cloud Shell.

    Aktifkan Cloud Shell

    Di bagian bawah konsol Google Cloud , sesi Cloud Shell akan dimulai dan menampilkan perintah command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi pada sesi.

    REST

    Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.

      Instal Google Cloud CLI.

      Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

    Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam dokumentasi autentikasi Google Cloud .

Mencantumkan monitor sintetis

Konsol

Untuk mencantumkan monitor sintetis di project Google Cloud Anda, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Pemantauan sintetis:

    Buka Pemantauan sintetis

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

  3. Opsional: Untuk membatasi monitor sintetis yang tercantum, tambahkan filter.

    Setiap filter terdiri dari nama dan nilai. Anda dapat menyetel nilai agar cocok persis dengan nama monitor sintetis atau cocok sebagian. Kecocokan tidak peka huruf besar/kecil. Misalnya, untuk mencantumkan semua monitor sintetis yang namanya berisi default, lakukan hal berikut:

    • Klik Filter tabel, lalu pilih Nama tampilan.
    • Masukkan default, lalu tekan tombol kembali.

    Jika Anda memiliki beberapa filter, filter tersebut akan otomatis digabungkan dengan AND logis kecuali jika Anda menyisipkan filter OR. Contoh sebelumnya menggunakan filter OR sehingga pemeriksaan uptime akan dicantumkan jika namanya cocok dengan default atau Testing check.

Halaman Monitor sintetis menampilkan hal berikut untuk setiap monitor sintetis:

  • Status eksekusi terbaru.
  • Link ke informasi mendetail tentang monitor sintetis tersebut.
  • Rasio keberhasilan dan waktu eksekusi rata-rata.
  • Jumlah kebijakan pemberitahuan.
  • Untuk mengedit, menyalin, atau menghapus monitor sintetis, dan untuk membuat kebijakan pemberitahuan, gunakan menu Opsi lainnya.

gcloud

Untuk mencantumkan cek uptime dan monitor sintetis, jalankan perintah gcloud monitoring uptime list-configs:

gcloud monitoring uptime list-configs --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

Data yang ditampilkan mencakup hal berikut:

  • Nama dan nama tampilan.
  • Periksa ID.
  • Resource yang dimonitor.
  • Periode antar-pemeriksaan.

Anda dapat mengonfigurasi perintah Google Cloud CLI untuk memfilter dan mengurutkan hasil.

REST

Untuk mencantumkan monitor sintetis dalam project Google Cloud Anda, termasuk pemeriksaan uptime, panggil metode projects.uptimeCheckConfigs.list:

  1. Klik projects.uptimeCheckConfigs.list.

  2. Gunakan APIs Explorer.

    Tetapkan parent metode ke nama project, pastikan Anda menggunakan format berikut:

    projects/PROJECT_ID

    Dalam ekspresi sebelumnya, PROJECT_ID adalah ID project Google Cloud Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

Untuk monitor sintetis, hasilnya berisi kolom berlabel syntheticMonitor.

Melihat detail monitor sintetis

Konsol

Untuk melihat detail pemantau sintetis di project Google Cloud Anda, lakukan langkah-langkah berikut:

  1. Di konsol Google Cloud , buka halaman  Pemantauan sintetis:

    Buka Pemantauan sintetis

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

  3. Untuk membuka halaman Detail monitor sintetis, temukan monitor sintetis yang ingin Anda lihat, lalu klik namanya.

    Jika Anda ingin melihat fungsi Cloud Run dari halaman Function details yang disediakan oleh Cloud Run Functions, pilih tab Code, lalu klik nama fungsi. Halaman Functions details akan terbuka di jendela baru. Tab di halaman ini memungkinkan Anda melihat metrik dan log, serta informasi konfigurasi.

gcloud

Untuk mencantumkan detail pemeriksaan uptime atau monitor sintetis, jalankan perintah gcloud monitoring uptime describe:

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.
  • CHECK_ID: ID pemeriksaan waktu aktif atau monitor sintetis. Anda dapat menemukan ID dengan menjalankan perintah gcloud monitoring uptime list-configs dan memeriksa kolom name. Untuk mengetahui informasi selengkapnya, lihat Menemukan ID unik pemantau sintetis.

Data yang ditampilkan untuk pemeriksaan uptime mencakup hal berikut:

  • Nama dan nama tampilan.
  • Periksa ID.
  • Resource yang dimonitor.
  • Periode antar-pemeriksaan.

REST

Untuk mencantumkan detail pemantau sintetis tertentu di Google Cloud project Anda, panggil metode projects.uptimeCheckConfigs.get:

  1. Klik projects.uptimeCheckConfigs.get.

  2. Gunakan APIs Explorer.

    Tetapkan parent metode ke ID monitor sintetis, pastikan Anda menggunakan format berikut:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    Dalam ekspresi sebelumnya:

    • PROJECT_ID adalah Google Cloud project ID Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.
    • CHECK_ID adalah ID monitor sintetis.

    Misalnya, nilai kolom induk mungkin:

    projects/my-project/uptimeCheckConfigs/10863117100295372627

    Untuk menemukan nilai CHECK_ID, Anda dapat mengeluarkan metode projects.uptimeCheckConfigs.list. Untuk mengurangi jumlah hasil yang ditampilkan, sertakan filter. Misalnya, tambahkan filter displayName="MySyntheticMonitor".

Mengedit pemantauan sintetis atau Cloud Run Function

Konsol

Untuk mengedit pemantau sintetis atau fungsi Cloud Run-nya menggunakan halaman Detail pemantau sintetis, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Pemantauan sintetis:

    Buka Pemantauan sintetis

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.
  3. Cari monitor sintetis yang ingin Anda edit, klik Opsi lainnya, lalu pilih Edit.

  4. Opsional: Untuk mengedit fungsi Cloud Run, klik Edit fungsi, buat perubahan, lalu klik Terapkan fungsi.

    Untuk pemeriksa link rusak, guna mengubah URI asal atau opsi yang menentukan link mana yang diuji, edit fungsi Cloud Run, lalu perbarui objek options dalam file index.js. Untuk mengetahui informasi tentang kolom dan sintaksis untuk objek ini, lihat broken-links-ok/index.js.

  5. Untuk mempertahankan modifikasi Anda, klik Simpan. Jika tidak, klik Batal.

gcloud

Untuk mengubah cek uptime atau monitor sintetis, jalankan perintah gcloud monitoring uptime update:

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

  • CHECK_ID: ID pemeriksaan uptime atau monitor sintetis. Anda dapat menemukan ID dengan menjalankan perintah gcloud monitoring uptime list-configs dan memeriksa kolom name. Untuk mengetahui informasi selengkapnya, lihat Menemukan ID unik pemeriksaan uptime.

  • Tentukan kolom yang ingin Anda ubah. Untuk monitor sintetis, Anda hanya dapat memperbarui kolom berikut:

    • Periode
    • Nama tampilan
    • Waktu habis
    • Label pengguna

Misalnya, untuk menyetel periode monitor sintetis menjadi 10 menit, jalankan perintah berikut:

gcloud monitoring uptime update CHECK_ID --period=10 --project=PROJECT_ID

REST

Kebijakan dan fungsi pemberitahuan tidak tercakup dalam monitor sintetis, dan oleh karena itu, tidak dapat diedit dengan prosedur yang dijelaskan di bagian ini:

Untuk mengedit monitor sintetis, panggil metode projects.uptimeCheckConfigs.patch:

  1. Klik projects.uptimeCheckConfigs.patch.

  2. Gunakan APIs Explorer.

    1. Tetapkan parent metode ke ID monitor sintetis, ID memiliki format berikut:

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

      Dalam ekspresi sebelumnya:

      • PROJECT_ID adalah project ID Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.
      • CHECK_ID adalah ID monitor sintetis.

      Untuk menemukan nilai CHECK_ID, Anda dapat mengeluarkan metode projects.uptimeCheckConfigs.list. Untuk mengurangi jumlah hasil yang ditampilkan, sertakan filter. Misalnya, tambahkan filter displayName="MySyntheticMonitor".

    2. Tetapkan parameter kueri metode, updateMask, untuk mengidentifikasi kolom mana dalam objek yang sedang diubah. Misalnya, untuk memperbarui nilai displayName, parameter kuerinya adalah sebagai berikut:

      updateMask=displayName

Menyalin monitor sintetis

Konsol

Untuk menyalin pemantau sintetis di project Google Cloud Anda, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Pemantauan sintetis:

    Buka Pemantauan sintetis

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

  3. Cari monitor sintetis yang ingin Anda edit, klik Opsi lainnya, lalu pilih Salin.

    Dialog Copy Synthetic Check akan terbuka dengan kolom yang telah diisi sebelumnya, termasuk salinan fungsi Cloud Run.

  4. Klik Buat fungsi, perbarui fungsi sesuai kebutuhan, lalu klik Terapkan fungsi.

  5. Untuk mempertahankan modifikasi Anda, klik Buat. Jika tidak, klik Batal.

    Saat Anda mengklik Create, fungsi Cloud Run Anda akan dibuat dan di-deploy, lalu monitor sintetis akan dibuat.

gcloud

Tidak ada metode Google Cloud CLI yang memungkinkan Anda menyalin monitor sintetis.

REST

Tidak ada metode API yang memungkinkan Anda menyalin monitor sintetis. Namun, Anda dapat membuat salinan dengan melakukan langkah-langkah berikut:

  1. Panggil metode projects.uptimeCheckConfigs.get dan simpan responsnya. Untuk mengetahui informasi selengkapnya, lihat Melihat detail pemantau sintetis.
  2. Edit respons.
  3. Panggil metode projects.uptimeCheckConfigs.create dan teruskan respons yang telah diedit ke metode tersebut.

Menghapus monitor sintetis

Konsol

Untuk menghapus monitor sintetis dan kebijakan pemberitahuan terkait, lakukan langkah-langkah berikut:

  1. Di konsol Google Cloud , buka halaman  Pemantauan sintetis:

    Buka Pemantauan sintetis

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.

  3. Cari monitor sintetis yang ingin Anda hapus, lalu klik namanya.

  4. Opsional: Jika Anda ingin menghapus fungsi Cloud Run, pilih tab Code, lalu klik nama fungsi. Halaman Functions details akan terbuka di jendela baru.

  5. Di halaman Synthetic monitor details, klik Hapus , lalu selesaikan dialog.

    Anda telah menghapus monitor sintetis.

  6. Untuk menghapus fungsi Cloud Run, buka halaman Function details, klik Delete, lalu selesaikan dialog.

gcloud

Untuk menghapus pemeriksaan uptime atau monitor sintetis, jalankan perintah gcloud monitoring uptime delete:

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

Sebelum menjalankan perintah sebelumnya, ganti perintah berikut:

  • PROJECT_ID: ID project. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.
  • CHECK_ID: ID pemeriksaan waktu aktif atau monitor sintetis. Anda dapat menemukan ID dengan menjalankan perintah gcloud monitoring uptime list-configs dan memeriksa kolom name. Untuk mengetahui informasi selengkapnya, lihat Menemukan ID unik pemantau sintetis.

REST

Untuk menghapus monitor sintetis dan kebijakan pemberitahuan terkait, panggil metode projects.uptimeCheckConfigs.delete:

  1. Klik projects.uptimeCheckConfigs.delete.

  2. Gunakan APIs Explorer.

    Tetapkan parent metode ke ID monitor sintetis, pastikan Anda menggunakan format berikut:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    Dalam ekspresi sebelumnya:

    • PROJECT_ID adalah project ID Anda. Untuk konfigurasi Pusat Aplikasi, pilih project host Pusat Aplikasi atau project pengelolaan.
    • CHECK_ID adalah ID monitor sintetis.

    Untuk menemukan nilai CHECK_ID, Anda dapat mengeluarkan metode projects.uptimeCheckConfigs.list. Untuk mengurangi jumlah hasil yang ditampilkan, sertakan filter. Misalnya, tambahkan filter displayName="MySyntheticMonitor".

Menemukan ID unik monitor sintetis

Saat monitor sintetis Anda dibuat, Monitoring akan menetapkan ID untuk monitor tersebut. ID ini disematkan dalam nama resource untuk monitor sintetis dan memiliki bentuk:

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

CHECK_ID disertakan dalam respons metode Google Cloud CLI dan Cloud Monitoring API yang membuat atau mencantumkan monitor sintetis.

Langkah berikutnya