Catatan tentang terminologi

Membedakan istilah yang tumpang-tindih seperti name, type, kind, metric, dan resource akan membantu Anda menafsirkan dokumentasi Cloud Monitoring dan menyediakan kolom yang tepat dalam permintaan Cloud Monitoring API. Penggunaan biasa sering kali mengaburkan perbedaan antara jenis metrik, jenis resource yang dimonitor, jenis nilai, jenis metrik, dan nama resource API.

Istilah umum yang tumpang-tindih

Contoh berikut menggambarkan bagaimana istilah dan ID Monitoring sering digunakan secara bergantian, bergantung pada konteksnya:

• Istilah metrik dapat digunakan, dalam konteks yang berbeda, untuk merujuk ke salah satu hal berikut:

  • “Sesuatu” yang umum untuk diukur
  • Jenis metrik
  • Deret waktu
  • Kumpulan deret waktu yang terkait dengan jenis metrik
  • Struktur Metric yang disematkan dalam struktur TimeSeries

• String seperti storage.googleapis.com/api/request_count dapat disebut sebagai salah satu dari berikut:

  • Metrik
  • Nama metrik
  • Jenis metrik
  • Nama jenis metrik

• String seperti gcs_bucket dapat disebut sebagai salah satu dari berikut:

  • Nama resource¹
  • Resource yang dimonitor
  • Jenis resource yang dimonitor
  • Nama resource yang dimonitor

¹ Referensi API REST juga sering menggunakan istilah nama resource, yang biasanya tidak ada hubungannya dengan resource yang dimonitor. Istilah ini dijelaskan secara lebih mendetail di Nama resource.

Bagian selanjutnya dari dokumen ini memberikan beberapa panduan tentang terminologi yang mungkin membingungkan.

Jenis dan nama

Deskriptor untuk jenis metrik dan resource yang dimonitor memiliki nama dan jenis. Dalam penggunaan sehari-hari, kedua istilah ini sering digunakan secara bergantian.

Misalnya, string storage.googleapis.com/api/request_count adalah jenis metrik, meskipun juga disebut sebagai nama atau nama jenis.

Jika melihat deskriptor untuk jenis metrik ini, Anda akan melihat dua pasangan nilai kunci ini, name dan type:

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

type dalam deskriptor metrik adalah string yang mengenkode informasi tentang layanan yang menghasilkan data (misalnya, storage.googleapis.com) dan apa yang diukur (api/request_count).

Dalam deskriptor metrik, nilai kolom name adalah versi jenis metrik yang sepenuhnya memenuhi syarat; nilai name adalah nilai type yang diawali dengan string ini:

projects/[PROJECT_ID]/metricDescriptors/

Pola serupa berlaku untuk resource yang dimonitor. type adalah label untuk beberapa jenis resource, dan name terdiri dari nilai type yang diawali dengan string ini:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

Contoh berikut sesuai dengan entri api dalam daftar resource yang dimonitor:

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

Nilai name dalam sebuah project sepenuhnya dapat diprediksi dari nilai type, tetapi keduanya tidak sama persis. Namun, istilah ini sering digunakan secara tidak tepat dalam diskusi santai.

Poin Penting: Di hampir semua kasus, penggunaan “jenis metrik”, “nama metrik”, atau “nama jenis metrik” mengacu pada jenis metrik seperti yang dijelaskan di sini. Kata “metrik” biasanya berarti deret waktu yang terkait dengan jenis metrik. Frasa “resource yang dimonitor” biasanya berarti jenis atau entitas fisik tertentu yang dijelaskan oleh suatu jenis.

Jenis metrik dan jenis nilai

Ada dua istilah lain yang dapat membingungkan dengan “jenis metrik”:

• Jenis nilai
• Jenis metrik

Istilah ini bukan istilah alternatif untuk “jenis metrik”.

“Jenis nilai” dan “jenis metrik” menjelaskan data yang dikumpulkan. Keduanya terkait dengan konsep pemrograman “jenis data”.

• Jenis nilai menjelaskan nilai individual.
• Jenis metrik menjelaskan keterkaitan nilai satu sama lain.

Lihat Jenis nilai dan jenis metrik untuk mengetahui detailnya.

Nama resource

Pola pembuatan nilai name dengan menambahkan awalan string ke nilai type (atau lainnya) melampaui jenis metrik dan resource yang dimonitor. ID ini muncul dengan hampir semua hal yang membuat data yang dapat diidentifikasi secara unik. Misalnya, MetricDescriptor dan AlertPolicy mengikuti pola ini.

Nilai kolom name sering dijelaskan dalam dokumentasi referensi sebagai “nama resource”:

Berikut beberapa contoh struktur yang memiliki nama resource dan cara turunannya:

• Deskriptor metrik: gabungkan nilai awalan dan kolom type:
  • Awalan: projects/[PROJECT_ID]/metricDescriptors
  • type (contoh): storage.googleapis.com/api/request_count
  • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
• Deskripsi resource yang dimonitor: gabungkan nilai awalan dan kolom type:
  • Awalan: projects/[PROJECT_ID]/monitoredResourceDescriptors
  • type (contoh): api
  • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
• Kebijakan pemberitahuan: gabungkan nilai awalan dan ID yang dihasilkan:
  • Awalan: projects/[PROJECT_ID]/alertPolicies
  • ID kebijakan pemberitahuan: angka yang dihasilkan saat kebijakan dibuat
  • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

Istilah “nama resource” mengacu pada resource dalam hierarki API layanan dan tidak terkait dengan konsep resource yang dimonitor dengan cara apa pun. Untuk mengetahui informasi selengkapnya tentang nama resource dalam desain API, lihat Nama resource.

Poin Penting: Di Cloud Monitoring API, jika kolom name dideskripsikan sebagai “nama resource”, nilai untuk kolom tersebut adalah ID yang sepenuhnya memenuhi syarat yang dibuat dengan mengambil nilai type (atau kolom lain) dan mengawalinya dengan string yang mengidentifikasi jenis resource.