Apache Solr

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Die Apache Solr-Integration erfasst Kern- und Cache-Messwerte. Die wichtigsten Messwerte konzentrieren sich auf Anfragen, Dokumentanzahl und Indexgröße. Cache-Messwerte konzentrieren sich auf die Cache-Auslastung. Die Integration erfasst auch Solr-Logs und parst sie in eine JSON-Nutzlast. Das Ergebnis enthält Felder für Shard, Replikat, Kern, Ebene und Nachricht.

Weitere Informationen zu Solr finden Sie in der Apache Solr-Dokumentation.

Vorbereitung

Zum Erfassen von Solr-Telemetriedaten müssen Sie den Ops-Agent installieren:

  • Installieren Sie für Messwerte die Version 2.10.0 oder höher.
  • Installieren Sie für Logs die Version 2.10.0 oder höher.

Diese Integration unterstützt die Solr-Versionen 8.x und 7.7.

Solr-Instanz konfigurieren

Wenn Sie einen JMX-Endpunkt verfügbar machen möchten, müssen Sie beim Starten der JVM das Systemattribut com.sun.management.jmxremote.port festlegen. Außerdem empfehlen wir, das Systemattribut com.sun.management.jmxremote.rmi.port auf denselben Port festzulegen. Wenn Sie einen JMX-Endpunkt remote verfügbar machen möchten, müssen Sie auch das Systemattribut java.rmi.server.hostname festlegen.

Standardmäßig werden diese Attribute in der Datei solr-env.sh einer Solr-Bereitstellung festgelegt.

Wenn Sie Systemattribute mithilfe von Befehlszeilenargumenten festlegen möchten, stellen Sie beim Starten der JVM dem Attributnamen -D voran. Wenn Sie beispielsweise com.sun.management.jmxremote.port auf den Port 18983 festlegen möchten, geben Sie beim Starten der JVM Folgendes an:

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

Ops-Agent für Solr konfigurieren

Fügen Sie die erforderlichen Elemente zum Erfassen von Telemetriedaten aus den Solr-Instanzen gemäß der Anleitung unter Ops-Agent konfigurieren hinzu und starten Sie den Agent neu.

Konfigurationsbeispiel

Die folgenden Befehle erstellen die Konfiguration zum Erfassen und Aufnehmen von Telemetriedaten für Solr und starten den Ops-Agent neu.

# 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:
    solr:
      type: solr
  service:
    pipelines:
      solr:
        receivers:
          - solr

logging:
  receivers:
    solr_system:
      type: solr_system
  service:
    pipelines:
      solr:
        receivers:
          - solr_system
EOF

sudo service google-cloud-ops-agent restart

Logerfassung konfigurieren

Um Logs von Solr aufzunehmen, müssen Sie Empfänger für die von Solr erzeugten Logs erstellen und dann eine Pipeline für die neuen Empfänger erstellen.

Geben Sie die folgenden Felder an, um einen Empfänger für Ihre solr_system-Logs zu konfigurieren:

Feld Standard Beschreibung
exclude_paths Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen.
include_paths [/var/solr/logs/solr.log] Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden.
record_log_file_path false Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde.
type Der Wert muss solr_system betragen.
wildcard_refresh_interval 60s Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, die durch time.ParseDuration analysiert werden kann, z. B. 30s oder 2m. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden.

Was wird protokolliert?

Der logName wird von den Empfänger-IDs abgeleitet, die in der Konfiguration angegeben sind. Detaillierte Felder in LogEntry sind:

solr_system-Logs enthalten die folgenden Felder in LogEntry:

Feld Typ Beschreibung
jsonPayload.collection String Solr-Sammlung in Verbindung mit dem Log
jsonPayload.core String Solr-Kern in Verbindung mit dem Log
jsonPayload.exception String Ausnahme im Zusammenhang mit dem Log, einschließlich eines detaillierten Stacktrace, sofern angegeben
jsonPayload.level String Logeintragsebene
jsonPayload.message String Log-Nachricht
jsonPayload.replica String Solr-Replikat in Verbindung mit dem Log
jsonPayload.shard String Solr-Shard in Verbindung mit dem Log
jsonPayload.source String Quelle, aus der das Log stammt
jsonPayload.thread String Thread, von dem das Log stammt
severity String (LogSeverity) Ebene des Logeintrags (übersetzt).

