Konvensi penamaan metrik

Dokumen ini menjelaskan konvensi penamaan yang diterapkan Cloud Monitoring untuk metrik.

Nama resource metrik

Nama resource untuk jenis metrik terdiri dari string dengan tiga substruktur utama:

  • ID untuk project tertentu.
  • Penanda, yang selalu ditetapkan ke metricDescriptors, untuk menunjukkan bahwa string merepresentasikan deskripsi metrik.
  • Jenis metrik.

Nama resource untuk jenis metrik mengikuti pola ini:

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

Sub-string METRIC_TYPE adalah ID yang mewakili jenis metrik. Alat ini tersedia dalam berbagai format, misalnya:

agent.googleapis.com/agent/api_request_count
compute.googleapis.com/firewall/dropped_bytes_count
istio.io/service/client/received_bytes_count
kubernetes.io/anthos/APIServiceOpenAPIAggregationControllerQueue1_adds

Pada deskripsi metrik, kolom name menyimpan nama resource jenis metrik, dan kolom type menyimpan sub-string METRIC_TYPE.

Tabel berikut menunjukkan cara mengurai sub-string METRIC_TYPE yang terdapat dalam nama resource:

Kemungkinan struktur Deskripsi
SERVICE_NAME 1.googleapis.com/PATH 2 Metrik dari produk dan layanan Google Cloud. Untuk mengetahui daftar lengkap metrik ini, lihat Metrik Google Cloud.
agent.googleapis.com/SERVICE_NAME 1/PATH 2 Metrik dari agen Monitoring dan Logging yang berjalan pada instance VM di Google Cloud atau AWS. Untuk daftar lengkap metrik ini, lihat Metrik agen.
kubernetes.io/anthos/PATH 2 Metrik dari GKE Enterprise, layanan Google Cloud yang memungkinkan Anda menjalankan cluster Kubernetes baik di infrastruktur lokal maupun di cloud. Untuk daftar lengkap metrik ini, lihat Metrik Anthos.
aws.googleapis.com/SERVICE_NAME 1/PATH 2 Metrik dari Amazon Web Services. Untuk daftar lengkap metrik tersebut, lihat metrik AWS.
istio.io/PATH 2 Metrik dari Istio untuk Google Cloud. Untuk daftar lengkap metrik ini, lihat metrik Istio.
kubernetes.io/PATH 2 Metrik dari Google Kubernetes Engine. Untuk mengetahui daftar lengkap metrik tersebut, lihat metrik Kubernetes.
knative.dev/PATH 2 Metrik dari Knative. Untuk daftar lengkap metrik ini, lihat Metrik Knative.
external.googleapis.com/EXT_SERVICE/PATH 2
external.googleapis.com/prometheus/PATH 2		 Metrik kustom pihak ketiga seperti Prometheus. Alat pemantauan open source ini sering digunakan dengan Kubernetes. Untuk informasi selengkapnya tentang metrik ini, lihat Metrik eksternal. Anda hanya dapat menggunakan jenis metrik ini dalam project yang menentukannya.
custom.googleapis.com/PATH 2
external.googleapis.com/user/PATH 2		 Metrik buatan pengguna. Anda hanya dapat menggunakan jenis metrik ini dalam project tempat Anda menentukannya.
logging.googleapis.com/PATH 2 Metrik berbasis log dari Cloud Logging. Anda dapat menggunakan metrik standar atau membuat metrik kustom. Metrik kustom hanya dapat digunakan dalam project yang Anda tentukan.

1 SERVICE_NAME mengidentifikasi produk Google Cloud, seperti compute untuk Compute Engine.
2 PATH mengidentifikasi metrik dalam produk, seperti instance/cpu/utilization.

Aturan untuk jenis metrik dan label

Daftar ini berisi aturan yang harus diikuti saat Anda membuat jenis metrik kustom. Label yang terkait dengan jenis metrik ditetapkan sebagai key-value pair dari jenis LabelDescriptor. Kunci berfungsi sebagai nama label.

  • Jenis metrik

    • Gunakan huruf besar dan kecil (A-Z, a-z), angka (0-9), titik (.), dan garis bawah (_) dalam string.
    • Gunakan garis miring (/) untuk memisahkan elemen jalur.
    • Anda harus memulai setiap elemen jalur dengan huruf atau angka.
    • Panjang maksimum string jenis metrik adalah 200 karakter.

  • Kunci label

    • Gunakan huruf kecil (a-z), angka (0-9), dan garis bawah (_) dalam kunci label.
    • Anda harus memulai kunci label dengan huruf.
    • Panjang maksimum kunci label adalah 100 karakter.
    • Setiap kunci harus unik dalam jenis metrik.
    • Anda tidak boleh memiliki lebih dari 30 label per jenis metrik.