Memantau Config Sync dengan Cloud Monitoring

Halaman ini menjelaskan cara mengirim metrik dari Config Sync ke Cloud Monitoring.

Config Sync menggunakan OpenTelemetry untuk membuat, mencatat, dan mengekspor metriknya. Halaman ini menjelaskan cara mengonfigurasi metrik Cloud Monitoring. Untuk cara lain mengekspor metrik, lihat Memantau Config Sync dengan Prometheus atau Memantau Config Sync dengan pemantauan kustom.

Mengonfigurasi metrik Cloud Monitoring memerlukan izin iam.serviceAccounts.setIamPolicy pada project. Untuk contoh cara melihat metrik ini, lihat Contoh prosedur proses debug. Anda dapat melihat metrik ini dengan Metrics Explorer atau dengan menggunakan Cloud Monitoring API.

Memberikan izin penulisan metrik untuk Cloud Monitoring

Untuk mengonfigurasi Cloud Monitoring untuk Config Sync, Anda harus memberikan izin penulisan metrik ke akun layanan di project Anda. Izin yang diperlukan bergantung pada apakah Workload Identity Federation untuk GKE diaktifkan.

Mengonfigurasi Cloud Monitoring dengan Workload Identity Federation for GKE

Jika Workload Identity Federation untuk GKE diaktifkan, izinkan Config Sync mengirim metrik dengan menjalankan perintah ini:

gcloud projects add-iam-policy-binding PROJECT_ID \
   --role=roles/monitoring.metricWriter \
   --member="serviceAccount:PROJECT_ID.svc.id.goog[config-management-monitoring/default]"

Ganti PROJECT_ID dengan project ID cluster.

Mengonfigurasi Cloud Monitoring tanpa Workload Identity Federation untuk GKE

Jika Workload Identity Federation untuk GKE tidak diaktifkan dan Config Sync berjalan di dalam lingkungan Google Cloud, Anda dapat menggunakan akun layanan default Compute Engine. Jika organisasi Anda menerapkan batasan kebijakan organisasi iam.automaticIamGrantsForDefaultServiceAccounts, akun layanan ini mungkin tidak otomatis diberi peran Editor (roles/editor) di project Anda. Anda harus memberikan peran IAM Monitoring Metric Writer (roles/monitoring.metricWriter) pada project ke akun layanan default Compute Engine dengan menjalankan perintah berikut:

gcloud projects add-iam-policy-binding PROJECT_ID \
   --role=roles/monitoring.metricWriter \
   --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com

Ganti kode berikut:

  • PROJECT_ID: project ID Anda.
  • PROJECT_NUMBER: nomor project Anda.

Daftar metrik default di Cloud Monitoring

Nama Jenis
api_duration_seconds Distribusi
apply_duration_seconds Distribusi
apply_operations_total Jumlah
declared_resources Nilai Terakhir
internal_errors_total Jumlah
last_sync_timestamp Nilai Terakhir
pipeline_error_observed Nilai Terakhir
reconciler_errors Nilai Terakhir
resource_fights_total Jumlah
reconcile_duration_seconds Distribusi
resource_group_total Nilai Terakhir
resource_count Nilai Terakhir
ready_resource_count Nilai Terakhir
resource_ns_count Nilai Terakhir
cluster_scoped_resource_count Nilai Terakhir
kcc_resource_count Meteran

Untuk mengubah daftar yang diizinkan metrik di Cloud Monitoring, ikuti petunjuk untuk mem-patch deployment kolektor otel dengan ConfigMap.

Contoh prosedur proses debug untuk Cloud Monitoring

Contoh Cloud Monitoring berikut mengilustrasikan beberapa pola penggunaan metrik OpenCensus untuk mendeteksi dan mendiagnosis masalah yang terkait dengan Config Sync saat Anda menggunakan RootSync dan RepoSync API.

Format metrik

Di Cloud Monitoring, metrik memiliki format berikut: custom.googleapis.com/opencensus/config_sync/METRIC.