Messwerterfassung konfigurieren

Um Messwerte von Solr aufzunehmen, müssen Sie Empfänger für die von Solr erzeugten Messwerte erstellen und dann eine Pipeline für die neuen Empfänger erstellen.

Um einen Empfänger für Ihre solr-Messwerte zu konfigurieren, geben Sie die folgenden Felder an:

Feld Standard Beschreibung
collection_interval 60s Ein Wert für die Zeitdauer, z. B. 30s oder 5m.
endpoint localhost:18983 Die JMX-Dienst-URL oder der Host und Port, die zum Erstellen der Dienst-URL verwendet werden. Muss das Format host:port haben. Werte im Format host:port werden verwendet, um die Dienst-URL service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi zu erstellen.
password Das konfigurierte Passwort, wenn JMX für eine erforderliche Authentifizierung konfiguriert ist.
type Dieser Wert muss solr sein.
username Der konfigurierte Nutzername, wenn JMX für eine erforderliche Authentifizierung konfiguriert ist.

Was wird überwacht?

Die folgende Tabelle enthält die Liste der Messwerte, die der Ops-Agent aus der Solr-Instanz erfasst.

Messwerttyp
Art, Typ
Überwachte Ressourcen
Labels
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
CUMULATIVEINT64
gce_instance
cache
core
workload.googleapis.com/solr.cache.lookup.count
CUMULATIVEINT64
gce_instance
cache
core
workload.googleapis.com/solr.cache.size
GAUGE, INT64
gce_instance
cache
core
workload.googleapis.com/solr.document.count
GAUGEINT64
gce_instance
core
workload.googleapis.com/solr.index.size
GAUGEINT64
gce_instance
core
workload.googleapis.com/solr.request.count
CUMULATIVE, INT64
gce_instance
core
handler
type
workload.googleapis.com/solr.request.error.count
CUMULATIVEINT64
gce_instance
core
handler
type
workload.googleapis.com/solr.request.time.average
GAUGEDOUBLE
gce_instance
core
handler
type
workload.googleapis.com/solr.request.timeout.count
CUMULATIVEINT64
gce_instance
core
handler
type

Beispieldashboard

Damit Sie Ihre Solr-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Cloud Monitoring bietet eine Bibliothek mit Beispiel-Dashboards für Integrationen, die vorkonfigurierte Diagramme enthalten. Informationen zum Installieren dieser Dashboards finden Sie unter Beispiel-Dashboards installieren.

Konfiguration prüfen

In diesem Abschnitt wird beschrieben, wie Sie prüfen können, ob Sie den Solr-Empfänger richtig konfiguriert haben. Es kann ein oder zwei Minuten dauern, bis der Ops-Agent Telemetriedaten erfasst.

Um zu prüfen, ob die Logs aufgenommen wurden, rufen Sie den Log-Explorer auf. Führen Sie dann die folgende Abfrage aus, um die Solr-Logs aufzurufen:

resource.type="gce_instance"
log_id("solr_system")

Um zu prüfen, ob die Messwerte aufgenommen wurden, rufen Sie den Metrics Explorer auf und führen Sie die folgende Abfrage auf dem Tab MQL aus:

fetch gce_instance
| metric 'workload.googleapis.com/solr.cache.size'
| every 1m

Nächste Schritte

Eine Anleitung zur Installation von Ops-Agent mit Ansible zum Konfigurieren einer Drittanbieteranwendung und zum Installieren eines Beispieldashboards finden Sie im Video Ops-Agent installieren, um Fehler in Drittanbieteranwendungen zu beheben.

ß