Apache Cassandra

Integrasi Apache Cassandra mengumpulkan metrik permintaan, tugas, dan penyimpanan yang menandai beban pada instance. Secara opsional, integrasi juga dapat mengumpulkan metrik JVM umum yang terkait dengan memori dan pembersihan sampah memori. Integrasi ini juga mengumpulkan log sistem, debug, dan pembersihan sampah memori. Log ini diuraikan menjadi payload JSON, yang mencakup kolom untuk pesan, class Java, dan nomor baris.

Untuk informasi selengkapnya tentang Cassandra, lihat dokumentasi Apache Cassandra.

Prasyarat

Untuk mengumpulkan telemetri Cassandra, Anda harus menginstal Agen Operasional:

Untuk metrik, instal versi 2.6.0 atau yang lebih baru.
Untuk log, instal versi 2.5.0 atau yang lebih baru.

Integrasi ini mendukung Cassandra versi 3.11 dan 4.0.

Mengonfigurasi instance Cassandra

Untuk mengekspos endpoint JMX, Anda harus menetapkan properti sistem com.sun.management.jmxremote.port saat memulai JVM. Sebaiknya setel properti sistem com.sun.management.jmxremote.rmi.port ke port yang sama. Untuk mengekspos endpoint JMX dari jarak jauh, Anda juga harus menyetel properti sistem java.rmi.server.hostname.

Secara default, properti ini ditetapkan dalam file cassandra-env.sh deployment Cassandra.

Untuk menetapkan properti sistem menggunakan argumen command line, awali nama properti dengan -D saat memulai JVM. Misalnya, untuk menetapkan com.sun.management.jmxremote.port ke port 7199, tentukan hal berikut saat memulai JVM:

-Dcom.sun.management.jmxremote.port=7199

Mengonfigurasi Agen Operasional untuk Cassandra

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

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk Cassandra 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:
    cassandra:
      type: cassandra
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:7199/jmxrmi
  service:
    pipelines:
      cassandra:
        receivers:
          - cassandra
logging:
  receivers:
    cassandra_system:
      type: cassandra_system
    cassandra_debug:
      type: cassandra_debug
    cassandra_gc:
      type: cassandra_gc
  service:
    pipelines:
      cassandra:
        receivers:
          - cassandra_system
          - cassandra_debug
          - cassandra_gc
EOF

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

Dalam contoh ini, properti sistem com.sun.management.jmxremote.port dan com.sun.management.jmxremote.rmi.port disetel ke 7199, dan properti sistem java.rmi.server.hostname disetel ke 127.0.0.1. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi pengumpulan metrik.

Mengonfigurasi koleksi log

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

Untuk mengonfigurasi penerima log cassandra_system, 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/cassandra/system*.log]`	Daftar jalur sistem file yang akan dibaca dengan tailing setiap file. Karakter pengganti (``) dapat digunakan di jalur; misalnya, `/var/log/cassandra/system.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 `cassandra_system`.
`wildcard_refresh_interval`	`60s`	Interval tempat jalur file karakter pengganti di `include_paths` dimuat ulang. Diberikan sebagai durasi waktu yang dapat diurai oleh `time.ParseDuration`, misalnya `30s` atau `2m`. Properti ini mungkin berguna pada throughput logging yang tinggi dengan file log dirotasi lebih cepat daripada interval default.

Untuk mengonfigurasi penerima log cassandra_debug, 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/cassandra/debug*.log]`	Daftar jalur sistem file yang akan dibaca dengan tailing setiap file. Karakter pengganti (``) dapat digunakan di jalur; misalnya, `/var/log/cassandra/system.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 `cassandra_debug`.
`wildcard_refresh_interval`	`60s`	Interval tempat jalur file karakter pengganti di `include_paths` dimuat ulang. Diberikan sebagai durasi waktu yang dapat diurai oleh `time.ParseDuration`, misalnya `30s` atau `2m`. Properti ini mungkin berguna pada throughput logging yang tinggi dengan file log dirotasi lebih cepat daripada interval default.

Untuk mengonfigurasi penerima log cassandra_gc, 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/cassandra/gc.log.*.current]`	Daftar jalur sistem file yang akan dibaca dengan tailing setiap file. Karakter pengganti (``) dapat digunakan di jalur; misalnya, `/var/log/cassandra/system.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 `cassandra_gc`.
`wildcard_refresh_interval`	`60s`	Interval tempat jalur file karakter pengganti di `include_paths` dimuat ulang. Diberikan sebagai durasi waktu yang dapat diurai oleh `time.ParseDuration`, misalnya `30s` atau `2m`. Properti ini mungkin berguna pada throughput logging yang tinggi dengan file log dirotasi lebih cepat daripada interval default.

