Verbinden und konfigurieren von Elasticsearch

TIP

Haben Sie genug von komplizierten Aufgaben rund um die Einrichtung, Konfiguration, Sicherung und Aktualisierung? Lassen Sie uns diese Dinge für Sie erledigen! 🚀

Der einfachste und oft auch kostengünstigste Weg, Zammad zu betreiben, ist unser Cloud-Dienst. Testen Sie es in einer kostenlosen Testinstanz!

Diese Anleitung zeigt Ihnen, wie Sie Zammad mit Elasticsearch 8 oder neuer verbinden können.

Elasticsearch mit Zammad verbinden

Festlegen der Elasticsearch URL

Legen Sie die Adresse des Elasticsearch-Servers fest; passen Sie diese an Ihr Szenario an.

zammad run rails r "Setting.set('es_url', 'https://localhost:9200')"

Elasticsearch-Benutzer und -Passwort setzen

zammad run rails r "Setting.set('es_user', 'elastic')"

Ersetzen Sie <password> durch das Passwort, das Ihnen bei der Installation von Elasticsearch ausgegeben wurde. Falls Sie ein neues Passwort erstellen müssen, führen Sie /usr/share/elasticsearch/bin/elasticsearch-reset-password -u elastic aus.

zammad run rails r "Setting.set('es_password', '<password>')"

Zertifikat zu Zammad hinzufügen

Add it via Rails Console

In case you are installing a new Zammad and didn't run through the getting started wizard already, add the certificate via console:

sudo cat /etc/elasticsearch/certs/http_ca.crt | zammad run rails r "SSLCertificate.create!(certificate: STDIN.read)"

Add it via UI

In case you already have a running and configured Zammad, you can add the certificate in Zammad's admin settings (Settings > Security > SSL Certificates) as an alternative. To show and copy the auto-generated certificate from Elasticsearch, run:

sudo cat /etc/elasticsearch/certs/http_ca.crt

To add it in Zammad, either upload the certificate file or paste the content in the dialog. Make sure to copy/paste the delimiters (e.g. -----BEGIN CERTIFICATE-----) too.

Den Suchindex aufbauen/neu erstellen

Ohne Vorgabe der zu verwendenden CPU-Kerne:

zammad run rake zammad:searchindex:rebuild

Mit Vorgabe der zu verwendenden CPU-Kerne (Beispiel 8):

zammad run rake zammad:searchindex:rebuild[8]

Optionale Einstellungen

Wir haben einige nützliche Einstellungen gesammelt, die Sie vielleicht auch anwenden möchten. Weitere Informationen finden Sie in der Elastic-Dokumentation.

Index Namespacing

Nützlich, wenn mehrere Dienste oder Zammad-Instanzen mit einem einzigen Elasticsearch-Server verbunden werden (um Namenskollisionen bei der Indizierung zu vermeiden).

zammad run rails r "Setting.set('es_index', Socket.gethostname.downcase + '_zammad')"

Regeln für die Indizierung von Dateianhängen

Zammad unterstützt die Suche in Dateianhängen, was bedeutet, dass Elasticsearch auch diese indizieren muss. Eine Einschränkung dieser Indizierung kann helfen, Systemressourcen zu schonen.

Dateien mit diesen Erweiterungen werden nicht indiziert:

zammad run rails r "Setting.set('es_attachment_ignore',\
[ '.png', '.jpg', '.jpeg', '.mpeg', '.mpg', '.mov', '.bin', '.exe', '.box', '.mbox' ] )"

Dateien, die diese Größe (in MB) überschreiten, werden nicht indiziert:

zammad run rails r "Setting.set('es_attachment_max_size_in_mb', 50)"

Asciifold

Standardmäßig ist die Asciifold-Funktion von Elasticsearch aktiviert. Dies kann nützlich sein, wenn Sie mit Text arbeiten, der Diakritika und/oder Umlaute enthält.

Falls Sie eine genauere Suche benötigen, können Sie diese über Rails-Konsole deaktivieren.

Fehlerbehebung

TIP

Fehlersuche erfolglos oder Problem nicht beschrieben?

Wenn Sie Ihr Problem nicht anhand der angegebenen Schritte zur Fehlerbehebung lösen können oder Ihr spezielles Problem hier nicht beschrieben ist, können Sie in der Community nachfragen.

Fehlende Daten in der Web-Benutzeroberfläche / Fehlende oder unvollständige Suchdaten

Ein häufig berichtetes Problem sind fehlende Daten in der Web-UI. Dabei kann es sich um Tickets, Artikel, Benutzer oder andere [von Elasticsearch indizierte] Daten handeln (/de/reference/es-indexed-attributes), die durch fehlende oder unvollständige Indizes verursacht werden können.

Wenn Sie dieses Problem haben und Elasticsearch gemäß unserer Installationsanleitung installiert haben, führen Sie bitte die folgenden Schritte aus, um sicherzustellen, dass Elasticsearch korrekt funktioniert.

Schritt 1: Überprüfen Sie, ob Elasticsearch läuft

sudo systemctl status elasticsearch

Die Ausgabe sollte in etwa wie folgt aussehen. Achten Sie darauf, dass dort Active: active (running) steht:

● elasticsearch.service - Elasticsearch
   Loaded: loaded (/lib/systemd/system/elasticsearch.service; enabled; vendor preset: enabled)
   Active: active (running) since Tue 2021-07-20 09:38:21 UTC; 1h 4min ago
   Docs: https://www.elastic.co
   Main PID: 1790 (java)

Andernfalls versuchen Sie, den Service neu zu starten und prüfen Sie dann erneut:

sudo systemctl restart elasticsearch

WARNING

Wenn dies fehlschlägt, ist Ihre Elasticsearch-Installation wahrscheinlich defekt. Versuchen Sie, Elasticsearch vollständig zu bereinigen und neu zu installieren, wie in unserer Installationsanleitung beschrieben.

Schritt 2: Prüfen Sie, ob Zammad auf Elasticsearch zugreifen und Indizes neu erstellen kann

Erzwingen, dass Zammad die Elasticsearch-Indizes löscht und neu aufbaut, optional mit einer definierten Anzahl von CPU-Kernen, die für die Neuindizierung verwendet werden sollen (Beispiel [8]):

zammad run rake zammad:searchindex:rebuild[8]

Dies sollte den Wiederaufbau der Indizes starten und den Fortschritt ausgeben:

Dropping indexes... done.
Deleting pipeline... done.
Creating indexes... done.
Creating pipeline... done.
Reloading data...
   - Chat::Session...
      done in 0 seconds.
   - Cti::Log...
      done in 0 seconds.

[...]

Je nach Systemleistung und Datenmenge kann dies eine Weile dauern. Bitte warten Sie bis diese Aufgabe vollständig abgeschlossen ist und Sie wieder in die Konsole sind.

Wenn dieser Vorgang fehlschlägt oder einen Fehler ausgibt, ist möglicherweise etwas anderes mit Ihrer Installation nicht in Ordnung. Vergewissern Sie sich, dass Sie die vollständige Einrichtung und Integration von Elasticsearch gemäß unserer Installationsanleitung durchgeführt haben.

TIP

Falls Sie mit den obigen Schritten keinen Erfolg haben, sollten Sie die Elasticsearch-Protokolldatei überprüfen: /var/log/elasticsearch/elasticsearch.log.

Nachdem Sie diese Schritte durchgeführt haben, sollten Sie sicherstellen, dass Ihre Elasticsearch-Installation läuft und die Indizes neu erstellt wurden.