Apache Solr

Questo documento descrive come configurare il deployment di Google Kubernetes Engine in modo da poter utilizzare Google Cloud Managed Service per Prometheus per raccogliere metriche da Apache Solr. Questo documento spiega come effettuare le seguenti operazioni:

• Configura l'esportatore per Solr per generare report sulle metriche.
• Configura una risorsa PodMonitoring per Managed Service for Prometheus per raccogliere le metriche esportate.
• Accedi a una dashboard in Cloud Monitoring per visualizzare le metriche.
• Configura regole di avviso per monitorare le metriche.

Queste istruzioni si applicano solo se utilizzi la raccolta gestita con Managed Service per Prometheus. Se utilizzi la raccolta con deployment autonomo, consulta il repository del codice sorgente per l'utilità di esportazione JMX per le informazioni sull'installazione.

Queste istruzioni sono fornite a titolo di esempio e dovrebbero funzionare nella maggior parte degli ambienti Kubernetes. Se riscontri problemi durante l'installazione di un'applicazione o di un esportatore a causa di criteri dell'organizzazione o di sicurezza restrittivi, ti consigliamo di consultare la documentazione open source per l'assistenza.

Per informazioni su Solr, vedi Apache Solr.

Prerequisiti

Per raccogliere metriche da Solr utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve soddisfare i seguenti requisiti:

• Il cluster deve eseguire Google Kubernetes Engine versione 1.21.4-gke.300 o successiva.
• Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta Inizia a utilizzare la raccolta gestita.

• Per utilizzare le dashboard disponibili in Cloud Monitoring per l'integrazione di Solr, devi utilizzare jmx-exporter versione 0.17.0 o successive.

  Per saperne di più sulle dashboard disponibili, consulta Visualizzare le dashboard.

Solr supporta JMX e può essere configurato impostando le variabili di ambiente ENABLE_REMOTE_JMX_OPTS su true e RMI_PORT sulla porta desiderata per le connessioni JMX remote.

Installa l'esportatore Solr

Ti consigliamo di installare l'esportatore Solr, jmx-exporter, come collaterale del carico di lavoro Solr. Per informazioni sull'utilizzo dei file collaterali, consulta Applicazioni estese su Kubernetes con pod multi-container.

Per installare jmx-exporter come file collaterale di Solr, modifica la configurazione di Solr come mostrato nell'esempio seguente:

# 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

Devi aggiungere alla tua configurazione le righe precedute dal simbolo +.

Per applicare modifiche alla configurazione da un file locale, esegui questo comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le tue configurazioni.

definisci una risorsa PodMonitoring

Per il rilevamento della destinazione, l'operatore Managed Service for Prometheus richiede una risorsa PodMonitoring corrispondente all'esportatore Solr nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione di PodMonitoring:

# 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

Assicurati che i selettori di etichette e la porta corrispondano ai selettori e alla porta utilizzati in Installare l'utilità di esportazione Solr.

Per applicare modifiche alla configurazione da un file locale, esegui questo comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le tue configurazioni.

Definisci regole e avvisi

Puoi utilizzare la seguente configurazione Rules per definire gli avvisi sulle metriche 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

Per applicare modifiche alla configurazione da un file locale, esegui questo comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le tue configurazioni.

Per ulteriori informazioni sull'applicazione di regole al cluster, consulta Valutazione e avvisi delle regole gestite.

Puoi regolare le soglie di avviso in base alle esigenze della tua applicazione.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'utilità di esportazione Solr. Cloud Monitoring potrebbe impiegare uno o due minuti per importare le metriche.

Per verificare che le metriche siano state importate:

1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Metrics Explorer:

   Vai a Metrics Explorer

2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  MQL o  PromQL.
3. Verifica che sia selezionato PromQL nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
4. Inserisci ed esegui la query seguente:
   

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

Visualizza dashboard

L'integrazione di Cloud Monitoring include la dashboard Solr Prometheus Overview. Le dashboard vengono installate automaticamente quando configuri l'integrazione. Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata, segui questi passaggi:

1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Dashboard:

   Vai a Dashboard

2. Seleziona la scheda Elenco dashboard.
3. Scegli la categoria Integrazioni.
4. Fai clic sul nome della dashboard, ad esempio Panoramica di Solr Prometheus.

Per visualizzare un'anteprima statica della dashboard:

1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Integrazioni:

   Vai a Integrazioni

2. Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
3. Individua l'integrazione di Apache Solr e fai clic su Visualizza dettagli.
4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di importazione delle metriche, consulta Problemi con la raccolta dagli esportatori in Risoluzione dei problemi lato importazione.