Oak-run.jar – Indizierungsanwendungsfälle oak-run-jar-indexing-use-cases

Oak-run unterstützt Indizierungs-Anwendungsfälle über die Befehlszeile, ohne dass die Ausführung dieser Anwendungsfälle über die JMX-Konsole von AEM orchestriert werden muss.

Die übergreifenden Vorteile bei der Verwendung des oak-run.jar-Befehls „index“ für die Verwaltung von Oak-Indizes:

In den folgenden Abschnitten finden Sie Beispielbefehle. Der Oak-run-Befehl „index“ unterstützt alle NodeStore- und BlobStore-Setups. Die folgenden Beispiele beziehen sich auf Setups mit FileDataStore und SegmentNodeStore.

Anwendungsfall 1 – Prüfung der Indexkonsistenz usercase1indexconsistencycheck

Dies ist ein Anwendungsfall, in dem der Index beschädigt wurde. In einigen Fällen ist es nicht möglich, festzustellen, welcher Index beschädigt wurde. Hierzu stellt Adobe Tools für folgende Aufgaben bereit:

Eine Suche nach beschädigten Indizes kann mit dem Vorgang --index-consistency-check durchgeführt werden:

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-consistency-check

Dieser generiert einen Bericht in der Datei indexing-result/index-consistency-check-report.txt Unten sehen Sie ein Beispiel für diesen Bericht:

Valid indexes :
        - /content/oak:index/enablementResourceName
        - /oak:index/cqProjectLucene
        - /oak:index/cqTagLucene
        - /oak:index/lucene
        - /oak:index/ntBaseLucene
        - /oak:index/socialLucene
    Invalid indexes :
        - /oak:index/atDamIndex
        - /oak:index/atIndex
        - /oak:index/cqPageLucene
        - /oak:index/damAssetLucene
        - /oak:index/groups
        - /oak:index/slingeventJob
        - /oak:index/users
        - /oak:index/workflowDataLucene
    Ignored indexes as these are not of type lucene:
        - /oak:index/acPrincipalName
        - /oak:index/active

Vorteile uc1benefits

Diese Tools können jetzt durch den Support und die Systemadmins verwendet werden, um schnell zu ermitteln, welche Indizes beschädigt sind, um diese dann neu zu indizieren.

Anwendungsfall 2 – Indexstatistiken usecase2indexstatistics

Für die Diagnose von Problemen mit der Performance von Abfragen benötigt Adobe häufig die vorhandene Indexdefinition sowie die zu Indizes gehörenden Statistiken aus dem Kunden-Setup. Bisher waren diese Informationen über mehrere Ressourcen verstreut. Um die Fehlerbehebung zu erleichtern, bietet Adobe Tools, die folgende Aufgaben durchführen können:

Die obigen Vorgänge können jetzt mit den folgenden Indexbefehlen ausgeführt werden:

Unten sehen Sie ein Beispiel dafür, wie der Befehl in der Praxis arbeitet:

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-info --index-definitions --index-dump

Die Berichte werden in indexing-result/index-info.txt und indexing-result/index-definitions.json erstellt.

Außerdem werden einige Informationen über die Web-Konsole bereitgestellt, die Teil der Konfiguration der vom Dump erzeugten ZIP-Datei sind. Der Zugriff ist über folgende URL möglich:

https://serverhost:serverport/system/console/status-oak-index-defn

Vorteile uc2benefits

Dieses Tool aktiviert die schnelle Sammlung aller erforderlichen Details, die mit Index- oder Abfrageproblemen zusammenhängen, und verkürzt die für das Extrahieren dieser Informationen benötigte Zeit.

Anwendungsfall 3 – Neuindizierung usecase3reindexing

Je nach Szenario muss manchmal eine Neuindizierung durchgeführt werden. Derzeit erfolgt die Neuindizierung, indem die Markierung reindex im Indexdefinitionsknoten über CRXDE oder über die Benutzeroberfläche des Index-Managers auf true gesetzt wird. Nach dem Setzen der Markierung wird die Neuindizierung asynchron ausgeführt.

Einige wichtige Aspekte der Neuindizierung:

