Bästa praxis för indexering i AEM

Förstå sökkraven och kontrollera om OTB-indexen stöder sökkraven. Använd frågeprestandaverktyget som finns på lokal SDK och AEMCS via Developer Console eller https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell.

Definiera en optimal fråga genom att använda flödesdiagrammet optimera frågor och JCR-frågechebladet för referens.

Om OTB-indexen inte stöder sökkraven finns det två alternativ. Granska dock Tipsen för hur du skapar effektiva index

• Anpassa OOTB-indexet: Det bästa alternativet eftersom det är enkelt att underhålla och uppgradera.
• Helt anpassat index: Endast om alternativet ovan inte fungerar.

I AEMCS använder du namnkonventionen <OOTBIndexName>-<productVersion>-custom-<customVersion> när du anpassar OOTB-indexet. Till exempel cqPageLucene-custom-1 eller damAssetLucene-8-custom-1. Det gör att du kan sammanfoga den anpassade indexdefinitionen när OTB-indexet uppdateras. Mer information finns i Förändringar av index som inte finns i kartongen.

I AEM 6.X fungerar inte namngivningen __, men du behöver bara uppdatera OTB-indexet med nödvändiga egenskaper i noden indexRules.

Kopiera alltid den senaste OTB-indexdefinitionen från AEM-instansen med CRX DE Package Manager (https://experienceleague.adobe.com/crx/packmgr/?lang=sv), byt namn på den och lägg till anpassningar i XML-filen.

Lagra indexdefinitionen i AEM-projektet på ui.apps/src/main/content/jcr_root/_oak_index och distribuera den med Cloud Manager CI/CD-pipelines. Mer information finns i Distribuera anpassade indexdefinitioner.

Använd <prefix> när du skapar ett helt anpassat index.<customIndexName>-<version>-custom-<customVersion>-namnkonvention. Exempel: wknd.adventures-1-custom-1. Detta hjälper till att undvika namnkonflikter. Här är wknd prefixet och adventures är det anpassade indexnamnet. Denna konvention gäller för både AEM 6.X och AEMCS och bidrar till att förbereda för framtida övergång till AEMCS.

AEMCS stöder bara Lucene-index, så för att förbereda för framtida migrering till AEMCS bör du alltid använda Lucene-index. Mer information finns i Lucene-index jämfört med egenskapsindex.

Undvik att skapa ett anpassat index för samma nodtyp som OTB-indexet. Anpassa i stället OTB-indexet med nödvändiga egenskaper i noden indexRules. Skapa till exempel inte ett anpassat index för nodtypen dam:Asset utan anpassa indexet OTB damAssetLucene. Det har varit en vanlig grundorsak till prestandaproblem och funktionsproblem.

Undvik också att lägga till flera nodtyper, till exempel cq:Page och cq:Tag, under indexeringsregelnoden (indexRules). Skapa i stället separata index för varje nodtyp.

Som vi nämnt ovan ska du lagra indexdefinitionen i AEM-projektet på ui.apps/src/main/content/jcr_root/_oak_index och distribuera den med Cloud Manager CI/CD-pipelines. Mer information finns i Distribuera anpassade indexdefinitioner.

Riktlinjerna för indexdefinitioner är:

• Nodtypen (jcr:primaryType) ska vara oak:QueryIndexDefinition
• Indextypen (type) ska vara lucene
• Den asynkrona egenskapen (async) ska vara async,nrt
• Använd includedPaths och undvik egenskapen excludedPaths. Ange alltid värdet queryPaths till samma värde som värdet för includedPaths.
• Använd egenskapen evaluatePathRestrictions och ange den till true för att framtvinga sökvägsbegränsningen.
• Använd egenskapen tags för att tagga indexet och ange det här taggvärdet för att använda indexet när du frågar. Den allmänna frågesyntaxen är <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"]
...

Indexhanteraren är tillgänglig på http://host:port/libs/granite/operations/content/diagnosistools/indexManager.html för att hämta indexinformation som typ, senast uppdaterad, storlek.

Detaljerad loggning av Oak frågor och indexeringsrelaterade Java™-paket som org.apache.jackrabbit.oak.plugins.index, org.apache.jackrabbit.oak.query och com.day.cq.search via http://host:port/system/console/slinglog för felsökning.

JMX MBean av IndexStats-typen som är tillgänglig på http://host:port/system/console/jmx för att hämta indexinformation som status, förlopp eller statistik som rör asynkron indexering. Den tillhandahåller också FailingIndexStats, om det inte finns några resultat här, vilket betyder att inga index är skadade. AsyncIndexerService markerar alla index som inte kan uppdateras i 30 minuter (konfigurerbara) som skadade och avbryter indexeringen. Om en fråga inte ger förväntat resultat är det praktiskt att utvecklarna kontrollerar detta innan de fortsätter med omindexering eftersom omindexering är resurskrävande och tidskrävande.

JMX MBean av typen LuceneIndex som finns på http://host:port/system/console/jmx för Lucene-indexstatistik som storlek, antal dokument per indexdefinition.

JMX MBean av QueryStat-typen som finns på http://host:port/system/console/jmx för Oak Query Statistics, inklusive långsamma och populära frågor med detaljer som query, körningstid.