Best Practices für die Indizierung in AEM

Verstehen Sie die Suchanforderungen und prüfen Sie, ob die vorkonfigurierten Indizes diese Suchanforderungen unterstützen können. Verwenden Sie das Abfrageleistungs-Werkzeug, das als lokales SDK und AEMCS über die Developer Console oder unter https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell verfügbar ist.

Definieren Sie eine optimale Abfrage und orientieren Sie sich dabei am Diagramm zum Optimieren von Abfragen sowie an der JCR-Abfrage-Schnellübersicht.

Wenn die vorkonfigurierten Indizes die Suchanforderungen nicht unterstützen können, haben Sie zwei Möglichkeiten. Überprüfen Sie jedoch die Tipps zum Erstellen effizienter Indizes

• Anpassen des vorkonfigurierten Index: Dies ist die bevorzugte Option, da Verwaltung und Aktualisierung einfach sind.
• Vollständig benutzerdefinierter Index: Verwenden Sie diese Möglichkeit nur, wenn die obige Option nicht funktioniert.

Wenn Sie in AEMCS den vorkonfigurierten Index anpassen, verwenden Sie die Namenskonvention <OOTBIndexName>-<productVersion>-custom-<customVersion>. Beispiel: cqPageLucene-custom-1 oder damAssetLucene-8-custom-1. Dies hilft dabei, die benutzerdefinierte Indexdefinition zusammenzuführen, wenn der vorkonfigurierte Index aktualisiert wird. Weitere Informationen finden Sie unter Änderungen an vordefinierten Indizes.

In AEM 6.x funktioniert die oben angegebene Benennung nicht. Aktualisieren Sie jedoch einfach den vorkonfigurierten Index mit den erforderlichen Eigenschaften im Knoten indexRules.

Kopieren Sie immer die neueste vordefinierte Indexdefinition aus der AEM-Instanz mit CRX DE Package Manager (https://experienceleague.adobe.com/crx/packmgr/?lang=de), benennen Sie sie um und passen Sie die XML-Datei an.

Speichern Sie die Indexdefinition im AEM-Projekt unter ui.apps/src/main/content/jcr_root/_oak_index und stellen Sie sie mithilfe von CI/CD-Pipelines in Cloud Manager bereit. Weitere Informationen finden Sie unter Bereitstellen benutzerdefinierter Indexdefinitionen.

Wenn Sie einen vollständig benutzerdefinierten Index erstellen, verwenden Sie die Namenskonvention <prefix>.<customIndexName>-<version>-custom-<customVersion>. Zum Beispiel: wknd.adventures-1-custom-1. Das hilft dabei, Namenskonflikte zu vermeiden. Hier ist wknd das Präfix und adventures ist der benutzerdefinierte Indexname. Diese Konvention gilt sowohl für AEM 6.X als auch für AEMCS und hilft bei der Vorbereitung auf die zukünftige Migration zu AEMCS.

AEMCS unterstützt nur Lucene-Indizes. Verwenden Sie daher zur Vorbereitung auf eine zukünftige Migration zu AEMCS immer Lucene-Indizes. Weitere Informationen finden Sie unter Lucene- oder Eigenschaftenindizes.

Vermeiden Sie es, einen benutzerdefinierten Index auf demselben Knotentyp wie den vorkonfigurieren Index zu erstellen. Passen Sie stattdessen den vorkonfigurierten Index mit den erforderlichen Eigenschaften im Knoten indexRules an. Erstellen Sie beispielsweise keinen benutzerdefinierten Index auf dem Knotentyp dam:Asset, sondern passen Sie den vorkonfigurierten Index damAssetLucene an. Dies ist eine häufige Ursache für Leistungs- und Funktionsprobleme.

Vermeiden Sie es beispielsweise auch, mehrere Knotentypen wie cq:Page und cq:Tag unter dem Knoten für Indizierungsregeln (indexRules) hinzuzufügen. Erstellen Sie stattdessen separate Indizes für jeden Knotentyp.

Wie im Abschnitt oben erwähnt, speichern Sie die Indexdefinition im AEM-Projekt unter ui.apps/src/main/content/jcr_root/_oak_index und stellen Sie sie mithilfe von CI/CD-Pipelines in Cloud Manager bereit. Weitere Informationen finden Sie unter Bereitstellen benutzerdefinierter Indexdefinitionen.

Es gelten folgende Richtlinien zur Indexdefinition:

• Der Knotentyp (jcr:primaryType) sollte oak:QueryIndexDefinition sein
• Der Indextyp (type) sollte lucene sein
• Die async-Eigenschaft (async) sollte async,nrt sein
• Verwenden Sie includedPaths und vermeiden Sie die Eigenschaft excludedPaths. Setzen Sie den Wert queryPaths immer auf den gleichen Wert wie includedPaths.
• Um die Pfadbeschränkung zu erzwingen, verwenden Sie die Eigenschaft evaluatePathRestrictions und setzen Sie sie auf true.
• Verwenden Sie die Eigenschaft tags, um den Index zu taggen, und geben Sie bei Abfragen den Wert dieses Tags an, um den Index zu verwenden. Die allgemeine Abfragesyntax lautet <query> option(index tag <tagName>).

/oak:index/wknd.adventures-1-custom-1
    - jcr:primaryType = "oak:QueryIndexDefinition"
    - type = "lucene"
    - compatVersion = 2
    - async = ["async", "nrt"]
    - includedPaths = ["/content/wknd"]
    - queryPaths = ["/content/wknd"]
    - evaluatePathRestrictions = true
    - tags = ["customAdvSearch"]
...

Der Index-Manager ist unter http://host:port/libs/granite/operations/content/diagnosistools/indexManager.html verfügbar und dient zum Abrufen von Indexinformationen wie Typ, letzte Aktualisierung und Größe.

Zur Fehlerbehebung steht eine detaillierte Protokollierung von Oak-Abfrage- und indizierungsbezogenen Java™-Paketen wie org.apache.jackrabbit.oak.plugins.index, org.apache.jackrabbit.oak.query und com.day.cq.search über http://host:port/system/console/slinglog zur Verfügung.

JMX MBean vom Typ IndexStats ist unter http://host:port/system/console/jmx verfügbar und dient dazu, Indexinformationen wie Status, Fortschritt oder Statistiken im Zusammenhang mit der asynchronen Indizierung abzurufen. Es bietet auch FailingIndexStats. Wenn hier keine Ergebnisse vorliegen, bedeutet das, dass keine Indizes beschädigt sind. „AsyncIndexerService“ markiert alle Indizes, die 30 Minuten lang (konfigurierbar) nicht aktualisiert werden, als beschädigt und stoppt ihre Indizierung. Wenn eine Abfrage nicht die erwarteten Ergebnisse liefert, sollten Entwickelnde dies überprüfen, bevor sie mit einer Neuindizierung fortfahren, da eine Neuindizierung rechenintensiv und zeitaufwendig ist.

JMX MBean vom Typ LuceneIndex ist unter http://host:port/system/console/jmx verfügbar und bietet Lucene-Indexstatistiken wie Größe und die Anzahl der Dokumente pro Indexdefinition.

JMX MBean vom Typ QueryStat ist unter http://host:port/system/console/jmx verfügbar und bietet Oak-Abfragestatistiken, einschließlich langsamer und beliebter Abfragen mit Details wie Abfrage- und Ausführungszeit.