Oak-run.jar - Exempel på indexering oak-run-jar-indexing-use-cases

Oak-körning stöder indexering av användningsfall på kommandoraden utan att dessa användningsfall behöver ordnas genom att JMX-konsolen AEM.

De största fördelarna med att använda indexkommandot oak-run.jar för att hantera Oak-index är:

I avsnitten nedan finns exempelkommandon. Oak-kommandot för att köra index stöder alla NodeStore- och BlobStore-inställningar. Exemplen nedan handlar om inställningar som har FileDataStore och SegmentNodeStore.

Användningsfall 1 - Kontroll av indexöverensstämmelse usercase1indexconsistencycheck

Det här är ett användningsexempel som rör skadade index. Ibland gick det inte att avgöra vilken av indexen som är skadad. Adobe har därför tillhandahållit verktyg som

Kontroll av skadade index kan utföras med åtgärden --index-consistency-check:

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

Detta genererar en rapport i indexing-result/index-consistency-check-report.txt. Nedan finns ett exempel på en rapport:

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

Fördelar uc1benefits

Den här verktygen kan nu användas av supporten och systemadministratören för att snabbt avgöra vilka index som är skadade och sedan indexera om dem.

Användningsfall 2 - Indexstatistik usecase2indexstatistics

För diagnostisering av vissa fall kring frågeprestanda behövde Adobe ofta en befintlig indexdefinition, indexrelaterad statistik från kundinställningarna. Hittills har denna information spridits över flera resurser. För att underlätta felsökningen har Adobe skapat verktyg som gör att:

Ovanstående åtgärder kan nu utföras med följande kommandon för åtgärdsindex:

Nedan visas ett exempel på hur kommandona fungerar i praktiken:

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

Rapporterna genereras i indexing-result/index-info.txt och indexing-result/index-definitions.json

Dessutom tillhandahålls samma information via webbkonsolen och skulle ingå i konfigurationsdumpens zip. De kan nås på följande plats:

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

Fördelar uc2benefits

Med det här verktyget kan du snabbt samla in all information som behövs för indexering eller frågeproblem och minska tiden för extrahering av informationen.

Användningsfall 3 - omindexering usecase3reindexing

Beroende på scenarierna kan omindexering behöva utföras. Omindexeringen görs för närvarande genom att flaggan reindex anges till true i indexdefinitionsnoden med hjälp av CRXDE eller med hjälp av användargränssnittet i Indexhanteraren. När flaggan har angetts utförs omindexering asynkront.

Några punkter att tänka på när det gäller omindexering:

För att uppnå dessa mål har indexverktygen för ekningskörning stöd för olika sätt för omindexering som kan användas efter behov. Indexkommandot för ekning ger följande fördelar:

Indexera om - DocumentNodeStore reindexdocumentnodestore

För DocumentNodeStore-installationer kan omindexering göras med ett enda ekupkommando:

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

Detta ger följande fördelar

Indexera om - SegmentNodeStore reindexsegmentnodestore

För SegmentNodeStore-installationer kan omindexering göras på något av följande sätt:

Online Reindex - SegmentNodeStore onlinereindexsegmentnodestore

Följ det etablerade sättet där omindexering sker genom att ange flaggan reindex.

Online Reindex - SegmentNodeStore - AEM körs onlinereindexsegmentnodestoretheaeminstanceisrunning

För SegmentNodeStore-installationer kan bara en process få åtkomst till segmentfiler i läs- och skrivläge. På grund av detta kräver vissa åtgärder vid körning av ekning att ytterligare manuella åtgärder vidtas.

Detta skulle innebära följande:

I det här fallet behöver du inte stoppa AEM eller etablera någon ny instans. När indexering innebär att hela databasen genomgås, ökar dock I/O-belastningen på installationen, vilket påverkar körningens prestanda negativt.

Online Reindex - SegmentNodeStore - Den AEM instansen är avstängd onlinereindexsegmentnodestoreaeminstanceisdown

För SegmentNodeStore-installationer kan omindexering göras med ett enda ekupkommando. AEM måste dock stängas av.

Du kan aktivera omindexering med följande kommando:

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

Skillnaden mellan det här sättet och det som förklaras ovan är att skapande av kontrollpunkter och indeximport sker automatiskt. Nackdelen är att AEM måste vara nere under processen.

Out of Band Reindex - SegmentNodeStore outofbandreindexsegmentnodestore

I det här fallet kan du indexera om en klonad installation för att minimera påverkan på den AEM som körs:

I det här fallet antas det att datalagret är tillgängligt på en annan instans, vilket kanske inte är möjligt om FileDataStore placeras i en molnbaserad lagringslösning som EBS. Detta utesluter scenariot där FileDataStore också klonas. Om indexdefinitionen inte utför fulltextindexering krävs ingen åtkomst till DataStore.

Användningsfall 4 - Uppdaterar indexdefinitioner usecase4updatingindexdefinitions

För närvarande kan du skicka ändringar av indexdefinitioner med hjälp av paketet Kontrollera index för ACS. Detta gör det möjligt att leverera indexdefinitioner via innehållspaket som senare kräver omindexering genom att ange flaggan reindex till true.

Detta fungerar bra för mindre installationer där omindexering inte tar lång tid. För stora databaser sker dock omindexering på betydligt längre tid. I sådana fall kan vi nu använda indexverktygen för ekakning.

Oak-run har nu stöd för att tillhandahålla indexdefinitioner i JSON-format och att skapa index i out-of-band-läge där inga ändringar görs i en live-instans.

Processen som ska beaktas för detta användningsfall är: