Apache Solr

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

Folgen Sie der Anleitung zum Konfigurieren des Betriebs Kundenservicemitarbeiter, fügen Sie die erforderlichen Elemente hinzu um Telemetriedaten von Solr-Instanzen zu erfassen. Starten Sie den Agent neu.

Konfigurationsbeispiel

Mit den folgenden Befehlen wird die Konfiguration zum Erfassen und Aufnehmen von Telemetriedaten für Solr erstellt und der Ops-Agent neu gestartet.

# 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 einen Empfänger für die von Solr erzeugten Logs erstellen und dann eine Pipeline für den 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 Dieser Wert muss solr_system sein.
wildcard_refresh_interval 60s Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, 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 einen Empfänger für die von Solr erzeugten Messwerte erstellen und dann eine Pipeline für den neuen Empfänger erstellen.

Dieser Empfänger unterstützt die Verwendung mehrerer Instanzen in der Konfiguration, z. B. zum Überwachen mehrerer Endpunkte, nicht. Alle diese Instanzen schreiben in dieselbe Zeitachse und Cloud Monitoring kann sie nicht unterscheiden.

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
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

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.

So prüfen Sie, ob Solr-Logs an Cloud Logging gesendet werden:

  1. Rufen Sie in der Google Cloud Console die Seite Log-Explorer auf.

    Zum Log-Explorer

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen: 
    resource.type="gce_instance"
log_id("solr_system")

So prüfen Sie, ob Solr-Messwerte an Cloud Monitoring gesendet werden:

  1. Rufen Sie in der Google Cloud Console die Seite Metrics Explorer auf.

    Zum Metrics Explorer

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche  MQL oder  PromQL.
  3. Prüfen Sie, ob MQL im Schalter Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.
  4. Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen: 
    fetch gce_instance
| metric 'workload.googleapis.com/solr.cache.size'
| every 1m

Dashboard aufrufen

Damit Sie Ihre Solr-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Die Solr-Integration umfasst ein oder mehrere Dashboards. Alle Dashboards werden automatisch installiert, nachdem Sie die Integration konfiguriert haben und der Ops-Agent mit dem Erfassen von Messwertdaten begonnen hat.

Sie können auch eine statische Vorschau von Dashboards aufrufen, ohne die Integration zu installieren.

So rufen Sie ein installiertes Dashboard auf:

  1. Rufen Sie in der Google Cloud Console die Seite Dashboards auf.

    Dashboards aufrufen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Wählen Sie den Tab Dashboard-Liste und dann die Kategorie Integrationen aus.
  3. Wählen Sie den Namen des Dashboards aus, das Sie aufrufen möchten.

Wenn Sie eine Integration konfiguriert haben, das Dashboard jedoch nicht installiert ist, prüfen Sie, ob der Ops-Agent ausgeführt wird. Wenn im Dashboard keine Messwertdaten für ein Diagramm vorhanden sind, schlägt die Installation des Dashboards fehl. Nachdem der Ops-Agent mit dem Erfassen von Messwerten begonnen hat, wird das Dashboard für Sie installiert.

So rufen Sie eine statische Vorschau des Dashboards auf:

  1. Öffnen Sie in der Google Cloud Console die Seite Einbindungen:

    Zu „Integrationen“

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Klicken Sie auf den Filter für die Deployment-Plattform Compute Engine.
  3. Suchen Sie den Eintrag für Solr und klicken Sie auf Details ansehen.
  4. Wählen Sie den Tab Dashboards aus, um eine statische Vorschau aufzurufen. Wenn das Dashboard installiert ist, können Sie es aufrufen. Klicken Sie dazu auf Dashboard aufrufen.

Weitere Informationen zu Dashboards in Cloud Monitoring finden Sie unter Dashboards und Diagramme.

Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.

Benachrichtigungsrichtlinien installieren

Durch Benachrichtigungsrichtlinien wird Cloud Monitoring angewiesen, Sie zu benachrichtigen, wenn bestimmte Bedingungen auftreten. Die Solr-Integration umfasst eine oder mehrere Benachrichtigungsrichtlinien, die Sie verwenden können. Sie können diese Benachrichtigungsrichtlinien auf der Seite Integrationen in Monitoring aufrufen und installieren.

So zeigen Sie die Beschreibungen der verfügbaren Benachrichtigungsrichtlinien an und installieren sie:

  1. Öffnen Sie in der Google Cloud Console die Seite Einbindungen:

    Zu „Integrationen“

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Suchen Sie den Eintrag für Solr und klicken Sie auf Details ansehen.
  3. Wählen Sie den Tab Benachrichtigungen aus. Dieser Tab enthält Beschreibungen der verfügbaren Benachrichtigungsrichtlinien und eine Oberfläche für deren Installation.
  4. Installieren Sie Benachrichtigungsrichtlinien. Benachrichtigungsrichtlinien müssen wissen, wohin Benachrichtigungen gesendet werden sollen, dass die Benachrichtigung ausgelöst wurde. Daher benötigen sie Informationen von Ihnen für die Installation. So installieren Sie Benachrichtigungsrichtlinien:
    1. Wählen Sie aus der Liste der verfügbaren Benachrichtigungsrichtlinien die Richtlinien aus, die Sie installieren möchten.

    2. Wählen Sie im Abschnitt Benachrichtigungen konfigurieren einen oder mehrere Benachrichtigungskanäle aus. Sie haben die Möglichkeit, die Verwendung von Benachrichtigungskanälen zu deaktivieren. In diesem Fall werden Ihre Benachrichtigungsrichtlinien jedoch automatisch ausgelöst. Sie können ihren Status in Monitoring prüfen, aber Sie erhalten keine Benachrichtigungen.

      Weitere Informationen zu Benachrichtigungskanälen finden Sie unter Benachrichtigungskanäle verwalten.

    3. Klicken Sie auf Richtlinien erstellen.

Weitere Informationen zu Benachrichtigungsrichtlinien in Cloud Monitoring finden Sie unter Einführung in Benachrichtigungen.

Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.

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.