Apache CouchDB

Integrasi Apache CouchDB mengumpulkan metrik terkait traffic, seperti jumlah permintaan ke node dan respons dari node. Alat ini juga mengumpulkan metrik database, seperti jumlah yang terbuka dan jumlah operasi. Integrasi ini mengumpulkan log akses dan CouchDB umum, lalu menguraikannya menjadi payload JSON. Hasilnya mencakup kolom untuk pengguna, host, tingkat, dan pesan.

Untuk mengetahui informasi selengkapnya tentang CouchDB, lihat dokumentasi Apache CouchDB.

Prasyarat

Untuk mengumpulkan telemetri CouchDB, Anda harus menginstal Agen Operasional:

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

Integrasi ini mendukung CouchDB versi 2.3.x dan 3.1 serta yang lebih tinggi.

Mengonfigurasi instance CouchDB

Integrasi ini tidak memerlukan konfigurasi tambahan dengan CouchDB versi sebelum 3.4.0, atau pada distribusi berbasis Debian.

Mulai versi 3.4.0, CouchDB berperilaku berbeda pada distribusi berbasis RPM (seperti RHEL atau Rocky Linux). Agar CouchDB berfungsi dengan konfigurasi default penerima logging ini di sistem tersebut, Anda harus mengonfigurasi Apache CouchDB untuk menulis ke /var/log/couchdb/couchdb.log, bukan journald.

Untuk menulis log ke /var/log/couchdb/couchdb.log, selesaikan langkah-langkah berikut:

  1. Buat file /opt/couchdb/etc/local.d/ops-agent-filelog.ini.

  2. Tambahkan baris berikut ke file:

    [log]
writer = file
file = /var/log/couchdb/couchdb.log
level = info

  3. Mulai ulang Apache CouchDB:

    sudo systemctl restart couchdb

Mengonfigurasi Agen Operasional untuk CouchDB

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

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan memproses telemetri untuk CouchDB:

# 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:
    couchdb:
      type: couchdb
      username: admin
      password: otelp
      # 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>}
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
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*

Mengonfigurasi pengumpulan log

Untuk menyerap log dari CouchDB, Anda harus membuat penerima untuk log yang dihasilkan CouchDB, lalu membuat pipeline untuk penerima baru.

Untuk mengonfigurasi penerima log couchdb, tentukan kolom berikut:

Kolom Default Deskripsi
exclude_paths Daftar pola jalur sistem file yang akan dikecualikan dari set yang cocok dengan include_paths.
include_paths [/var/log/couchdb/couchdb.log] Daftar jalur sistem file yang akan dibaca dengan mengikuti setiap file. Karakter pengganti (*) dapat digunakan di jalur; misalnya, /var/log/couchdb*/*.log.
record_log_file_path false Jika disetel ke true, jalur ke file tertentu tempat catatan log diperoleh akan muncul dalam entri log output sebagai nilai label agent.googleapis.com/log_file_path. Saat menggunakan karakter pengganti, hanya jalur file tempat rekaman diperoleh yang dicatat.
type Nilai ini harus couchdb.
wildcard_refresh_interval 60s Interval saat jalur file karakter pengganti di include_paths diperbarui. Diberikan sebagai durasi waktu, misalnya 30s atau 2m. Properti ini mungkin berguna dalam throughput logging yang tinggi saat file log dirotasi lebih cepat daripada interval default.

Apa itu log?

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

Log couchdb berisi kolom berikut dalam LogEntry:

Kolom Jenis Deskripsi
httpRequest objek Lihat HttpRequest
jsonPayload.host string Nama instance host
jsonPayload.level string Tingkat entri log
jsonPayload.message string Pesan log
jsonPayload.node string Nama instance node
jsonPayload.path string Request path
jsonPayload.pid string ID proses
jsonPayload.remote_user string Nama pengguna yang diautentikasi untuk permintaan
jsonPayload.status_message string Pesan kode status
severity string (LogSeverity) Tingkat entri log (diterjemahkan).

Mengonfigurasi pengumpulan metrik

Untuk menyerap metrik dari CouchDB, Anda harus membuat penerima untuk metrik yang dihasilkan CouchDB, 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 couchdb, tentukan kolom berikut:

Kolom Default Deskripsi
collection_interval 60s Nilai durasi waktu, seperti 30s atau 5m.
password Sandi yang digunakan untuk terhubung ke server.
server_status_url http://localhost:5984 URL yang diekspos oleh CouchDB.
type Nilai ini harus couchdb.
username Nama pengguna yang digunakan untuk terhubung ke server.

Yang dipantau

Tabel berikut berisi daftar metrik yang dikumpulkan Ops Agent dari instance CouchDB.

Jenis metrik 
Jenis, Tipe
Resource yang dimonitor		 Label
workload.googleapis.com/couchdb.average_request_time
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/couchdb.database.open
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/couchdb.database.operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/couchdb.file_descriptor.open
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/couchdb.httpd.bulk_requests
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/couchdb.httpd.requests
CUMULATIVE, INT64
gce_instance 		http_method
workload.googleapis.com/couchdb.httpd.responses
CUMULATIVE, INT64
gce_instance 		http_status_code
workload.googleapis.com/couchdb.httpd.views
CUMULATIVE, INT64
gce_instance 		view

Memverifikasi konfigurasi

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

Untuk memverifikasi bahwa log CouchDB 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("couchdb")

Untuk memverifikasi bahwa metrik CouchDB 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/couchdb.database.open", monitored_resource="gce_instance"}

Lihat dasbor

Untuk melihat metrik CouchDB, Anda harus mengonfigurasi diagram atau dasbor. Integrasi CouchDB 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 CouchDB 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 CouchDB 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 CouchDB 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.