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

Oak-run unterstützt Indizierungen über die Befehlszeile, ohne dass diese über die JMX-Konsole von AEM ausgeführt werden müssen.

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-Indexbefehl unterstützt alle NodeStore- und BlobStore-Setups. Die folgenden Beispiele beziehen sich auf Setups mit FileDataStore und SegmentNodeStore.

Nutzungsszenario 1 - Prüfung der Indexkonsistenz usercase1indexconsistencycheck

Dies ist ein Anwendungsfall im Zusammenhang mit Indexbeschädigung. In einigen Fällen war es nicht möglich festzustellen, welche Indizes beschädigt sind. Daher bietet Adobe Tools, die Folgendes ermöglichen:

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 finden Sie einen Beispielbericht:

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 vom Support und vom Systemadministrator verwendet werden, um schnell zu ermitteln, welche Indizes beschädigt sind, und sie dann neu indizieren.

Anwendungsfall 2: Indexstatistiken usecase2indexstatistics

Für die Diagnose einiger Fälle rund um die Adobe der Abfrageleistung waren häufig eine vorhandene Indexdefinition und indexbezogene Statistiken aus der Kundeneinrichtung erforderlich. Bisher wurden diese Informationen über mehrere Ressourcen verteilt. Um die Fehlerbehebung zu vereinfachen, hat Adobe Tools erstellt, die Folgendes ermöglichen:

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 dieselben Details über die Web-Konsole bereitgestellt und wären Teil der ZIP-Datei für die Konfigurationsablage. Sie können unter folgendem Pfad darauf zugreifen:

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

Vorteile uc2benefits

Diese Tools ermöglichen die schnelle Erfassung aller erforderlichen Details im Zusammenhang mit Indizierungs- oder Abfrageproblemen und verkürzen die Zeit, die mit dem Extrahieren dieser Informationen verbracht wird.

Anwendungsfall 3: Neuindizierung usecase3reindexing

Je nach Szenario ist es in einigen Fällen notwendig, eine Neuindizierung durchzuführen. Zurzeit erfolgt die Neuindizierung, indem das Flag reindex im Indexdefinitionsknoten über CRXDE oder die Benutzeroberfläche des Index-Managers auf true gesetzt wird. Nachdem das Flag gesetzt wurde, erfolgt die Neuindizierung asynchron.

Einige Hinweise zur Neuindizierung:

Um diese Ziele zu erreichen, unterstützt das Oak-run-Index-Tool verschiedene Neuindizierungsmodi, die bei Bedarf verwendet werden können. Der oak-run-Indexbefehl 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

Das übliche Verfahren, bei dem das Flag reindex gesetzt wird.

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

In SegmentNodeStore-Installationen kann nur ein Prozess im Lese-/Schreibmodus auf Segmentdateien zugreifen. Daher erfordern einige Vorgänge der Oak-run-Indizierung zusätzliche manuelle Schritte.

Dies würde Folgendes umfassen:

In diesem Szenario müssen Sie den AEM-Server nicht stoppen oder eine neue Instanz bereitstellen. Da die Indizierung jedoch das Durchlaufen des gesamten Repositorys beinhaltet, würde sich die I/O-Belastung der Installation erhöhen und die Laufzeitleistung negativ beeinflussen.

Online-Neuindizierung - SegmentNodeStore - Die AEM Instanz ist beendet. onlinereindexsegmentnodestoreaeminstanceisdown

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

Sie können die Neuindizierung des Triggers mit dem folgenden Befehl durchführen:

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 die Erstellung von Checkpoints und der Import von Indizes automatisch erfolgen. Der Nachteil ist, dass AEM während des Prozesses ausfallen muss.

Out-Band-Neuindizierung - SegmentNodeStore outofbandreindexsegmentnodestore

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

In diesem Szenario wird davon ausgegangen, dass der Zugriff auf den Datenspeicher in einer anderen Instanz möglich ist. Dies ist 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

Zurzeit 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 das Flag reindex auf true gesetzt wird.

Dies funktioniert bei kleineren Installationen, bei denen die Neuindizierung nicht lange dauert. Bei sehr großen Repositorys erfolgt die Neuindizierung jedoch in einer deutlich größeren Zeit. Für solche Fälle können wir jetzt das Oak-Run-Index-Tool verwenden.

Oak-run unterstützt jetzt die Bereitstellung von Indexdefinitionen im JSON-Format und die Erstellung von Index im Out-of-Band-Modus, bei dem keine Änderungen an einer Live-Instanz vorgenommen werden.

Der Prozess, den Sie für diesen Anwendungsfall beachten müssen, ist: