Couchbase

Integrasi Couchbase mengumpulkan metrik bucket seperti operasi, penggunaan memori, dan penghapusan. Integrasi mengumpulkan metrik dari server Prometheus yang diekspos di node. Integrasi ini juga mengumpulkan log umum, akses HTTP, dan lintas pusat data ("goxdcr") Couchbase.

Untuk mengetahui informasi selengkapnya tentang Couchbase, lihat dokumentasi Couchbase.

Prasyarat

Untuk mengumpulkan telemetri Couchbase, Anda harus menginstal Agen Operasional:

  • Untuk metrik, instal versi 2.18.2 atau yang lebih tinggi.
  • Untuk log, instal versi 2.18.2 atau yang lebih tinggi.

Integrasi ini mendukung Couchbase versi 6.5, 6.6, dan 7.0.

Mengonfigurasi Agen Operasional untuk Couchbase

Dengan mengikuti panduan untuk Mengonfigurasi Agen Operasional, tambahkan elemen yang diperlukan untuk mengumpulkan telemetri dari instance Couchbase, dan mulai ulang agen.

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk Couchbase:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchbase:
      type: couchbase
      username: admin 
      password: password 
      # To use the googlesecretmanager provider to replace plaintext passwords, refer to the example below.
      # password: ${googlesecretmanager:projects/<project-id>/secrets/<secret-id>/versions/<version-id>}
      collection_interval: 30s
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase

logging:
  receivers:
    couchbase_general:
      type: couchbase_general
    couchbase_http_access:
      type: couchbase_http_access
    couchbase_goxdcr:
      type: couchbase_goxdcr
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase_general
          - couchbase_http_access
          - couchbase_goxdcr

EOF

Agar perubahan ini diterapkan, Anda harus memulai ulang Agen Operasi:

Linux

  1. Untuk memulai ulang agen, jalankan perintah berikut di instance Anda: 
    sudo systemctl restart google-cloud-ops-agent
  2. Untuk mengonfirmasi bahwa agen telah dimulai ulang, jalankan perintah berikut dan verifikasi bahwa komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Hubungkan ke instance Anda menggunakan RDP atau alat serupa dan login ke Windows.
  2. Buka terminal PowerShell dengan hak istimewa administrator dengan mengklik kanan ikon PowerShell dan memilih Run as Administrator
  3. Untuk memulai ulang agen, jalankan perintah PowerShell berikut: 
    Restart-Service google-cloud-ops-agent -Force
  4. Untuk mengonfirmasi bahwa agen telah dimulai ulang, jalankan perintah berikut dan verifikasi bahwa komponen "Metrics Agent" dan "Logging Agent" telah dimulai: 
    Get-Service google-cloud-ops-agent*

Apa itu log?

logName berasal dari ID penerima yang ditentukan dalam konfigurasi. Kolom mendetail dalam LogEntry adalah sebagai berikut.

Log couchbase_general berisi kolom berikut dalam LogEntry:

Kolom Jenis Deskripsi
jsonPayload.level string Tingkat keparahan entri log untuk log couchbase
jsonPayload.message string Pesan log
jsonPayload.module_name string Nama modul yang mengeluarkan entri
jsonPayload.node_name string Nama node yang mengeluarkan pesan log
jsonPayload.source string Sumber tempat log berasal
jsonPayload.type string Jenis log
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Log couchbase_http_access berisi kolom berikut dalam LogEntry:

Kolom Jenis Deskripsi
httpRequest objek Lihat HttpRequest
jsonPayload.host string Alamat IP klien yang memanggil permintaan HTTP
jsonPayload.level string Tingkat keparahan entri log untuk log couchbase
jsonPayload.message string Pesan log
jsonPayload.user string Nama pengguna yang membuat permintaan HTTP jika autentikasi dasar digunakan.
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Log couchbase_goxdcr berisi kolom berikut dalam LogEntry:

Kolom Jenis Deskripsi
jsonPayload.level string Tingkat keparahan entri log untuk log couchbase
jsonPayload.log_type string Nama komponen yang mengeluarkan log lintas pusat data
jsonPayload.message string Pesan log
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Mengonfigurasi pengumpulan metrik

Untuk menyerap metrik dari Couchbase, Anda harus membuat penerima untuk metrik yang dihasilkan Couchbase, lalu membuat pipeline untuk penerima baru.

Penerima ini tidak mendukung penggunaan beberapa instance dalam konfigurasi, misalnya, untuk memantau beberapa endpoint. Semua instance tersebut menulis ke deret waktu yang sama, dan Cloud Monitoring tidak dapat membedakannya.

Untuk mengonfigurasi penerima metrik couchbase, tentukan kolom berikut:

Kolom Default Deskripsi
collection_interval 60s Nilai time.Duration, seperti 30s atau 5m.
endpoint localhost:8091 URL node yang akan dipantau.
password Sandi yang digunakan untuk terhubung ke server Couchbase.
type Nilai ini harus couchbase.
username Nama pengguna yang digunakan untuk terhubung ke server Couchbase.

Yang dipantau

Tabel berikut berisi daftar metrik yang dikumpulkan Agen Operasi dari instance Couchbase.

