Apache Solr

Dokumen ini menjelaskan cara mengonfigurasi deployment Google Kubernetes Engine Anda sehingga Anda dapat menggunakan Google Cloud Managed Service for Prometheus untuk mengumpulkan metrik dari Apache Solr. Dokumen ini menunjukkan cara melakukan hal berikut:

• Siapkan pengekspor untuk Solr guna melaporkan metrik.
• Konfigurasi resource PodMonitoring untuk Managed Service for Prometheus guna mengumpulkan metrik yang diekspor.
• Akses dasbor di Cloud Monitoring untuk melihat metrik.
• Konfigurasi aturan pemberitahuan untuk memantau metrik.

Petunjuk ini hanya berlaku jika Anda menggunakan koleksi terkelola dengan Managed Service for Prometheus. Jika Anda menggunakan pengumpulan yang di-deploy sendiri, lihat repositori sumber untuk pengekspor JMX guna mengetahui informasi penginstalan.

Petunjuk ini diberikan sebagai contoh dan diharapkan berfungsi di sebagian besar lingkungan Kubernetes. Jika Anda mengalami masalah saat menginstal aplikasi atau eksportir karena kebijakan keamanan atau organisasi yang ketat, sebaiknya lihat dokumentasi open source untuk mendapatkan dukungan.

Untuk mengetahui informasi tentang Apache Solr, lihat Apache Solr.

Prasyarat

Untuk mengumpulkan metrik dari Solr dengan menggunakan Managed Service for Prometheus dan pengumpulan terkelola, deployment Anda harus memenuhi persyaratan berikut:

• Cluster Anda harus menjalankan Google Kubernetes Engine versi 1.21.4-gke.300 atau yang lebih baru.
• Anda harus menjalankan Managed Service for Prometheus dengan koleksi terkelola yang diaktifkan. Untuk mengetahui informasi selengkapnya, lihat Mulai menggunakan koleksi terkelola.

• Untuk menggunakan dasbor yang tersedia di Cloud Monitoring untuk integrasi Solr, Anda harus menggunakan jmx-exporter versi 0.17.0 atau yang lebih baru.

  Untuk mengetahui informasi selengkapnya tentang dasbor yang tersedia, lihat Melihat dasbor.

Menginstal pengekspor Solr

Sebaiknya instal eksportir Solr, jmx-exporter, sebagai sidecar untuk workload Solr Anda. Untuk mengetahui informasi tentang cara menggunakan file bantuan, lihat Aplikasi yang diperluas di Kubernetes dengan pod multi-container.

Untuk menginstal jmx-exporter sebagai sidecar ke Solr, ubah konfigurasi Solr Anda seperti yang ditunjukkan dalam contoh berikut:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: v1
kind: ConfigMap
metadata:
  name: solr-exporter
data:
  config.yml: |
    hostPort: 127.0.0.1:9999
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: solr
spec:
  selector:
    matchLabels:
+     app.kubernetes.io/name: solr
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: solr
    spec:
      containers:
      - name: solr
        image: solr:8.8.2
+       ports:
+       - containerPort: 9999
+         name: jmx
+       env:
+       - name: ENABLE_REMOTE_JMX_OPTS
+         value: "true"
+       - name: RMI_PORT
+         value: "9999"
+     - name: exporter
+       image: bitnami/jmx-exporter:0.17.0
+       ports:
+       - containerPort: 9000
+         name: prometheus
+       command:
+         - java
+         - -jar
+         - jmx_prometheus_httpserver.jar
+       args:
+         - "9000"
+         - /opt/jmx_exporter/config.yml
+       volumeMounts:
+       - mountPath: /opt/jmx_exporter/config.yml
+         subPath: config.yml
+         name: solr-exporter
+     volumes:
+     - name: solr-exporter
+       configMap:
+         name: solr-exporter
+         items:
+         - key: config.yml
+           path: config.yml

Anda harus menambahkan baris yang diawali dengan simbol + ke konfigurasi.

Untuk menerapkan perubahan konfigurasi dari file lokal, jalankan perintah berikut:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Anda juga dapat menggunakan Terraform untuk mengelola konfigurasi.

Tentukan resource PodMonitoring

Untuk penemuan target, Managed Service for Prometheus Operator memerlukan resource PodMonitoring yang sesuai dengan JMX exporter di namespace yang sama.

Anda dapat menggunakan konfigurasi PodMonitoring berikut:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: solr
  labels:
    app.kubernetes.io/name: solr
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: solr

Pastikan pemilih label dan port cocok dengan pemilih dan port yang digunakan di Instal eksportir Solr.

Untuk menerapkan perubahan konfigurasi dari file lokal, jalankan perintah berikut:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Anda juga dapat menggunakan Terraform untuk mengelola konfigurasi.

Menentukan aturan dan pemberitahuan

Anda dapat menggunakan konfigurasi Rules berikut untuk menentukan pemberitahuan pada metrik Solr:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: solr-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: solr-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: solr
    interval: 30s
    rules:
    - alert: SolrHighCacheEvictions
      annotations:
        description: |-
          Solr high cache evictions
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Solr high cache evictions (instance {{ $labels.instance }})
      expr: solr_core_evictions > 0
      for: 5m
      labels:
        severity: warning
    - alert: SolrHighRequestCount
      annotations:
        description: |-
          Solr high request count
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Solr high request count (instance {{ $labels.instance }})
      expr: solr_core_Count{name="requests"} > 10
      for: 5m
      labels:
        severity: warning
    - alert: SolrHighRequestErrors
      annotations:
        description: |-
          Solr high request errors
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Solr high request errors (instance {{ $labels.instance }})
      expr: solr_core_Count{name="errors"} > 0
      for: 5m
      labels:
        severity: warning

Untuk menerapkan perubahan konfigurasi dari file lokal, jalankan perintah berikut:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Anda juga dapat menggunakan Terraform untuk mengelola konfigurasi.

Untuk mengetahui informasi selengkapnya tentang penerapan aturan ke cluster Anda, lihat Evaluasi dan pemberitahuan aturan terkelola.

Memverifikasi konfigurasi

Anda dapat menggunakan Metrics Explorer untuk memverifikasi bahwa Anda telah mengonfigurasi pengekspor JMX dengan benar. Mungkin perlu waktu satu atau dua menit agar Cloud Monitoring dapat menyerap metrik Anda.

Untuk memverifikasi bahwa metrik telah di-ingest, lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman leaderboard 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 code MQL atau code PromQL.
3. Pastikan PromQL dipilih di tombol Language. Tombol bahasa ada di toolbar yang sama yang memungkinkan Anda memformat kueri.
4. Masukkan dan jalankan kueri berikut:
   

   up{job="solr", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Melihat dasbor

Integrasi Cloud Monitoring mencakup dasbor Solr Prometheus Overview. Dasbor akan otomatis diinstal saat Anda mengonfigurasi integrasi. 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.
3. Pilih kategori Integrasi.
4. Klik nama dasbor, misalnya, Solr Prometheus Overview.

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 Kubernetes Engine.
3. Temukan integrasi Apache Solr, lalu klik Lihat Detail.
4. Pilih tab Dasbor.

Pemecahan masalah

Untuk mengetahui informasi tentang cara memecahkan masalah penyerapan metrik, lihat Masalah pengumpulan dari eksportir di Memecahkan masalah sisi penyerapan.