Um diese Ziele zu erreichen, unterstützt das Oak-run-Tool verschiedene Indizierungsmodi, die nach Bedarf verwendet werden können. Der Oak-run-Befehl „index“ bietet folgende Vorteile:

Neuindizierung – DocumentNodeStore reindexdocumentnodestore

Für DocumentNodeStore-Installationen kann die Neuindizierung über einen einzelnen Oak-run-Befehl ausgeführt werden:

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore mongodb://server:port/aem

Dies bietet die folgenden Vorteile.

Neuindizierung – SegmentNodeStore reindexsegmentnodestore

Für SegmentNodeStore-Installationen kann die Neuindizierung auf eine der folgenden Weisen durchgeführt werden:

Online-Neuindizierung – SegmentNodeStore onlinereindexsegmentnodestore

Folgen Sie dem üblichen Verfahren, bei dem die Neuindizierung durch Festlegen der Markierung reindex erfolgt.

Online-Neuindizierung – SegmentNodeStore – Die AEM-Instanz wird ausgeführt onlinereindexsegmentnodestoretheaeminstanceisrunning

In SegmentNodeStore-Installationen kann nur ein Prozess im Lese-/Schreibmodus auf Segmentdateien zugreifen. Aus diesem Grund sind für einige Vorgänge der Oak-run-Indizierung weitere manuelle Schritte erforderlich.

Hierzu gehören:

In diesem Szenario müssen Sie den AEM-Server nicht stoppen und keine neue Instanz bereitstellen. Da für die Indizierung jedoch das gesamte Repository durchlaufen werden muss, erhöht sich die E/A-Last der Installation, was sich negativ auf die Performance auswirkt.

Online-Neuindizierung – SegmentNodeStore – Die AEM-Instanz ist heruntergefahren onlinereindexsegmentnodestoreaeminstanceisdown

Für SegmentNodeStore-Installationen kann die Neuindizierung über einen einzigen Oak-run-Befehl ausgeführt werden. Die AEM-Instanz muss allerdings heruntergefahren werden.

Sie können die Neuindizierung mit dem folgenden Befehl auslösen:

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore  /path/to/segmentstore/

Der Unterschied zwischen diesem und dem oben erläuterten Ansatz besteht darin, dass das Erstellen des Checkpoints und das Importieren des Indexes automatisch erfolgen. Der Nachteil besteht darin, dass AEM während des Prozesses beendet sein muss.

Bandexterne Neuindizierung – SegmentNodeStore outofbandreindexsegmentnodestore

In diesem Anwendungsfall können Sie die Neuindizierung in einem geklonten Setup durchführen, um die Auswirkungen auf die laufende AEM-Instanz zu minimieren:

In diesem Anwendungsfall wird davon ausgegangen, dass der Zugriff auf den Datenspeicher in einer anderen Instanz möglich ist. Dies ist ggf. nicht möglich, wenn FileDataStore in einer Cloud-basierten Speicherlösung wie EBS platziert ist. Dies schließt das Szenario aus, in dem auch FileDataStore geklont wird. Wenn die Indexdefinition keine Volltextindizierung durchführt, ist kein Zugriff auf den DataStore erforderlich.

Anwendungsfall 4 – Aktualisieren der Indexdefinitionen usecase4updatingindexdefinitions

Derzeit können Sie Änderungen der Indexdefinitionen über das Paket ACS Ensure Index versenden. Dies ermöglicht den Versand der Indexdefinitionen über das Inhaltspaket, das später neu indiziert werden muss, indem die Markierung reindex auf true gesetzt wird.

Dies funktioniert gut für kleinere Installationen, bei denen die Neuindizierung nicht viel Zeit in Anspruch nimmt. Bei sehr großen Repositorys benötigt die Neuindizierung jedoch erheblich mehr Zeit. Für diese Fälle kann jetzt das Oak-run-Tool für die Indizierung genutzt werden.

Oak-run unterstützt jetzt die Bereitstellung von Indexdefinitionen im JSON-Format und das Erstellen des Indexes im bandexternen Modus, in dem keine Änderungen an einer Live-Instanz ausgeführt werden.

Für diesen Anwendungsfall kommt der folgende Prozess zum Tragen: