CouchDB Apache

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

Untuk 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 baru.
Untuk log, instal versi 2.11.0 atau yang lebih baru.

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

Mengonfigurasi Agen Operasional untuk CouchDB

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

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk CouchDB dan memulai ulang Agen Operasional.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# 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
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF

sudo service google-cloud-ops-agent restart
sleep 30

Mengonfigurasi koleksi log

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

Untuk mengonfigurasi penerima log couchdb, tentukan kolom berikut:

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

Apa itu log?

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

Log couchdb berisi kolom berikut di LogEntry:

Kolom	Jenis	Deskripsi
`httpRequest`	objek	Lihat `HTTPRequest`
`jsonPayload.host`	string	Nama instance host
`jsonPayload.level`	string	Log tingkat entri
`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`)	Log tingkat entri (diterjemahkan).

Entri log tidak berisi kolom yang kosong atau tidak ada.

Mengonfigurasi pengumpulan metrik

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

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 memiliki cara untuk membedakannya.

Untuk mengonfigurasi penerima metrik couchdb, tentukan kolom berikut:

Kolom	Default	Deskripsi
`collection_interval`	`60s`	Nilai time.Duration, seperti `30s` atau `5m`.
`password`		Kata sandi yang digunakan untuk terhubung ke server.
`server_status_url`	`http://localhost:5984`	URL yang diekspos oleh CouchDB.
`type`		Nilai harus berupa `couchdb`.
`username`		Nama pengguna yang digunakan untuk terhubung ke server.

Hal yang dipantau

Tabel berikut menyediakan daftar metrik yang dikumpulkan Agen Operasional dari instance CouchDB.

Jenis metrik
Jenis, Jenis Resource yang dipantau	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 mengonfigurasi penerima CouchDB dengan benar. Mungkin perlu waktu satu atau dua menit bagi Agen Operasional untuk mulai mengumpulkan telemetri.

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

Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Logs Explorer:
Buka Logs Explorer
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:

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Metrics Explorer:
Buka Metrics Explorer
Di toolbar panel pembuat kueri, pilih tombol yang namanya adalah MQL atau PromQL.
Pastikan MQL dipilih pada tombol Language. Tombol bahasa berada di toolbar yang sama dengan yang memungkinkan Anda memformat kueri.

Masukkan kueri berikut di editor, lalu klik Run query:

fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m

Lihat dasbor

Untuk melihat metrik CouchDB, Anda harus mengonfigurasi diagram atau dasbor. Integrasi CouchDB mencakup satu atau beberapa dasbor untuk Anda. Setiap dasbor 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 hal berikut:

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Dashboards:
Buka Dasbor
Pilih tab Dashboard List, lalu pilih kategori Integrations.
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 Operasional mulai mengumpulkan metrik, dasbor akan diinstal untuk Anda.

Untuk melihat pratinjau statis dasbor, lakukan langkah berikut:

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Integrations:
Buka Integrations
Klik filter platform deployment Compute Engine.
Temukan entri untuk CouchDB, lalu klik View Details.
Pilih tab Dashboards untuk melihat pratinjau statis. Jika dasbor sudah terinstal, Anda dapat membukanya dengan mengklik View dashboard.

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

Untuk mengetahui informasi selengkapnya tentang penggunaan 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 Integrations di Monitoring.

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

Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih Integrations:
Buka Integrations
Temukan entri untuk CouchDB, lalu klik View Details.
Pilih tab Alerts. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui ke mana pemberitahuan harus dikirimkan jika pemberitahuan telah dipicu, sehingga memerlukan informasi dari Anda untuk penginstalan. Untuk menginstal kebijakan pemberitahuan, lakukan tindakan berikut:
1. Dari daftar kebijakan pemberitahuan yang tersedia, pilih yang ingin Anda instal.
2. Di bagian Configure notifications, pilih satu atau beberapa saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi. Namun, jika Anda melakukannya, kebijakan pemberitahuan akan diaktifkan secara diam-diam. Anda dapat memeriksa statusnya di Monitoring, tetapi Anda tidak akan menerima notifikasi.
  
  Untuk informasi lebih lanjut tentang saluran notifikasi, lihat Mengelola saluran notifikasi.
3. Klik Create Policy.

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

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

Langkah selanjutnya

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