Integrasi Apache Solr mengumpulkan metrik inti dan cache. Metrik inti berfokus pada permintaan, jumlah dokumen, dan ukuran indeks. Metrik cache berfokus pada pemanfaatan cache. Integrasi ini juga mengumpulkan log Solr dan menguraikannya menjadi payload JSON. Hasilnya mencakup kolom untuk shard, replika, core, level, dan pesan.
Untuk informasi selengkapnya tentang Solr, lihat dokumentasi Apache Solr.
Prasyarat
Untuk mengumpulkan telemetri Solr, Anda harus menginstal Agen Operasional:
- Untuk metrik, instal versi 2.10.0 atau yang lebih baru.
- Untuk log, instal versi 2.10.0 atau yang lebih baru.
Integrasi ini mendukung Solr versi 8.x dan 7.7.
Mengonfigurasi instance Solr
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 solr-env.sh
deployment Solr.
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 18983
, tentukan hal berikut saat
memulai JVM:
-Dcom.sun.management.jmxremote.port=18983
Mengonfigurasi Agen Operasional untuk Solr
Dengan mengikuti panduan untuk Mengonfigurasi Agen Operasional, tambahkan elemen yang diperlukan untuk mengumpulkan telemetri dari instance Solr, dan mulai ulang agen.
Contoh konfigurasi
Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk Solr dan memulai ulang Agen Operasional.
Mengonfigurasi koleksi log
Untuk menyerap log dari Solr, Anda harus membuat penerima untuk log yang dihasilkan Solr, lalu membuat pipeline untuk penerima baru tersebut.
Untuk mengonfigurasi penerima log solr_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/solr/logs/solr.log] |
Daftar jalur sistem file yang akan dibaca dengan tailing setiap file. Karakter pengganti (* ) dapat digunakan di jalur. |
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 solr_system . |
|
wildcard_refresh_interval |
60s |
Interval tempat jalur file karakter pengganti di include_paths dimuat ulang. Diberikan sebagai durasi waktu yang dapat diuraikan 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.
Log solr_system
berisi kolom berikut di LogEntry
:
Kolom | Jenis | Deskripsi |
---|---|---|
jsonPayload.collection |
string | Koleksi sol yang terkait dengan log |
jsonPayload.core |
string | Core Solr yang terkait dengan log |
jsonPayload.exception |
string | Pengecualian yang terkait dengan log, termasuk stacktrace mendetail jika diberikan |
jsonPayload.level |
string | Log tingkat entri |
jsonPayload.message |
string | Pesan log |
jsonPayload.replica |
string | Replika Solr yang terkait dengan log |
jsonPayload.shard |
string | Shard sol yang terkait dengan log |
jsonPayload.source |
string | Sumber asal log |
jsonPayload.thread |
string | Thread tempat log berasal |
severity |
string (LogSeverity ) |
Log tingkat entri (diterjemahkan). |
Mengonfigurasi pengumpulan metrik
Untuk menyerap metrik dari Solr, Anda harus membuat penerima untuk metrik yang dihasilkan Solr, 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 solr
, tentukan kolom berikut:
Kolom | Default | Deskripsi |
---|---|---|
collection_interval |
60s |
Nilai durasi waktu, seperti 30s atau 5m . |
endpoint |
localhost:18983 |
JMX Service URL atau host dan port yang digunakan untuk membuat URL Layanan. Harus dalam format host:port . Nilai dalam bentuk host:port akan 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 ini harus solr . |
|
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 Solr.
Jenis metrik | |
---|---|
Jenis, Jenis Resource yang dipantau |
Label |
workload.googleapis.com/solr.cache.eviction.count
|
|
CUMULATIVE , INT64 gce_instance |
cache
core
|
workload.googleapis.com/solr.cache.hit.count
|
|
CUMULATIVE , INT64 gce_instance |
cache
core
|
workload.googleapis.com/solr.cache.insert.count
|
|
CUMULATIVE , INT64 gce_instance |
cache
core
|
workload.googleapis.com/solr.cache.lookup.count
|
|
CUMULATIVE , INT64 gce_instance |
cache
core
|
workload.googleapis.com/solr.cache.size
|
|
GAUGE , INT64 gce_instance |
cache
core
|
workload.googleapis.com/solr.document.count
|
|
GAUGE , INT64 gce_instance |
core
|
workload.googleapis.com/solr.index.size
|
|
GAUGE , INT64 gce_instance |
core
|
workload.googleapis.com/solr.request.count
|
|
CUMULATIVE , INT64 gce_instance |
core
handler
type
|
workload.googleapis.com/solr.request.error.count
|
|
CUMULATIVE , INT64 gce_instance |
core
handler
type
|
workload.googleapis.com/solr.request.time.average
|
|
GAUGE , DOUBLE gce_instance |
core
handler
type
|
workload.googleapis.com/solr.request.timeout.count
|
|
CUMULATIVE , INT64 gce_instance |
core
handler
type
|
Memverifikasi konfigurasi
Bagian ini menjelaskan cara memverifikasi bahwa Anda mengonfigurasi penerima Solr dengan benar. Mungkin perlu waktu satu atau dua menit bagi Agen Operasional untuk mulai mengumpulkan telemetri.
Untuk memastikan bahwa log Solr dikirim ke Cloud Logging, lakukan hal berikut:
-
Pada panel navigasi Google Cloud Console, pilih Logging, lalu pilih Logs Explorer:
- Masukkan kueri berikut di editor, lalu klik Run query:
resource.type="gce_instance" log_id("solr_system")
Untuk memverifikasi bahwa metrik Solr dikirim ke Cloud Monitoring, lakukan hal berikut:
-
Pada panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih leaderboard Metrics Explorer:
- Di toolbar panel pembuat kueri, pilih tombol yang namanya adalah code MQL atau code 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/solr.cache.size' | every 1m
Lihat dasbor
Untuk melihat metrik Solr, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Solr 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:
- 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:
- Klik filter platform deployment Compute Engine.
- Cari entri untuk Solr, 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 Solr 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:
- Cari entri untuk Solr, 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:
- Dari daftar kebijakan pemberitahuan yang tersedia, pilih yang ingin Anda instal.
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.
- 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.
ß