Jenis metrik 
Jenis, Tipe
Resource yang dimonitor		 Label
workload.googleapis.com/couchbase.bucket.error.oom.count
CUMULATIVE, INT64
gce_instance 		bucket_name
error_type
workload.googleapis.com/couchbase.bucket.item.count
GAUGE, DOUBLE
gce_instance 		bucket_name
state
workload.googleapis.com/couchbase.bucket.item.ejection.count
CUMULATIVE, INT64
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.high_water_mark.limit
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.low_water_mark.limit
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.usage
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.operation.count
CUMULATIVE, INT64
gce_instance 		bucket_name
op
workload.googleapis.com/couchbase.bucket.vbucket.count
GAUGE, DOUBLE
gce_instance 		bucket_name
state

Memverifikasi konfigurasi

Bagian ini menjelaskan cara memverifikasi bahwa Anda telah mengonfigurasi penerima Couchbase dengan benar. Mungkin perlu waktu satu atau dua menit agar Agen Operasi mulai mengumpulkan telemetri.

Untuk memverifikasi bahwa log Couchbase dikirim ke Cloud Logging, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman Logs Explorer:

    Buka Logs Explorer

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

  2. Masukkan kueri berikut di editor, lalu klik Run query: 
    resource.type="gce_instance"
(log_id("couchbase_general") OR log_id("couchbase_http_access") OR log_id("couchbase_goxdcr"))

Untuk memverifikasi bahwa metrik Couchbase dikirim ke Cloud Monitoring, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman  Metrics explorer:

    Buka Metrics explorer

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar panel pembuat kueri, pilih tombol yang namanya  MQL atau  PromQL.
  3. Pastikan PromQL dipilih di tombol Language. Tombol bahasa ada di toolbar yang sama yang memungkinkan Anda memformat kueri.
  4. Masukkan kueri berikut di editor, lalu klik Run query: 
    {"workload.googleapis.com/couchbase.bucket.memory.usage", monitored_resource="gce_instance"}

Lihat dasbor

Untuk melihat metrik Couchbase, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Couchbase mencakup satu atau beberapa dasbor untuk Anda. Dasbor apa pun akan otomatis diinstal setelah Anda mengonfigurasi integrasi dan Agen Operasional mulai mengumpulkan data metrik.

Anda juga dapat melihat pratinjau statis dasbor tanpa menginstal integrasi.

Untuk melihat dasbor yang terinstal, lakukan tindakan berikut:

  1. Di konsol Google Cloud , buka halaman  Dasbor:

    Buka Dasbor

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Pilih tab Daftar Dasbor, lalu pilih kategori Integrasi.
  3. Klik nama dasbor yang ingin Anda lihat.

Jika Anda telah mengonfigurasi integrasi, tetapi dasbor belum diinstal, periksa apakah Agen Operasional sedang berjalan. Jika tidak ada data metrik untuk diagram di dasbor, penginstalan dasbor akan gagal. Setelah Agen Operasi mulai mengumpulkan metrik, dasbor akan diinstal untuk Anda.

Untuk melihat pratinjau statis dasbor, lakukan tindakan berikut:

  1. Di konsol Google Cloud , buka halaman  Integrations:

    Buka Integrations

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik filter platform deployment Compute Engine.
  3. Temukan entri untuk Couchbase lalu klik Lihat Detail.
  4. Pilih tab Dasbor untuk melihat pratinjau statis. Jika dasbor telah diinstal, Anda dapat membukanya dengan mengklik Lihat dasbor.

Untuk mengetahui informasi selengkapnya tentang dasbor di Cloud Monitoring, lihat Dasbor dan diagram.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Integrasi, lihat Mengelola integrasi.

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat kondisi tertentu terjadi. Integrasi Couchbase mencakup satu atau beberapa kebijakan pemberitahuan yang dapat Anda gunakan. Anda dapat melihat dan menginstal kebijakan pemberitahuan ini dari halaman Integrasi di Monitoring.

Untuk melihat deskripsi kebijakan pemberitahuan yang tersedia dan menginstalnya, lakukan langkah berikut:

  1. Di konsol Google Cloud , buka halaman  Integrations:

    Buka Integrations

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Temukan entri untuk Couchbase lalu klik Lihat Detail.
  3. Pilih tab Peringatan. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
  4. Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui ke mana harus mengirimkan notifikasi bahwa pemberitahuan telah dipicu, sehingga memerlukan informasi dari Anda untuk penginstalan. Untuk menginstal kebijakan pemberitahuan, lakukan hal berikut:
    1. Dari daftar kebijakan pemberitahuan yang tersedia, pilih kebijakan yang ingin Anda instal.

    2. Di bagian Konfigurasi notifikasi, pilih satu atau beberapa saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi, tetapi jika Anda melakukannya, kebijakan pemberitahuan akan diaktifkan secara diam-diam. Anda dapat memeriksa statusnya di Monitoring, tetapi Anda tidak menerima notifikasi.

      Untuk mengetahui informasi selengkapnya tentang saluran notifikasi, lihat Mengelola saluran notifikasi.

    3. Klik Buat Kebijakan.

Untuk mengetahui informasi selengkapnya tentang kebijakan pemberitahuan di Cloud Monitoring, lihat Pengantar tentang pemberitahuan.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Integrasi, lihat Mengelola integrasi.

Langkah berikutnya

Untuk melihat panduan cara menggunakan Ansible guna menginstal Agen Operasional, mengonfigurasi aplikasi pihak ketiga, dan menginstal dasbor contoh, tonton video Menginstal Agen Operasional untuk memecahkan masalah aplikasi pihak ketiga.