Catatan tentang terminologi

Kata name, type, jenis, metric, dan resource muncul dalam berbagai kombinasi dan konteks yang terkait dengan Cloud Monitoring, dan penggunaannya tidak selalu konsisten. Misalnya, berikut ini beberapa pola umum:

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

    • Suatu "sesuatu" 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 mungkin disebut sebagai salah satu dari yang berikut:

    • Metrik
    • Nama metrik
    • Jenis metrik
    • Nama jenis metrik
  • String seperti gcs_bucket mungkin disebut sebagai salah satu dari yang berikut:

    • Nama resource1
    • Resource yang dimonitor
    • Jenis resource yang dipantau
    • Nama resource yang dipantau

1 Materi referensi REST API juga sering menggunakan istilah nama resource, yang biasanya tidak ada hubungannya dengan resource yang dipantau. Istilah ini dijelaskan secara lebih mendetail di Nama resource.

Bagian ini memberikan beberapa panduan tentang terminologi yang mungkin membingungkan.

Jenis dan nama

Deskripsi untuk jenis metrik dan resource yang dimonitor memiliki nama dan jenis. Dalam penggunaan umum istilah ini digunakan secara bergantian.

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

Jika melihat deskripsi untuk jenis metrik ini, Anda akan melihat dua key-value pair 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).

Pada deskriptor metrik, nilai 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 berkaitan dengan entri api dalam daftar resource yang dimonitor:

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

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

Jenis metrik dan jenis nilai

Ada dua istilah lain yang dapat disalahartikan sebagai “jenis metrik”:

  • Jenis nilai
  • Jenis metrik

Istilah ini bukan istilah alternatif untuk "jenis metrik".

"Jenis nilai" dan "jenis metrik" menggambarkan data yang dikumpulkan. Keduanya terkait dengan konsep pemrograman "datatype".

  • Jenis nilai menjelaskan masing-masing nilai.
  • Jenis metrik menjelaskan bagaimana nilai tersebut saling terkait.

Lihat Jenis dan jenis metrik untuk mengetahui detailnya.

Nama resource

Pola pembuatan nilai name dengan memberi awalan pada string ke nilai type (atau yang lainnya) jauh melampaui jenis metrik dan resource yang di-montitor. 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 kali dijelaskan dalam dokumentasi referensi sebagai "nama resource":

Nama resource dalam referensi API

Berikut adalah beberapa contoh struktur yang memiliki nama resource dan cara asalnya:

  • Deskripsi 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 dipantau: 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 dibuat 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.