Google utilizza la tecnologia AI per tradurre i contenuti nella tua lingua preferita. Le traduzioni generate dall'AI potrebbero contenere errori.

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 mostra come eseguire le seguenti operazioni:

Configurare l'esportatore per Solr in modo che generi report sulle metriche.
Accedere a una dashboard predefinita in Cloud Monitoring per visualizzare le metriche.
Configurare le 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 di origine per l'esportatore JMX per informazioni sull'installazione.

Queste istruzioni sono fornite a titolo di esempio e dovrebbero funzionare nella maggior parte degli ambienti Kubernetes. Se hai difficoltà a installare un'applicazione o un esportatore a causa di policy di sicurezza o organizzative restrittive, ti consigliamo di consultare la documentazione open source per ricevere assistenza.

Per informazioni su Apache 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.28.15-gke.2475000 o successive.
Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta la guida introduttiva alla 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 maggiori informazioni sulle dashboard disponibili, vedi Visualizza 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.

Installare l'esportatore Solr

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

Per installare jmx-exporter come sidecar 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 configurazione tutte le righe precedute dal simbolo +.

Per applicare le modifiche alla configurazione da un file locale, esegui il comando seguente:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definire una risorsa PodMonitoring

Per l'individuazione dei target, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda all'esportatore JMX nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione 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'esportatore Solr.

Per applicare le modifiche alla configurazione da un file locale, esegui il comando seguente:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definire 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 le modifiche alla configurazione da un file locale, esegui il comando seguente:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per maggiori informazioni sull'applicazione delle regole al cluster, vedi Valutazione e avvisi delle regole gestite.

Puoi modificare le soglie di avviso in base alla tua applicazione.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'esportatore JMX. Cloud Monitoring potrebbe richiedere uno o due minuti per importare le metriche.

Per verificare che le metriche siano state importate:

Nella Google Cloud console, vai alla Esplora metriche pagina:
Vai a Esplora metriche

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è PromQL.

Inserisci ed esegui la seguente query:

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

Visualizzare le dashboard

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

Per visualizzare una dashboard installata:

Nella Google Cloud console, vai alla pagina Dashboard:
Vai a Dashboard

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Seleziona la scheda Elenco dashboard.
Scegli la categoria Integrazioni.
Fai clic sul nome della dashboard, ad esempio Solr Prometheus Overview.

Per visualizzare un'anteprima statica della dashboard:

Nella Google Cloud console, vai alla pagina Integrazioni:
Vai a Integrazioni

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Fai clic sul filtro della piattaforma di deployment Google Kubernetes Engine.
Individua l'integrazione di Apache Solr e fai clic su Visualizza dettagli.
Seleziona la scheda Dashboard.

Risoluzione dei problemi

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

Apache Solr Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Prerequisiti

Installare l'esportatore Solr

Definire una risorsa PodMonitoring

Definire regole e avvisi

Verificare la configurazione

Visualizzare le dashboard

Risoluzione dei problemi

Apache Solr