Apa itu log?

logName berasal dari ID penerima yang ditentukan dalam konfigurasi. Kolom mendetail di dalam LogEntry adalah sebagai berikut. Entri log tidak berisi kolom yang kosong atau tidak ada.

Log cassandra_system berisi kolom berikut di LogEntry:

Kolom	Jenis	Deskripsi
`jsonPayload.javaClass`	string	Class Java tempat log berasal
`jsonPayload.level`	string	Log tingkat entri
`jsonPayload.lineNumber`	string	Nomor baris file sumber tempat log berasal
`jsonPayload.message`	string	Pesan log, termasuk stacktrace terperinci jika diberikan
`jsonPayload.module`	string	Modul cassandra tempat log berasal
`severity`	string (`LogSeverity`)	Tingkat entri log (diterjemahkan)

Log cassandra_debug berisi kolom berikut di LogEntry:

Kolom	Jenis	Deskripsi
`jsonPayload.javaClass`	string	Class Java tempat log berasal
`jsonPayload.level`	string	Log tingkat entri
`jsonPayload.lineNumber`	string	Nomor baris file sumber tempat log berasal
`jsonPayload.message`	string	Pesan log
`jsonPayload.module`	string	Modul cassandra tempat log berasal
`severity`	string (`LogSeverity`)	Tingkat entri log (diterjemahkan)

Log cassandra_gc berisi kolom berikut di LogEntry:

Kolom	Jenis	Deskripsi
`jsonPayload.message`	string	Pesan log
`jsonPayload.timeStopped`	string	Detik saat JVM dihentikan untuk pembersihan sampah memori
`jsonPayload.timeStopping`	string	Detik yang dibutuhkan JVM untuk menghentikan thread sebelum pembersihan sampah memori
`jsonPayload.uptime`	string	Detik JVM telah aktif
`severity`	string (`LogSeverity`)	Tingkat entri log (diterjemahkan)

Mengonfigurasi pengumpulan metrik

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

Kolom	Default	Deskripsi
`collect_jvm_metrics`	`true`	Mengonfigurasi penerima agar juga mengumpulkan metrik JVM yang didukung.
`collection_interval`	`60s`	Nilai durasi waktu, seperti `30s` atau `5m`.
`endpoint`	`localhost:7199`	URL atau host dan port Layanan JMX yang digunakan untuk membuat URL layanan. Nilai ini harus dalam bentuk `service:jmx:<protocol>:<sap>` atau `host:port`. Nilai dalam bentuk `host:port` digunakan untuk membuat URL layanan `service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi`.
`password`		Sandi yang dikonfigurasi jika JMX dikonfigurasi untuk mewajibkan autentikasi.
`type`		Nilai harus berupa `cassandra`.
`username`		Nama pengguna yang dikonfigurasi jika JMX dikonfigurasi untuk mewajibkan autentikasi.

Hal yang dipantau

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

Jenis metrik
Jenis, Jenis Resource yang dipantau	Label
`workload.googleapis.com/cassandra.client.request.count`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/cassandra.client.request.error.count`
`CUMULATIVE`, `INT64` gce_instance	`operation` `status`
`workload.googleapis.com/cassandra.client.request.range_slice.latency.50p`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.range_slice.latency.99p`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.range_slice.latency.max`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.read.latency.50p`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.read.latency.99p`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.read.latency.max`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.write.latency.50p`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.write.latency.99p`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.client.request.write.latency.max`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/cassandra.compaction.tasks.completed`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/cassandra.compaction.tasks.pending`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/cassandra.storage.load.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/cassandra.storage.total_hints.count`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/cassandra.storage.total_hints.in_progress.count`
`GAUGE`, `INT64` gce_instance

Memverifikasi konfigurasi

Bagian ini menjelaskan cara memverifikasi bahwa Anda mengonfigurasi penerima Casssandra dengan benar. Mungkin perlu waktu satu atau dua menit bagi Agen Operasional untuk mulai mengumpulkan telemetri.

Untuk memverifikasi bahwa log Cassandra 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("cassandra_system") OR log_id("cassandra_debug") OR log_id("cassandra_gc"))

Untuk memverifikasi bahwa metrik Cassandra 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/cassandra.client.request.count'
| every 1m

Lihat dasbor

Untuk melihat metrik Cassandra, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Cassandra menyertakan 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 Cassandra 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 Cassandra mencakup satu atau beberapa kebijakan pemberitahuan untuk 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 Cassandra 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.