Catatan tentang terminologi

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

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

    • “Sesuatu” umum yang akan 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 hal berikut:

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

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

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

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 sehari-hari, 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 deskripsi 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 deskripsi metrik adalah string yang mengenkode informasi tentang layanan yang menghasilkan data (misalnya, storage.googleapis.com) dan hal yang diukur (api/request_count).

Dalam deskripsi 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 yang 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 dipantau:

{
  "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 kali digunakan secara tidak akurat dalam diskusi santai.

Jenis metrik dan jenis nilai

Ada dua istilah lain yang dapat disalahartikan 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 "datatype".

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

Lihat Jenis dan jenis metrik untuk mengetahui detailnya.

Nama resource

Pola pembuatan nilai name dengan menambahkan awalan string ke nilai type (atau lainnya) meluas jauh di luar 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”:

Nama resource dalam referensi API

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

  • 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: menggabungkan 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 dipantau dengan cara apa pun. Untuk informasi selengkapnya tentang nama resource dalam desain API, lihat Nama resource.