Nama metrik ini terdiri dari komponen berikut:

  • custom.googleapis.com: semua metrik kustom memiliki awalan ini
  • opencensus: awalan ini ditambahkan karena Config Sync menggunakan library OpenCensus
  • config_sync/: metrik yang diekspor Config Sync ke Cloud Monitoring memiliki awalan ini
  • METRIC: nama metrik yang ingin Anda buat kuerinya

Metrik kueri menurut rekonsiliator

Objek RootSync dan RepoSync dilengkapi dengan metrik tingkat tinggi yang memberi Anda insight yang berguna tentang cara kerja Config Sync di cluster. Hampir semua metrik diberi tag berdasarkan nama rekonsiliator, sehingga Anda dapat melihat apakah ada error yang terjadi dan dapat menyiapkan pemberitahuan untuknya di Cloud Monitoring.

Penyelesai adalah Pod yang di-deploy sebagai Deployment. Alat ini menyinkronkan manifes dari sumber tepercaya ke cluster. Saat Anda membuat objek RootSync, Config Sync akan membuat rekonsiliator yang disebut root-reconciler-ROOT_SYNC_NAME atau root-reconciler jika nama RootSync adalah root-sync. Saat Anda membuat objek RepoSync, Config Sync akan membuat rekonsiliator yang disebut ns-reconciler-NAMESPACE-REPO_SYNC_NAME-REPO_SYNC_NAME_LENGTH atau ns-reconciler-NAMESPACE jika nama RepoSync adalah repo-sync, dengan NAMESPACE adalah namespace tempat Anda membuat objek RepoSync.

Diagram berikut menunjukkan cara kerja Pod rekonsiliator saat sumber tepercaya adalah repositori Git:

Alur rekonsiliator

Misalnya, untuk memfilter berdasarkan nama rekonsiliator saat Anda menggunakan Cloud Monitoring, selesaikan tugas berikut:

  1. Di konsol Google Cloud, buka Monitoring:

    Buka Monitoring

  2. Di panel navigasi Monitoring, klik Metrics Explorer.

  3. Di menu drop-down Pilih metrik, tambahkan: custom.googleapis.com/opencensus/config_sync/reconciler_errors.

  4. Di menu drop-down Filter, pilih reconciler. Kotak kolom filter akan muncul.

  5. Di kotak kolom filter, pilih = di kolom pertama dan nama rekonsiliator (misalnya, root-reconciler) di kolom kedua.

  6. Klik Terapkan.

Sekarang Anda dapat melihat metrik untuk objek RootSync.

Untuk mengetahui petunjuk selengkapnya tentang cara memfilter menurut jenis data tertentu, lihat Memfilter data.

Mengkueri operasi Config Sync menurut komponen dan status

Setelah Anda mengaktifkan RootSync dan RepoSync API, impor dan sumber dari single source of truth (SSOT) serta sinkronisasi ke cluster akan ditangani oleh rekonsiliator. Metrik reconciler_errors diberi label berdasarkan komponen sehingga Anda dapat melihat tempat terjadinya error.

Misalnya, untuk memfilter menurut komponen saat Anda menggunakan Cloud Monitoring, selesaikan tugas berikut:

  1. Di konsol Google Cloud, buka Monitoring:

    Buka Monitoring

  2. Di panel navigasi Monitoring, klik Metrics Explorer.

  3. Di menu drop-down Select a metric, tambahkan custom.googleapis.com/opencensus/config_sync/reconciler_errors.

  4. Di menu drop-down Filter, pilih component. Kotak kolom filter akan muncul.

  5. Di kotak kolom filter, pilih = di kotak pertama dan source di kotak kedua.

  6. Klik Terapkan.

Sekarang Anda dapat melihat error yang terjadi saat mengambil sumber dari sumber tepercaya untuk pencocok.

Anda juga dapat memeriksa metrik untuk sumber dan proses sinkronisasi itu sendiri dengan mengkueri metrik berikut dan memfilter menurut tag status:

custom.googleapis.com/opencensus/config_sync/parser_duration_seconds
custom.googleapis.com/opencensus/config_sync/apply_duration_seconds
custom.googleapis.com/opencensus/config_sync/remediate_duration_seconds